Diff: Menus/VictoryMenu.h

Revision:

3:83e79d31930c

Parent:

0:72f372170a73

--- a/Menus/VictoryMenu.h	Fri May 10 10:51:19 2019 +0000
+++ b/Menus/VictoryMenu.h	Fri May 10 14:52:28 2019 +0000
@@ -4,6 +4,10 @@
 #include "Menus.h"
 
 // yes button used in the VictoryMenu and the DefeatMenu
+/** YesButton Class
+ * @brief Derived from Button. Used in VictoryMenu and DefeatMenu.
+ * @brief Sends user to the StartMenu.
+ */
 class YesButton : public Button {
     public:
     YesButton() {
@@ -16,6 +20,10 @@
     }
 };
 // no button used in the VictoryMenu and the DefeatMenu
+/** NoButton Class
+ * @brief Derived from Button. Used in VictoryMenu and DefeatMenu.
+ * @brief Sends user to the MainMenu.
+ */
 class NoButton : public Button {
     public:
     NoButton() {
@@ -29,6 +37,10 @@
 };
 // VictoryMenu displays when the player escapes the maze, it displays score
 // and restart options
+/** VictoryMenu Class
+ * @brief Derived from Menu. Displayed when the maze is escaped.
+ * @brief Or more accurately when the winFlag = true.
+ */
 class VictoryMenu : public Menu {
     public:
     VictoryMenu(N5110* screenPtr) : Menu(screenPtr) {
@@ -46,6 +58,8 @@
       lcd->printString("Play again?",10,3);
       lcd->printString("Yes      No",10,4);
     }
+    /** Destructor
+    */
     ~VictoryMenu() {
         delete buttons[0];
         delete buttons[1];