Diff: CopterEngine/CopterEngine.h

Revision:

19:64132af39f81

Parent:

17:b385e6ae8ef4

diff -r ded68db6ea55 -r 64132af39f81 CopterEngine/CopterEngine.h
--- a/CopterEngine/CopterEngine.h	Thu May 09 07:30:49 2019 +0000
+++ b/CopterEngine/CopterEngine.h	Thu May 09 09:36:57 2019 +0000
@@ -48,6 +48,7 @@
     void init(int Copter_width,int Copter_height,int wall_size,int speed);
 
     /** get the input of the user
+     * @param for user to input
      * @return input from the user
      */
     void read_input(Gamepad &pad);
@@ -55,22 +56,32 @@
 
     /** update the gamepad
      * @param update the gamepad when users start the game
+     * @return update the gamepad
      */
     void update(Gamepad &pad);
 
 
     /** draw all those things on the screen, which are walls and the copter
      * @param draw wall copter and so on defined in classes
+     * @return the wall copter 
      */
     void draw(N5110 &lcd);
 
     /** get the state of which the game is finished or not
+     * @param the end when the game is over
      * @return current state of the end when the game is over
      */
     int GameOver();
-
-
+    
+    /** int the game over
+     * @param the end when the game is over
+     * @return game over
+     */
     int gameover;
+   /** int the end of the game 
+     * @param the end when the game is over
+     * @return game over
+     */
     int z;
 
 private:
@@ -99,14 +110,27 @@
       */
     void print_scores(N5110 &lcd);
 
-
+    /** int the width of the copter
+         * @return the wicth of the copter
+         */
     int _Copter_width;
+    /** int the height of the copter
+         * @return the height of the copter
+         */
     int _Copter_height;
+    /** int the speed of the copter
+         * @return the speed of the copter
+         */
     int _speed;
 
-    // x positions of the Copter
+    /** int the position for x of the copter
+         * @return the position for x of the copter
+         */
     int _posx;
-
+    
+    /** int the size of wall
+         * @return the size of wall
+         */
     int _wall_size;