Diff: StartMenu/StartMenu.h

Revision:

13:fd290d2fd917

Parent:

11:7a4abe731f9c

--- a/StartMenu/StartMenu.h	Tue May 26 18:16:31 2020 +0000
+++ b/StartMenu/StartMenu.h	Tue May 26 22:41:23 2020 +0000
@@ -6,24 +6,35 @@
 #include "Gamepad.h"
 #include "ImpossEngine.h"
 
-/** Ball Class
-@author Dr Craig A. Evans, University of Leeds
-@brief Controls the ball in the Pong game 
-@date Febraury 2017
+/** Start Menu Class
+@author Lewis Cheadle
+@brief Displays Start menu
+@date May 2020
 */ 
 class StartMenu
 {
 
 public:
+
+    /* Constructor **/
     StartMenu();
+    
+    /* Destructor **/
     ~StartMenu();
+    
+    /** Draws the start menu and allows user to select what to do
+        * @param lcd N5110 object
+     */
     void complete(Gamepad &pad,N5110 &lcd);
-    /// accessors and mutators
 
     
 private:
-
+    
+    /* Stores the value of the option that the user chooses  */
     int selector;
+    
+    /* Stores the sprite of the pointer so the user knows which option is
+    selected */
     int arrow;
     
 };