Diff: Menus/Menu.h

Revision:

1:538386e72e40

Parent:

0:07c4fef6c0af

Child:

2:c7976a633ba0

--- a/Menus/Menu.h	Wed May 08 21:44:02 2019 +0000
+++ b/Menus/Menu.h	Wed May 08 22:10:38 2019 +0000
@@ -5,14 +5,38 @@
 #include "N5110.h"
 #include "Gamepad.h"
 
+/** Move Class
+@brief Class for main engine for the snake game
+@author Zhou Jiaxin
+@date 8th May 2019
+*/
+
 class Menu 
 {
 public:
-    
+    /** Constructor */
     Menu();
+    /** Destructor */
     ~Menu();
+    
+    /** 
+    * @brief initial all the parameter for the snake and food.
+    * @param select @details is used to switch the menu.
+    * @param Gamepad *pad @details pointer to the gamepad object in main, address of this pointer is saved to make availability to the entire class, without passing address to each function.
+    */
     int input(int select,Gamepad &pad);
+    /** 
+    * @brief initial all the parameter for the snake and food.
+    * @param N5110 *lcd @details pointer to the N5110 object in main, address of this pointer is saved to make availability to the entire class, without passing address to each function.
+    * @param Gamepad *pad @details pointer to the gamepad object in main, address of this pointer is saved to make availability to the entire class, without passing address to each function.
+    */
     void menus(N5110 &lcd,Gamepad &pad);
+    /** 
+    * @brief initial all the parameter for the snake and food.
+    * @param N5110 *lcd @details pointer to the N5110 object in main, address of this pointer is saved to make availability to the entire class, without passing address to each function.
+    * @param Gamepad *pad @details pointer to the gamepad object in main, address of this pointer is saved to make availability to the entire class, without passing address to each function.
+    * @returns fps @details is the frame per second, with higher fps means higher difficulty.
+    */
     int difficulty(N5110 &lcd,Gamepad &pad);