Diff: SplashScreen/Splash.h

Revision:

25:467d8fd0fec4

Parent:

20:c697902b844f

diff -r c110f92fe266 -r 467d8fd0fec4 SplashScreen/Splash.h
--- a/SplashScreen/Splash.h	Mon May 25 13:19:11 2020 +0000
+++ b/SplashScreen/Splash.h	Mon May 25 18:25:00 2020 +0000
@@ -7,41 +7,47 @@
 #include "Ball.h"
 #include "Sprites.h"
 
+/** Splash class
+@brief Class for playing introductory animations and displaying student info.
+@version 1.0
+@author Kaif Kutchwala
+@date May 2020
+*/
 
 class Splash {
     private:
-    //objects
-    N5110 *_lcd;
-    Ball *_ball;
-    
+        //objects
+        N5110 *_lcd;
+        Ball *_ball;
+
     public:
         /** Constructor */
         Splash(N5110 &lcd, Ball &ball);
-        
+
         /** Destructor */
         ~Splash();
         
+        /** @brief displays student info on lcd */
         void displayInfo();
         
+        /** @brief plays game intro animation on lcd */
         void playIntro();
         
+        /** @brief draws game logo on lcd */
         void drawLogo(int x, int y);
-        
-        
+
     private:
+        // functions draws logo without middle 'O', needed for intro animation
         void draw_name();
         
         void player_enter_animation();
-        
+    
         void kick_animation();
-        
+    
         void shot_animation();
         
+        // animation where constrast starts from zero and increases slowly.
         void contrast_slide();
-    
-    };
-    
+};
 
-
-#endif   
-     
\ No newline at end of file
+#endif
\ No newline at end of file