Diff: ModeB/ModeB.h

Revision:

18:59befe1eaa56

Parent:

0:15b74f0f8c7f

Child:

22:eadcb3d8fec0

diff -r 18795c097efc -r 59befe1eaa56 ModeB/ModeB.h
--- a/ModeB/ModeB.h	Thu May 09 02:37:27 2019 +0000
+++ b/ModeB/ModeB.h	Thu May 09 03:05:48 2019 +0000
@@ -6,18 +6,44 @@
 #include "N5110.h"
 #include "Gamepad.h"
 
-// function prototypes
-void mode_B();
+/** ModeB class
 
+@brief Class displaying instructions
+@author Maria Ungureanu
+@date May 2019
+
+*/
 
 class ModeB
 {
 
 public:
+    /** Constructor */
     ModeB();
+    /** Destructor */
     ~ModeB();
+    /**
+    * @brief Refreshes and draws instructions on lcd
+    @code
+    void ModeB::draw(N5110 &lcd)
+    {
+     lcd.printString("INSTRUCTIONS",3,0);
+    lcd.printString("Use Y, X ",0,1);
+    lcd.printString("for square",0,2);
+    lcd.printString("and bar",0,3);
+    lcd.printString("Back:GAME",0,5);
+    }
+    @endcode
+    */
     void draw(N5110 &lcd);
+    /**
+    * @brief Clears the screen
+    @code
+    {
+    lcd.clear();
+    };
+    @endcode
+    */
     void screen(N5110 &lcd);
-
 };
 #endif
\ No newline at end of file