Diff: Scores/Scores.h

Revision:

21:44e87d88afe2

Parent:

18:165e3d49daa8

diff -r 3c58ae38d6bc -r 44e87d88afe2 Scores/Scores.h
--- a/Scores/Scores.h	Tue May 07 12:42:15 2019 +0000
+++ b/Scores/Scores.h	Thu May 09 13:10:16 2019 +0000
@@ -5,17 +5,44 @@
 #include "N5110.h"
 #include "Gamepad.h"
 
+/** Menus Class
+* @brief Calculates, ranks and displays the players' scores.
+* @author Maxim C. Delacoe
+* @date April 2019
+*/
 
 class Scores
 {
     
 public:
-    
+  // Constructor and destructor.
+  /**
+  * @brief Constructor 
+  * @details Sets the highscores to 0.
+  */     
   Scores();
+  /**
+  * @brief Destructor 
+  * @details Non user specified.
+  */
   ~Scores();
-    
+  // Member Methods
+  /**
+  * @brief Calculate's the winner's score based on number of turns played and initial health.
+  * @param turns @details The number of turns the game has elapsed
+  * @param health @details The initial health of the tanks
+  */  
   float score_calculator(int turns, int health); 
+  /**
+  * @brief Displays the winner's score on the screen.
+  * @param current @details The concluding score for the current game
+  * @param lcd @details The lcd object from N5110 class.
+  */ 
   void display_score(float current, N5110 &lcd);
+  /**
+  * @brief Displays the highest three score on the screen.
+  * @param lcd @details The lcd object from N5110 class.
+  */ 
   void display_top_scores(N5110 &lcd);
     
 private: