ELEC2645 (2018/19) / Mbed 2 deprecated el17set_

Dependencies:   mbed

Revision:
25:1d3bf74dddeb
Parent:
22:8e38efeae0c9
Child:
26:3652bc2fe3fc
--- a/Enemy/Enemy1.h	Thu May 09 12:46:52 2019 +0000
+++ b/Enemy/Enemy1.h	Thu May 09 13:43:23 2019 +0000
@@ -27,23 +27,63 @@
 
   };
 
+/** Enemy1 class
+
+@brief Class of Enemy1
+
+@version 1.0
+
+@author Spencer Tingle
+
+@date 09/05/19
+
+*/
+
 class Enemy1{
 
  public:
 
   Enemy1();
   ~Enemy1();
+  /** 
+  * @brief Init
+  * @param x, y @details Initiates coordinates of coins
+  */
   void init(int x,int y);
+  /** 
+  * @brief Get x
+  * @details Gets the current x-coordinate
+  */
   int get_x_enem();
+  /** 
+  * @brief Get y
+  * @details Gets the current y-coordinate
+  */
   int get_y_enem();
+  /** 
+  * @brief Draw enemyA
+  * @param lcd @details Draws the enemyA sprite
+  */
   void drawSpriteA(N5110 &lcd);
+  /** 
+  * @brief Draw enemy1
+  * @param lcd @details Draws the enemy1 sprite
+  */
   void drawSprite1(N5110 &lcd);
+  /** 
+  * @brief Moves enemyA
+  * @param lcd @details Moves the enemyA sprite
+  */
   void movementA(N5110 &lcd);
+  /** 
+  * @brief Moves enemy1
+  * @param lcd @details Moves the enemy1 sprite
+  */
   void movement1(N5110 &lcd);
-  bool northCollision(int x, int y, N5110 &lcd);
-  bool southCollision(int x, int y, N5110 &lcd);
-  bool eastCollision(int x, int y, N5110 &lcd);
-  bool westCollision(int x, int y, N5110 &lcd);
+  /** 
+  * @brief Detects collision
+  * @param x, y, pad @details When baby and enemy collide tone plays
+  */
   bool collidePlayer(int x, int y, Gamepad &pad);
 
  private: