Diff: Enemy/Enemy22.h

Revision:

6:1fcfd331c047

Parent:

0:99fa5a619081

Child:

13:a2f061b9cc36

--- a/Enemy/Enemy22.h	Mon May 06 18:29:49 2019 +0000
+++ b/Enemy/Enemy22.h	Wed May 08 10:03:24 2019 +0000
@@ -6,21 +6,65 @@
 #include "Gamepad.h"
 
 
+/** Enemy22 Class
+ * @brief  Second enemy for stage two
+ * @author Rex Roshan Raj
+ */
 class Enemy22
 {
 
 public:
+
+    /** Constructor */
     Enemy22();
+    
+    /** Destructor */
     ~Enemy22();
     
+    /** Initialise the parameters for the second enemy in stage two 
+    *@param a - x position of the enemy
+    *@param b - y position of the enemy
+    *@param speed - the speed of the enemy moving
+    */
     void init(int a,int b,int speed);
+    
+    /** Draws enemy
+    * @param N5110 lcd
+    * @brief Draws the second enemy in stage two
+    */
     void enemy2(N5110 &lcd);
+    
+    /** Updates the movement 
+    * @brief Changes the movement of the enemy  
+    */ 
     void update();
+    
+    /** Adds the value of health by 1 */
     void add_health();
+    
+    /** Sets the movement of the enemy 
+    *   @param movement 
+    */
     void set_movement(Vector2D m);
+    
+    /** Sets the position of the enemy 
+    *   @param position of the enemy 
+    */
     void set_enemy22_pos(Vector2D e);
+    
+    /** Gets the value of the health 
+    * @returns value in range 0 to 10
+    */
     int get_health();
+    
+    /** Gets the position of the enemy
+    * @returns a struct with x,y members which corresponds to x and y position respectively
+    */
     Vector2D get_enemy22_pos();
+    
+    /** Gets the movement of the enemy
+    * @returns a struct with x,y members which corresponds to x and y movement respectively
+    */
     Vector2D get_movement();
     
 private: