Diff: Menu/menu.h

Revision:

11:0e6a221ad8a9

Parent:

8:b3738229ba85

Child:

12:bc9a43f56261

--- a/Menu/menu.h	Fri May 10 12:00:30 2019 +0000
+++ b/Menu/menu.h	Fri May 10 13:58:51 2019 +0000
@@ -3,32 +3,61 @@
 
 #include <string>
 #include "Gamepad.h"
+;
 
-// star struct needed for the falling number screen flush
-struct symbol
-{
-    //coords of a symbol and its distance
-    int x,y,distance; 
-};
-
+/** Map Class
+@author Dobri Tsvetkov, University of Leeds
+@brief C++ class define a map for the track
+@date May 2019
+*/
 class Menu {
     
-    // public part of the class definition
     public:
-    // intro for the welcome function
+    /**
+    @brief Into to display the logo 
+    @param N5110 &lcd, Gamepad &pad 
+    @details reads the static int array and calls the next part
+    */
     void intro(N5110 &lcd, Gamepad &pad);
     
-    // run a short story mode 
+    /**
+    @brief Call the subsequent acts 
+    @param N5110 &lcd, Gamepad &pad 
+    @details 
+    */
     void story(N5110 &lcd, Gamepad &pad);
+    /**
+    @brief display first part of the conversation 
+    @param N5110 &lcd, Gamepad &pad 
+    @details 
+    */
     void actI(N5110 &lcd, Gamepad &pad);
+    /**
+    @brief Display the second part of the conversation
+    @param N5110 &lcd, Gamepad &pad 
+    @details 
+    */
     void actII(N5110 &lcd, Gamepad &pad);
     
-    // start the main menu and display options
+    /**
+    @brief Call the option method
+    @param N5110 &lcd, Gamepad &pad 
+    @details 
+    */
     int startMainMenu(N5110 &lcd, Gamepad &pad);
     
-    // draw the different sectors of the menu 
+    /**
+    @brief Decide which choice has been chosen
+    @param N5110 &lcd, Gamepad &pad 
+    @details 
+    */
     void drawSelections(N5110 &lcd, Gamepad &pad);
     
+    /**
+    @brief Draw the controls option
+    @param N5110 &lcd, Gamepad &pad 
+    @details 
+    */
     void displayControls(N5110 &lcd, Gamepad &pad);
     
     // private part of the class definition