Diff: Map/map.h

Revision:

11:0e6a221ad8a9

Parent:

10:b939edd9b87c

Child:

12:bc9a43f56261

--- a/Map/map.h	Fri May 10 12:00:30 2019 +0000
+++ b/Map/map.h	Fri May 10 13:58:51 2019 +0000
@@ -5,18 +5,47 @@
 #include <vector>
 #include "mbed.h"
 
-
+/** Map Class
+@author Dobri Tsvetkov, University of Leeds
+@brief C++ class define a map for the track
+@date May 2019
+*/ 
 class Map {
     
   public:
+    /**
+    @brief init method
+    @param None 
+    @details initialises some of the variables
+    */
     void init();
     
     // accessors
+    /**
+    @brief Player Curvature accessor
+    @param None 
+    @details returns float _player_curvature
+    */
     float get_player_curvature();
+    /**
+    @brief Tiemed curvature accessor
+    @param None 
+    @details returns float _timed_curvature
+    */
     float get_timed_curvature();
     
     // mutators
+    /**
+    @brief Player Curvature mutator
+    @param float _player_curvature 
+    @details 
+    */
     void set_player_curvature(float _player_curvature);
+    /**
+    @brief Timed curvature mutator
+    @param float _timed_curvature 
+    @details 
+    */
     void set_timed_curvature(float _timed_curvature);
   
   private: