Diff: Enemy/EnemyBoss.h

Revision:

6:1fcfd331c047

Parent:

1:45493d1d0689

Child:

13:a2f061b9cc36

diff -r 016a7315b75d -r 1fcfd331c047 Enemy/EnemyBoss.h
--- a/Enemy/EnemyBoss.h	Mon May 06 18:29:49 2019 +0000
+++ b/Enemy/EnemyBoss.h	Wed May 08 10:03:24 2019 +0000
@@ -6,31 +6,125 @@
 #include "Gamepad.h"
 #include "Enemy.h"
 
-
+/** EnemyBoss Class
+ * @brief  Enemies for stage three
+ * @author Rex Roshan Raj
+ */
 class EnemyBoss
 {
 
 public:
+
+    /** Constructor */
     EnemyBoss();
+    
+    /** Destructor */
     ~EnemyBoss();
     
+     /** Initialise the parameters for the enemies in stage three 
+    *@param a - x position of the boss
+    *@param b - y position of the boss
+    *@param c - x position of the first enemy
+    *@param d - y position of the first enemy
+    *@param e - x position of the second enemy
+    *@param f - y position of the second enemy
+    *@param speed - the speed of the boss moving
+    */
     void init(int a,int b,int c,int d,int e,int f, int speed);
+    
+    /** Draws enemy
+    * @param N5110 lcd
+    * @brief Draws all three enemies in stage three
+    */
     void enemyboss(N5110 &lcd);
+    
+    /** Updates the movement 
+    * @brief Changes the movement of the enemy  
+    */ 
     void update();
+    
+    /** Adds the value of health by 1 
+    *@brief Health for the boss
+    */
     void add_health_boss();
+    
+    /** Adds the value of health by 1 
+    *@brief Health for the first enemy
+    */
     void add_health_enemy1();
+    
+    /** Adds the value of health by 1 
+    *@brief Health for the second enemy 
+    */
     void add_health_enemy2();
+    
+    /** Gets the value of the health 
+    * @brief returns the health of the boss
+    * @returns value in range 0 to 10
+    */
     int  get_health_boss();
+    
+    /** Gets the value of the health 
+    * @brief returns the health of the first enemy
+    * @returns value in range 0 to 10
+    */
     int  get_health_enemy1();
+    
+    /** Gets the value of the health 
+    * @brief returns the health of the second enemy
+    * @returns value in range 0 to 10
+    */
     int  get_health_enemy2();
-    int get_direction();
+    
+    /** Sets the movement of the enemy 
+    *   @param movement 
+    */
     void set_movement(Vector2D m);
+    
+    /** Sets the position of the enemy
+    *   @brief Position of the boss  
+    *   @param position 
+    */
     void set_enemyboss_pos(Vector2D e);
+    
+    /** Sets the position of the enemy 
+    *   @brief Position of the first enemy 
+    *   @param position 
+    */
     void set_enemy1_pos(Vector2D d);
+    
+    /** Sets the position of the enemy 
+    *   @brief Position of the second enemy 
+    *   @param position
+    */
     void set_enemy2_pos(Vector2D c);
+    
+    /** Gets the motion of the boss
+    * @returns a struct with x,y members which corresponds to velocity in the x and y direction respectively
+    */
+    Vector2D motion();
+    
+    /** Gets the position of the enemy
+    * @brief Position of the boss 
+    * @returns a struct with x,y members which corresponds to x and y position respectively
+    */
     Vector2D get_enemyboss_pos();
+    
+    /** Gets the position of the enemy
+    * @brief Position of the first enemy
+    * @returns a struct with x,y members which corresponds to x and y position respectively
+    */
     Vector2D get_enemy1_pos();
+    
+    /** Gets the position of the enemy
+    * @brief Position of the second enemy 
+    * @returns a struct with x,y members which corresponds to x and y position respectively
+    */
     Vector2D get_enemy2_pos();
+    
+    /** Gets the movement of the boss 
+    * @returns a struct with x,y members which corresponds to x and y movement respectively
+    */
     Vector2D get_movement();
     
 private: