Diff: Ennemy/Enemy.h

Revision:

14:58887d7e1072

Parent:

11:b3024ab59fa5

--- a/Ennemy/Enemy.h	Wed May 27 04:36:22 2020 +0000
+++ b/Ennemy/Enemy.h	Wed May 27 07:48:27 2020 +0000
@@ -9,17 +9,39 @@
 #define TYPE_VERT 1
 #define TYPE_HOR 0
 
-
+/** Enemy Class
+ * @brief Class to control the enemies
+ * @author Joe Barhouch
+ * @author 201291584
+ */
 class Enemy
 {
 
 public:
+    /** Constructor 
+    *@param Horizontal or Vertical enemy
+    *@param intial X
+    *@param intial Y
+    */
     Enemy(bool type,int spawnX, int spawnY);
+    /** Deconstructor */
     ~Enemy();
-
+    /** Draw on the lcd
+    *@param lcd
+    */
     void draw(N5110 &lcd);
+        /** update speed
+    *@param set int speed
+    */
     void update(int _ev);
+    /** set position of enemies
+    *@param X coordinate
+    *@param Y coordinate
+    */
     void set_pos(int x, int y);
+    /** set position of enemies
+    *@return Vector2D of the position
+    */
     Vector2D get_pos();