Diff: uLCD_gauges.h

Revision:

4:069b01d563a3

Parent:

2:38006c26dda5

Child:

5:df405a69bb31

--- a/uLCD_gauges.h	Fri Mar 13 15:25:56 2015 +0000
+++ b/uLCD_gauges.h	Fri Mar 13 15:29:02 2015 +0000
@@ -14,9 +14,38 @@
  
 class uLCD_gauges {
 public:
+    /**
+    * Constructor for the uLCD_gauges class. Sets up the value mapping assuming the default gauge is used.
+    * @author Matthew Arceri
+    * @param screen The uLCD instance that is going to be used for the gauge
+    * @param min The minimum value the gauge wil be updated with. Used for mapping.
+    * @param max The maximum value the gauge wil be updated with. Used for mapping.
+    * @date 3/13/2015
+    */
     uLCD_gauges(uLCD_4DGL& screen, float min, float max);
+    /**
+    * Constructor for the uLCD_gauges class. Sets up the value mapping for custom gauges.
+    * @author Matthew Arceri
+    * @param screen The uLCD instance that is going to be used for the gauge
+    * @param min The minimum value the gauge wil be updated with. Used for mapping.
+    * @param max The maximum value the gauge wil be updated with. Used for mapping.
+    * @param memoryAddressHigh The ending memory address of the animation that will be displayed as a gauge.
+    * @param memoryAddressLow The starting memory address of the animation that will be displayed as a gauge.
+    * @date 3/13/2015
+    */
     uLCD_gauges(uLCD_4DGL& screen, float min, float max, int lowF, int highF, long memoryAddressHigh, long memoryAddressLow);
+    /**
+    * This method repares the uLCD for displaying the gauge. Must be called once after object instancing
+    * @author Matthew Arceri
+    * @date 3/13/15
+    */
     void start();
+    /**
+    * This method updates the gauge based on the new input value
+    * @author Harsha Nori
+    * @param value The value to be mapped onto the display
+    * @date 3/13/15
+    */
     void update(float value);
   
 private: