Diff: Menus/Menus.h

Revision:

21:44e87d88afe2

Parent:

17:cb39d9fa08dc

--- a/Menus/Menus.h	Tue May 07 12:42:15 2019 +0000
+++ b/Menus/Menus.h	Thu May 09 13:10:16 2019 +0000
@@ -7,18 +7,56 @@
 #include "Graphics.h"
 #include "Scores.h"
 
+/** Menus Class
+* @brief Generates and navigates the outside-of-game menus.
+* @author Maxim C. Delacoe
+* @date April 2019
+*/
+
 class Menus
 {
     
 public:
-    
+  // Constructor and destructor.
+  /**
+  * @brief Constructor 
+  * @details Sets the settings to default.
+  */     
   Menus();
+  /**
+  * @brief Destructor 
+  * @details Non user specified.
+  */
   ~Menus();
   
+  //Accessors
+  /**
+  * @brief Gets the player's preference for the mute setting.
+  * @returns mute on or off
+  */  
+  bool get_mute();
+  /**
+  * @brief Gets the player's preference for the tank's initial health.
+  * @returns tank's initial health
+  */  
+  int get_health();
+  
+  //Member Methods
+  /**
+  * @brief Shows the start up visuals and awaits player's input.
+  * @param &graphics * @details The graphics object from Graphics class.
+  * @param &lcd * @details The lcd object from N5110 class.
+  * @param &pad * @details The pad object from Gamepad class.
+  */  
   void start_up_screen(Graphics &graphics, N5110 &lcd, Gamepad &pad);
+  /**
+  * @brief Navigates the menu screens and awaits player's input.
+  * @param &graphics * @details The graphics object from Graphics class.
+  * @param &lcd * @details The lcd object from N5110 class.
+  * @param &pad * @details The pad object from Gamepad class.
+  * @param &scores * @details The scores object from Scores class.
+  */  
   void main_menu(Graphics &graphics, N5110 &lcd, Gamepad &pad, Scores &scores);
-  bool get_mute();
-  int get_health();
     
 private: