Diff: Game_one/Coin_files/Coin.h

Revision:

16:4e49f5cb972e

Parent:

2:464c7e62d97d

Child:

17:5d8ff39a0e49

--- a/Game_one/Coin_files/Coin.h	Sat Apr 20 11:53:09 2019 +0000
+++ b/Game_one/Coin_files/Coin.h	Sat Apr 20 15:20:43 2019 +0000
@@ -14,15 +14,55 @@
 {
 
 public:
+    /** Constructor */
     Coin();
+    /** Deconstructor */
     ~Coin();
+    
+    
+    /**
+     * @brief Initialize the class parameters
+     * @param speed
+     * @details Initialize the coin's position and speed
+     */
     void init(int speed);
+    
+    /**
+     * @brief Draw the object - coin in Game 1
+     * @details Draw the block on lcd screen
+     */
     void draw(N5110 &lcd);
+    
+    /**
+     * @brief Update the coin
+     * @details Update the coin position 
+     */
     void update();
-    /// accessors and mutators
+    
+    // accessors and mutators
+    /**
+     * @brief Set the speed - coin in Game 1
+     * @param speed
+     * @details Set the speed of the coin according to the level of difficulty determined by year
+     */
     void set_velocity(int speed);
+    
+    /**
+     * @brief Get the speed
+     * @details Return the speed of the coin
+     */
     int get_velocity();
+    
+    /**
+     * @brief Get the position
+     * @details Return the position of the coin
+     */
     Vector2D get_pos();
+    
+    /**
+     * @brief Set the position
+     * @details Set the position of the block
+     */
     void set_pos(Vector2D p);
     
 private: