Diff: Game1/Game1.h

Revision:

4:bf257e628311

Parent:

0:0aea7b9ba421

Child:

5:abe12cabd0b7

diff -r 47a29d0ddddf -r bf257e628311 Game1/Game1.h
--- a/Game1/Game1.h	Sun May 05 17:21:16 2019 +0000
+++ b/Game1/Game1.h	Sun May 05 17:31:17 2019 +0000
@@ -7,13 +7,34 @@
 #include "Wall.h"
 #include "Copter.h"
 
+/**  Game1 class
+
+*@brief Library to combine the copter and wall
+*/
+
 class Game1
 {
 public:
+
+    /**Constructor*/
     Game1();
+    /**Destructor*/
     ~Game1();
+    /**
+    *@brief Initialise all parameters of the Game1
+    */
     void init();
+    /**
+    *@brief Draw the bird, wall and live scores
+    *@param lcd, pad
+    *@returns The number to test whether the copter crash the wall
+    *@details Use the method to use function within N5110.h and Gamepad.h file
+    */
     int draw(N5110 &lcd, Gamepad &pad);
+    /**
+    *@brief Get the live score
+    *@return The live score
+    */
     int get_score();
 
 private: