Diff: Menus/MainMenu.h

Revision:

3:83e79d31930c

Parent:

0:72f372170a73

--- a/Menus/MainMenu.h	Fri May 10 10:51:19 2019 +0000
+++ b/Menus/MainMenu.h	Fri May 10 14:52:28 2019 +0000
@@ -5,6 +5,9 @@
 #include "OptionsMenu.h"
 #include "MenuGraphics.h"
 // StartButton takes you to the start menu screen.
+/** StartButton Class
+ * @brief Derived from Button. Takes you to the StartMenu screen where game params are set.
+ */
 class StartButton : public Button {
     public:
     N5110* lcd;
@@ -21,6 +24,9 @@
 };
 
 // OptionsButton takes you to the game's options.
+/** OptionsButton Class
+ * @brief Derived from Button. Takes you to the options menu.
+ */
 class OptionsButton : public Button {
     public:
     N5110* lcd;
@@ -38,6 +44,9 @@
 
 // The MainMenu is the first menu displayed.
 // It has only two buttons because I did not have time for a leaderboard
+/** MainMenu Class
+ * @brief Derived from Menu. MainMenu is the first menu displayed and serves as the start of the program loop.
+ */
 class MainMenu : public Menu {
     public:
     //Button* buttons[2];
@@ -53,6 +62,8 @@
       lcd->printString("Start",10,2);
       lcd->printString("Options",10,3);
     }
+    /** Destructor
+    */
     ~MainMenu() {
         delete buttons[0];
         delete buttons[1];