Diff: Menu/Menu.h

Revision:

21:20478f086bc2

Parent:

20:a8cad4e044ea

Child:

24:c7df5aa476a9

--- a/Menu/Menu.h	Tue Apr 16 19:19:43 2019 +0000
+++ b/Menu/Menu.h	Sat Apr 20 14:46:50 2019 +0000
@@ -18,10 +18,26 @@
 
 class Menu {
  public:
+  // Constructor and Destructor.
+  /**
+  * @brief Constructor @details Non user specified.
+  */
   Menu();
+  /**
+  * @brief Destructor @details Non user specified.
+  */
   ~Menu();
   
+  // Mutators
+  /**
+  * @brief Initalises the Menu object.
+  */ 
   void init();
+  /**
+  * @brief Runs the menu via a state machine.
+  * @param &lcd @details The lcd object from the N5110 class
+  * @param &gamepad @details The gamepad object from Gamepad class
+  */
   void run(N5110 &lcd, Gamepad &gamepad);
   
  private:
@@ -31,8 +47,8 @@
   void display_controls(N5110 &lcd, Gamepad &gamepad);
   void output(N5110 &lcd, Gamepad &gamepad);
   void play_tone(Gamepad &gamepad);
-  void play_tune_a(Gamepad &gamepad);
-  void play_tune_b(Gamepad &gamepad);
+  void play_chord_a(Gamepad &gamepad);
+  void play_chord_b(Gamepad &gamepad);
   
   int _menu_input;
   EngineController _controller;
@@ -41,6 +57,6 @@
   int _output;
   bool _tone_flag;
   int _tone_counter;
-  int _tune_counter;
+  int _chord_counter;
 };
 #endif
\ No newline at end of file