Diff: Ball/Ball.h

Revision:

129:b47c28c7eaaf

Parent:

91:c01a736fb0d9

Child:

130:46f3fac2bdf9

--- a/Ball/Ball.h	Wed May 08 21:32:23 2019 +0000
+++ b/Ball/Ball.h	Wed May 08 23:09:59 2019 +0000
@@ -19,17 +19,49 @@
 {
 
 public:
+    
+    /** Constructor declaration */
     Ball();
+    
+    /** Destructor declaration */
     ~Ball();
+    
+    /** Initialise Ball attributes
+    * @param size @details initialises _size
+    * @param speed @details initialises _speed
+    * @param x @details initialises the _x coordinate over the centre of the paddle
+    */
     void init(int size,int speed,int x);
+    
+    /** Draws the Ball at at its current coordinates on the LCD
+    * @param &lcd @details a N5110 pointer
+    */
     void draw(N5110 &lcd);
+    
+    /** Update the Laser's x and y coordinates based on its velocity */
     void update();
 
-    /// accessors and mutators
+    /** Set the Ball's x and y velocities 
+    * @param v @details a vector of the x and y velocities
+    */
     void set_velocity(Vector2D v);
+    
+    /** Set the Ball's x and y coordinates
+    * @param p @details a vector of the x and y velocities
+    */
+    void set_pos(Vector2D p); 
+    
+    /** Retrieves the Ball's x and y velocities 
+    * @returns a vector of the x and y velocities
+    */
     Vector2D get_velocity();
+    
+    /** Retrieves the Ball's x and y velocities 
+    * @returns a vector of the x and y velocities
+    */
     Vector2D get_pos();
-    void set_pos(Vector2D p);
+    
+    
 
 private: