Diff: Map/Map.h

Revision:

9:3a0194c87afe

Parent:

6:e8c03f264ffc

diff -r d1c04f0e4890 -r 3a0194c87afe Map/Map.h
--- a/Map/Map.h	Sat May 11 08:23:54 2019 +0000
+++ b/Map/Map.h	Sun May 12 16:21:08 2019 +0000
@@ -1,13 +1,36 @@
+/** My Map Class
+* @brief Stores and draws all map parameters.
+* @author Thomas Foster
+* @date May, 2019
+*/
 #include "mbed.h"
 #include "N5110.h"
 #include "Gamepad.h"
 
-class Map { // Deals with information regarding the maps outer walls
+class Map {
 
 public:
+
+  /** Constructor */
   Map();
+
+  /** Initialises Maps's variables
+  * @param width (int)
+  * @param width (int)
+  * @param screen width (int)
+  * @param screen height (int)
+  */
   void init(int width, int height, int swidth, int sheight);
+
+  /** Re writes Maps parameters
+  * @param x position (int)
+  * @param y position (int)
+  */
   void write(int x1, int y1);
+
+  /** Draws four rectangles on screen
+  * @param The N5110 library (N5110)
+  */
   void draw(N5110 &lcd);
 private:
   void map_parameters();