Diff: Menu/Menu.h

Revision:

43:11c5d098ce9d

Parent:

41:4b20f909bbcb

Child:

44:03059810630d

diff -r 0dad7c359fa5 -r 11c5d098ce9d Menu/Menu.h
--- a/Menu/Menu.h	Wed May 08 16:28:13 2019 +0000
+++ b/Menu/Menu.h	Wed May 08 22:00:17 2019 +0000
@@ -13,69 +13,57 @@
 class Menu
 {
 public:
-/**
-    *@brief Constructor
-    */
+    /** Constructor */
     Menu();
-    
-    /**
-    *@brief Deconstructor
-    */
+
+    /** Deconstructor */
     ~Menu();
-    
-    /** 
-    *@brief intialises 
-    */
+
+    /** intialises */
     void init();
-    
-    /**
-    *@brief runs the title sequence
-    *@param lcd @brief class which controlls lcd screen
-    *@param pad @breif class for working with the gamepad 
+
+    /** runs the title sequence
+    *@param N5110 class which controlls lcd screen
+    *@param Gamepad class for working with the gamepad
     */
     void title_intro(N5110 &lcd, Gamepad &pad);
-    
-    /**
-    *@brief holds title screen and flashes 'press start'
-    *@param lcd @brief class which controlls lcd screen
-    *@param pad @breif class for working with the gamepad 
-    *@returns _start (1 when pressed, else 0)
+
+    /**holds title screen and flashes 'press start'
+    *@param N5110 class which controlls lcd screen
+    *@param Gamepad class for working with the gamepad
+    *@returns _start (1 when pressed, else 0) (int)
     */
     int press_start(N5110 &lcd, Gamepad &pad);
 
-    /**
-    *@brief displays main menu screen and takes in input to select next state
-    *@param lcd @brief class which controlls lcd screen
-    *@param pad @breif class for working with the gamepad 
-    *@returns _input (1 when pressed, else 0)
+    /** displays main menu screen and takes in input to select next state
+    *@param Gamepad class for working with the gamepad
+    *@param N5110 class which controlls lcd screen
+    *@returns _input (1 when pressed, else 0) (int)
     */
     int select_input_main(Gamepad &pad, N5110 &lcd);
-    
-    /**
-    *@brief displays continue menu screen and takes in input to select next state
-    *@param lcd @brief class which controlls lcd screen
-    *@param pad @breif class for working with the gamepad 
-    *@returns _input (1 when pressed, else 0)
+
+    /** displays continue menu screen and takes in input to select next state
+    *@param Gamepad class for working with the gamepad
+    *@param N5110 class which controlls lcd screen
+    *@returns _input (1 when pressed, else 0) (int)
     */
     int select_input_continue(Gamepad &pad, N5110 &lcd);
-    
-    /**
-    *@brief displays highscore screen
-    *@param lcd @brief class which controlls lcd screen
-    *@param highscore @breif highest level reached by user
+
+    /** displays highscore screen
+    *@param N5110 class which controlls lcd screen
+    *@param highest level reached by user (int)
     */
     void print_highscore(N5110 &lcd, int highscore);
-    
-    /**
-    *@brief displays continue menu screen and takes in input to select next state
-    *@param lcd @brief class which controlls lcd screen
-    *@param pad @breif class for working with the gamepad 
-    *@returns contrast level
+
+    /** displays continue menu screen and takes in input to select next state
+    *@param Gamepad class for working with the gamepad
+    *@param N5110 class which controlls lcd screen
+    *@returns contrast level (float)
     */
     float print_settings(Gamepad &pad, N5110 &lcd);
 private:
 
-    void print_main_menu(N5110 &lcd);                               //prints menu class visuals        
+    void print_main_menu(N5110 &lcd);                               //prints menu class visuals
     void print_continue_menu(N5110 &lcd);                           //prints continue class visuals
 
     void menu_decoration(N5110 &lcd);                               //prints menu border decoration
@@ -84,7 +72,7 @@
     void intro_bl(N5110 &lcd, Gamepad &pad);                        //display bl with note
     void intro_blo(N5110 &lcd, Gamepad &pad);                       //display blo with note
     void intro_bloc(N5110 &lcd, Gamepad &pad);                      //display bloc with note
-    void intro_block(N5110 &lcd, Gamepad &pad);                     //display block  with note    
+    void intro_block(N5110 &lcd, Gamepad &pad);                     //display block  with note
     void intro_block_h(N5110 &lcd, Gamepad &pad);                   //display block h with note
     void intro_block_he(N5110 &lcd, Gamepad &pad);                  //display block he with note
     void intro_block_hea(N5110 &lcd, Gamepad &pad);                 //display block hea with note