Diff: Spaceship/Spaceship.h

Revision:

149:bd0f37008f5a

Parent:

145:e060e890c725

--- a/Spaceship/Spaceship.h	Thu May 09 12:09:59 2019 +0000
+++ b/Spaceship/Spaceship.h	Thu May 09 14:13:43 2019 +0000
@@ -57,21 +57,11 @@
 
 public:
 
-    /** constructors
-     *string Variables of this type are able to store sequences of characters,
-     *such as words or sentences.
-     */
-
+    
 
-    /*@constucter creat a defult a Spaceship
-    */
-
-    Spaceship();
-
-    /**
-    *@constucter creat a defult a spaceship
-    */
-    ~Spaceship();
+   
+    Spaceship();  // constructor
+    ~Spaceship();  // destructor  
     /**
     *@brief initialise an identity for the spaceship
     *@param x_spaceship @details the x-cooridante of spaceship in intger
@@ -84,17 +74,16 @@
 
     /**
     *@brief drawing the spaceship
-    *@param draw @details drawing the spaceship by using N5110&lcd librarieas
+    *@param _(N5110 &lcd)@details the libraries which draw the spaceship on the screen.
     */
     void draw(N5110 &lcd);
     /**
-    *@brief updating the position of the spaceship
-    *@param update @details update the position of the spaceship.
-    */
+    *@brief updating the direction and the magintuide of the spaceship
+    *@param_(Direction d,float mag)@details update the direction and the magintuide of the spaceship.
+    **/
     void update(Direction d,float mag);
-    /**
-    *@brief setting up the position the of the spaceship
-    *@param set_pos @details set the position the of the spaceship in x-cooridante and y-cooridante
+    /**@brief setting up the position the of the spaceship
+    *@param _(x,y) @details set the position the of the spaceship in x-cooridante and y-cooridante
     */
     void set_pos(int x, int y);
     /**
@@ -151,11 +140,11 @@
     int _score;
 
     /**
-    *@param(_direcation) a private variable of class spaceship that represents of spaceship
+    *@param(_direcation) a private variable of class spaceship that represents the direction of spaceship
     */
     Direction d;
-    /*@param
-      (_mag) float a private variable of class spaceship that represents magnitude of the  spaceship
+    /**
+      *@param(_mag) float a private variable of class spaceship that represents magnitude of the  spaceship
       */
     float mag;
 };