Diff: Claw/Claw.h

Revision:

18:d4fccdf8d90e

Parent:

17:3ba4ec25c4c5

Child:

19:08c582bcdc98

diff -r 3ba4ec25c4c5 -r d4fccdf8d90e Claw/Claw.h
--- a/Claw/Claw.h	Tue May 12 09:22:31 2020 +0000
+++ b/Claw/Claw.h	Tue May 12 12:38:14 2020 +0000
@@ -20,57 +20,52 @@
 public:
     /** Constructor */
     Claw();
+    
     /** Destructor */
     ~Claw();
+    
     /** Initialise the claw
-    *
-    *   This function initialises the components of claw.
     *   @param  winch_width - The width of the winch
     */
     void init(int winch_width);
+    
     /** Draw the claw
-    *
-    *   This function draws the claw.
     *   @param  lcd - N5110 library
     */
     void draw(N5110 &lcd);
+    
     /** Update the data
-    *
-    *   This function gets the new position of the claw.
     *   @param  d - the direction of the joystick
     *   @param  mag - the magnitude of the joystick
     *   @param  winch_pos - the position of the winch
     */
     void update(Direction d,float mag,Vector2D winch_pos);
+    
     /** Add the current score
-    *
-    *   This function adds the current score.
     */
     void add_now_score();
+    
     /** Get the current score
-    *
-    *   This function gets the current score.
+    *   @return the current score
     */
     int get_now_score();
+    
     /** Set the velocity of claw
-    *
-    *   This function set the velocity of the claw.
     *   @param  v - the velocity of the claw
     */
     void set_velocity(float v);
+    
     /** Get the velocity
-    *
-    *   This function gets the velocity of the claw.
+    *   @return the claw velocity
     */
     float get_velocity();
+    
     /** Get the position of the claw
-    *
-    *   This function gets the position of the claw.
+    *   @return the position of the claw.
     */
     Vector2D get_pos();
+    
     /** Set position of the claw
-    *
-    *   This function set the position of the claw.
     *   @param  p - position of the claw
     */
     void set_pos(Vector2D p);