Diff: Grove_LCD_RGB_Backlight.h

Revision:

1:40a3b6506c9f

Parent:

0:253885b1f364

Child:

2:5ce38ef7a7db

diff -r 253885b1f364 -r 40a3b6506c9f Grove_LCD_RGB_Backlight.h
--- a/Grove_LCD_RGB_Backlight.h	Tue Mar 15 17:19:39 2016 +0000
+++ b/Grove_LCD_RGB_Backlight.h	Tue Mar 15 18:02:44 2016 +0000
@@ -25,37 +25,54 @@
 #define LCD_2LINE 0x08
 #define LCD_5x10DOTS 0x04
 
-    
+/** Grove_LCD_RGB_Backlight Class.
+*   Used for connecting a Grove LCD RGB Backlit display
+*   to an mbed microcontroller via an I2C interface.
+*/    
 class Grove_LCD_RGB_Backlight
 {
 public:
     
-    //Contructor
+    /** Contructor. Creates an instance of the Grove_LCD_RGB_Backlight class.
+    *   @param sda SDA pin on the mbed microcontroller which will be used to communicate with the display.
+    *   @param scl SCL pin on the mbed microcontroller which will be used to communicate with the display.
+    */
     Grove_LCD_RGB_Backlight(PinName sda, PinName scl); 
     
 
     
-    //Set RGB Color of backglight
+    /** Set RGB Color of backglight
+    *   @param r Value for the red component of the RGB backlight (Between 0 and 255).
+    *   @param g Value for the green component of the RGB backlight (Between 0 and 255).
+    *   @param b Value for the blue component of the RGB backlight (Between 0 and 255).
+    */
     void setRGB(char r, char g, char b);     
     
+    
+    /** Removes all of the text from the display.
+    */
+    void clear();
+    
+    /**Prints text to the LCD display.
+    * @param *str Pointer to an array of characters which will be printed to the LCD screen.
+    */
+    void print(char *str);
+    
+    /**Move cursor to specified location on the LCD screen.
+    * @param col Value for which column on the display the next text being printed will start at.
+    * @param row Value for which row on the display the next text being printed will be printed on.
+    */
+    void locate(char col, char row);
+
+    
+private:
+    
     //Initialize device
     void init();   
     
     //Turn on display
     void displayOn();
     
-    //Clear all text from display
-    void clear();
-    
-    //Print text to the lcd screen
-    void print(char *str);
-    
-    //Move cursor to specified location
-    void locate(char col, char row);
-
-    
-private:
-    
     //Send command to display
     void sendCommand(char value);