Diff: bullet/bullet.h

Revision:

52:84e89553c606

Parent:

31:5c9309ddf84c

Child:

53:db66345d6755

--- a/bullet/bullet.h	Mon Apr 22 14:27:24 2019 +0000
+++ b/bullet/bullet.h	Mon Apr 22 14:59:49 2019 +0000
@@ -17,15 +17,59 @@
 {
 
 public:
-   bullet();
-    ~bullet();
+// constructors
+  //string Variables of this type are able to store sequences of characters, 
+  //such as words or sentences. 
+  /**
+  *@constucter creat a defult bullet
+  */
+ 
+   bullet();   //constructor
+  ~bullet();  //destructor 
+           
+/*mutators
+  //mutator methods defined as methods which advice the users of the class 
+  //to change the value of a member variable in a controlled manner. 
+  Their names are usually pre-fixed with set_ to make this behaviour clear.*/
+  
+   /** 
+  *@brief initialise an identity for the bullet
+  *@param size @details size of bullet in intger
+  *@param speed @details the speed of bulletin integer
+  */
+    void init(int size,int speed);
+      /** 
+  *@brief drawing the bullet
+  *@param draw @details drawing the bullet by using N5110&lcd librarieas
+  **/
     
-    void init(int size,int speed);
     void draw(N5110 &lcd);
+     /** 
+  *@brief updating the position of the bullet
+  *@param update @details update the position of the bullet.
+  **/
      void update();
+            
+   /** 
+  *@brief sitting up the velocity the of the bullet
+  *@param _velocity @details set the velocity the of the bullet in Vector2D
+  **/
     void set_velocity(Vector2D v);
+     /** 
+  *@brief sitting up the position the of the bullet
+  *@param _pos @details set the position the of the bullet in Vector2D
+  **/
     void set_pos(Vector2D p);
+    
+       /** 
+  *@brief sitting up the velocity the of the bullet
+  *@return the velocity of the bullet in Vector2D
+  **/
         Vector2D get_pos();
+                /** 
+  *@brief sitting up the position  the of the bullet
+  *@return the postion  of the bullet in Vector2D
+  **/
          Vector2D get_velocity();
          
     private: