Diff: Menus/OptionsMenu.h

Revision:

3:83e79d31930c

Parent:

0:72f372170a73

--- a/Menus/OptionsMenu.h	Fri May 10 10:51:19 2019 +0000
+++ b/Menus/OptionsMenu.h	Fri May 10 14:52:28 2019 +0000
@@ -5,6 +5,10 @@
 
 // Button class that can modify brightness
 
+/** BrightnessButton Class
+ * @brief Derived from Button. Can incremement or decremement the lcd brightness.
+ * @brief Can only do so in incremements of 5% and can be volatile due to inputs firing twice.
+ */
 class BrightnessButton : public Button {
     public:
     N5110* lcd;
@@ -27,7 +31,10 @@
 };
 
 // Button class that can modify contrast
-
+/** ContrastButton Class
+ * @brief Derived from Button. Can incremement or decremement the lcd contrast.
+ * @brief Can only do so in incremements of 5% and can be volatile due to inputs firing twice.
+ */
 class ContrastButton : public Button {
     public:
     N5110* lcd;
@@ -52,6 +59,9 @@
 // OptionsMenu lets the player modify the brightness and contrast
 // of the lcd screen. can only increment in 5% steps.
 
+/** OptionsMenu Class
+ * @brief Derived from Menu. Displays the options to change brightness and contrast.
+ */
 class OptionsMenu : public Menu {
     public:
     OptionsMenu(N5110* screenPtr) : Menu(screenPtr) {
@@ -72,6 +82,8 @@
       lcd->printString("Contrast:",10,3);
       lcd->printString(ssc.str().c_str(),30,4);
     }
+    /** Destructor
+    */
     ~OptionsMenu() {
         delete buttons[0];
         delete buttons[1];