Diff: Gold/Gold.h

Revision:

18:d4fccdf8d90e

Parent:

17:3ba4ec25c4c5

--- a/Gold/Gold.h	Tue May 12 09:22:31 2020 +0000
+++ b/Gold/Gold.h	Tue May 12 12:38:14 2020 +0000
@@ -20,56 +20,51 @@
 public:
     /** Constructor */
     Gold();
+    
     /** Destructor */
     ~Gold();
+    
     /** Initialise the gold 
-    *
-    *   This function initialises the components of the gold.
     *   @param  gold_num - number of the gold
     */
     void init(int gold_num);
+    
     /** Draw the golds
-    *
-    *   This function draws the golds.
     *   @param  lcd - N5110 library
     */
     void draw(N5110 &lcd);
+    
     /** Update the data
-    *
-    *   This function gets the new positions and number of golds.
     */
     void update();
+    
     /** Mark the gold which has been caught
-    *
-    *   This function mark the gold which has been caught.
     *   @param  caught_i - the serial number of the captured gold
     */
     void gold_caught(int caught_i);
+    
     /** Get the number of lifted gold
-    *
-    *   This function gets the number of lifted gold.
+    *   @return the number of lifted gold.
     */
     int get_reached_num();
+    
     /** Get the number of left golds
-    *
-    *   This function gets the number of left golds.
+    *   @return the number of left golds.
     */
     int get_left_num();
+    
     /** Get the position of the gold 
-    *
-    *   This function gets the position of the gold with serial number i.
     *   @param  gold_i - the serial number of the gold
+    *   @return the position of the gold
     */
     Vector2D get_pos(int gold_i);
+    
     /** Set the position of the gold
-    *
-    *   This function set the position of the gold.
     *   @param  p - the position of the gold
     */
     void set_pos(Vector2D p);
+    
     /** Set the speed of the caught gold
-    *
-    *   This function set the speed of the caught gold.
     *   @param  speed - the speed of the gold
     */
     void set_speed(int speed);