Diff: Objects/Objects.h

Revision:

15:807eba7c7811

Parent:

8:c3153fd4d8ce

--- a/Objects/Objects.h	Sun May 05 11:25:08 2019 +0000
+++ b/Objects/Objects.h	Tue May 07 18:01:54 2019 +0000
@@ -7,28 +7,67 @@
 #include "Player.h"
 
 /** Objects Class
-*   @author Oliver Luong, University of Leeds
-*   @brief Controls the objects in the Dodge game 
-*   @date 22/04/2019
+
+@brief Controls the objects in the Dodge game 
+
+@brief Revisions 1.0
+
+
+@author Oliver Luong, University of Leeds
+@date 22/04/2019
 */ 
 class Objects
 {
 
 public:
+    /** Contructor / Destructor */
     Objects();
     ~Objects();
+    
+// Methods
+    /**
+    This method will be used to initialise the objects variables.
+    Saves global variables to local variables.
+    @param size fetched from the dodge engine.
+    @param speed fetched from the dodge engine.
+    */
     void init(int size,int speed);
+    
+    /**
+    This method will be used to draw the objects to the LCD.
+    */
     void draw(N5110 &lcd);
+    
+    /**
+    This method will be used to update the objects position.
+    */
     void update();
-    /// accessors and mutators
+    
+    /**
+    This method will be used to set the velocity of the objects.
+    @param v velocity fectched from get_velocity
+    */
     void set_velocity(Vector2D v);
+    
+    /**
+    This method will be used to return the velocity when called.
+    */
     Vector2D get_velocity();
+    
+    
     Vector2D get_pos();
+    
+    /**
+    This method will be used to set the postion of the objects.
+    @param p, stores the x and y component of postion.
+    */
     void set_pos(Vector2D p);
     
 private:
 
     Vector2D _velocity;
+    
+// Variables
     int _size;
     int _x;
     int _y;