Diff: Menu/Menu.h

Revision:

21:32429d8e90ff

Parent:

19:913d123554ee

Child:

22:f1811602a817

--- a/Menu/Menu.h	Sat May 09 10:53:46 2020 +0000
+++ b/Menu/Menu.h	Tue May 12 15:12:59 2020 +0000
@@ -3,27 +3,51 @@
 #include "N5110.h"
 #include "Gamepad.h"
 #include "Objects.h"
+
+/**Menu class
+*@brief Makes menu and game screens 
+*@author Arturs Kozlovskis
+*@date April,2020
+*/
+
 class Menu
 {
 public:
     //functions
+    
+    /**Constructor
+    *@param LCD' object
+    *@param Gamepad's object
+    */
     Menu(N5110 &lcd,Gamepad &pad);
+    /**Make the inital screen
+    */
     void first_screen();
+    /**Make the menu screen*/
     void menu_screen();
+    /**Get game speed
+    *@return the current game speed
+    */
     string get_game_speed();
+    /**Meke the pause screen
+    *@return chosen option
+    */
     int pause_screen();
+    /**Make the game over screen
+    *@param the players score
+    *@return the chosen option
+    */
     int game_over_screen(int score);
-    //variables
-    char print_speed[6];
     
 private:
     //classes
     N5110 _lcd;
     Gamepad _pad;
     //variables
-    int _arrow_pos;
-    int _arrow_pos_settings;
-    string _game_speed;
+    int _arrow_pos;//holds the menu screen arrow position 
+    int _arrow_pos_settings; //holds the setting screen arrow position
+    string _game_speed; //holds the game speed
+    char print_speed[6]; // holds the game speed in char
 };
 
 #endif
\ No newline at end of file