Diff: MenuClasses/Tutorial/Tutorial.h

Revision:

91:ca8cff78f2fe

Parent:

90:741120c09784

--- a/MenuClasses/Tutorial/Tutorial.h	Wed May 08 21:01:20 2019 +0000
+++ b/MenuClasses/Tutorial/Tutorial.h	Wed May 08 21:29:06 2019 +0000
@@ -19,54 +19,80 @@
     /** Destructor */
     ~Tutorial();
     
-    /** Gets pointers of lcd and pad from int main() to be used privately in the entire class.
-    * @param 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 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.
+    /** 
+    * @brief Gets pointers of lcd and pad from int main() to be used privately in the entire class.
+    * @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 init(N5110 *lcd, Gamepad *pad);
     
-    /** Used to call all Tutorial functions and go forth and exit the tutorial functions.*/
+    /** 
+    * @brief Used to call all Tutorial functions and go forth and exit the tutorial functions.
+    */
     void Implement();
 
-    /** Checks BACK if button pressed in a loop, can be used to exit it and also remember if true/false and used for various conditions.
-    * @return True if the BACK pressed, else False.
+    /** 
+    * @brief Checks BACK if button pressed in a loop, can be used to exit it and also remember if true/false and used for various conditions.
+    * @returns _backPressed @details True if the BACK pressed, else False.
     */
     bool checkBackPressed();
     
-    /** Introduces how to use the gamepad to the user for this tutorial.*/
+    /** 
+    * @brief Introduces how to use the gamepad to the user for this tutorial.
+    */
     void gamePad();
     
-    /** Shows how to control parameters in settings.*/
+    /** 
+    * @brief Shows how to control parameters in settings.
+    */
     void settings();
     
-    /** Shows how to scroll through menu.*/
+    /** 
+    * @brief Shows how to scroll through menu.
+    */
     void controlsToNavigateInMenu();
     
-    /** Shows how to scroll through Game Mode and Game Speed Menus.*/
+    /** 
+    * @brief Shows how to scroll through Game Mode and Game Speed Menus.
+    */
     void controlsToNavigateGameModeSpeed();
     
-    /** Shows how to move the snake in the game.*/
+    /** 
+    * @brief Shows how to move the snake in the game.
+    */
     void controlsToPlayGame();
     
     /** Shows how to start/end the game and also go to the next/previous menu.*/
     void controlsForPreviousOrNext();
     
-    /** Takes us to tutorial of why to avoid the blocks.*/
+    /** 
+    * @brief Takes us to tutorial of why to avoid the blocks.
+    */
     void BlockTutorialA();
     
-    /** Explains to the user what the block does.*/
+    /** 
+    * @brief Explains to the user what the block does.
+    */
     void BlockTutorialB();
     
-    /** Conveys to the user that they can still slide away after colliding.*/
+    /** 
+    * @brief Conveys to the user that they can still slide away after colliding.
+    */
     void BlockTutorialC();
     
-    /** Displays to the user how to react to food in way of our game.*/
+    /** 
+    * @brief Displays to the user how to react to food in way of our game.
+    */
     void FoodTutorial();
     
-    /** Takes us to tutorial of what the barrier does in our game.*/
+    /** 
+    * @brief Takes us to tutorial of what the barrier does in our game.
+    */
     void BarrierTutorial();
     
-    /** Talks us through some general information about the game.*/
+    /** 
+    * @brief Talks us through some general information about the game.
+    */
     void GeneralInfo();