Diff: display.h

Revision:

2:c3231b95aff0

Parent:

1:a6f341df1ef1

Child:

3:ee53c9811f62

--- a/display.h	Thu Apr 03 20:24:36 2014 +0000
+++ b/display.h	Thu Apr 03 20:42:39 2014 +0000
@@ -11,13 +11,32 @@
     
     display(ST7735_LCD *disp);
     
-
+    /**
+    *Debug print that prints text in center of screen.
+    *Will overwrite old text.
+    */
     void print(char *str);
+    /**
+    *Test function that prints a string repeatedly in a rainbow fashion.
+    */
     void printrb(const char *str);
-    
+    /**
+    *Debug function that blinks text.
+    */
     void blinktext(const char *str);
     
+    /**
+    *Displays the the strength on the screen, on the first line.
+    *newStrength is the number in the form of a string, with units as
+    *desired. Prints in format "Strength:newStrength". Will overwrite old
+    *value automatically.
+    */
     void displayStr(char *newStrength);
     
+    /**
+    *Works identically to displayStrength, but on second line with distance.
+    *Prints in format "Dist:newDist". Units must be in string as desired.
+    *Will overwrite old value automatically.
+    */
     void displayDist(char * newDist);
 };
\ No newline at end of file