Project Submission (late)
Dependencies: mbed
Diff: Menus/StartMenu.h
- Revision:
- 3:83e79d31930c
- Parent:
- 0:72f372170a73
--- a/Menus/StartMenu.h Fri May 10 10:51:19 2019 +0000 +++ b/Menus/StartMenu.h Fri May 10 14:52:28 2019 +0000 @@ -5,6 +5,11 @@ // button which changes the size of the maze +/** SizeButton Class + * @brief Derived from Button. Allows the user to pick the size of Maze they wish to solve. + * @brief Mazes can only be 12x12, 16x16 or 20x20. + * @brief If enabled, the timer increases in length for larger mazes. + */ class SizeButton : public Button { public: SizeButton() { @@ -24,6 +29,11 @@ }; // button which toggles the timer on or off +/** TimerButton Class + * @brief Derived from Button. Toggles the timer on or off. + * @brief If turned off, the timer will count up instead of down and there is no faliure state. + * @brief I.e. the program will only end when the maze is finished. + */ class TimerButton : public Button { public: TimerButton() { @@ -37,6 +47,9 @@ }; // button that triggers the main game loop +/** PlayButton Class + * @brief Derived from Buttons. Triggers the main game loop. + */ class PlayButton : public Button { public: PlayButton() { @@ -51,6 +64,9 @@ // the StartMenu is the menu for game setup and starting the game. +/** VictoryMenu Class + * @brief Derived from Menu. Used to change the game's parameters of maze size and timer on or off. + */ class StartMenu : public Menu { public: StartMenu(N5110* screenPtr) : Menu(screenPtr) { @@ -74,6 +90,8 @@ lcd->printString(someString.c_str(),10,3); lcd->printString("Play",10,5); } + /** Destructor + */ ~StartMenu() { delete buttons[0]; delete buttons[1];