Start of code documentation.

Author: fdebrabander

LiquidCrystal_I2C.h

@@ -50,18 +50,75 @@
 #define Rw B00000010  // Read/Write bit
 #define Rs B00000001  // Register select bit
 
+/**
+ * This is the driver for the Liquid Crystal LCD displays that use the I2C bus.
+ *
+ * After creating an instance of this class, first call begin() before anything else.
+ * The backlight is on by default, since that is the most likely operating mode in
+ * most cases.
+ */
 class LiquidCrystal_I2C : public Print {
 public:
+	/**
+	 * Constructor
+	 *
+	 * @param lcd_addr	I2C slave address of the LCD display. Most likely printed on the
+	 *					LCD circuit board, or look in the supplied LCD documentation.
+	 * @param lcd_cols	Number of columns your LCD display has.
+	 * @param lcd_rows	Number of rows your LCD display has.
+	 * @param charsize	The size in dots that the display has, use LCD_5x10DOTS or LCD_5x8DOTS.
+	 */
 	LiquidCrystal_I2C(uint8_t lcd_addr, uint8_t lcd_cols, uint8_t lcd_rows, uint8_t charsize = LCD_5x8DOTS);
+
+	/**
+	 * Set the LCD display in the correct begin state, must be called before anything else is done.
+	 */
 	void begin();
+	
+	 /**
+	  * Remove all the characters currently shown. Next print/write operation will start
+	  * from the first position on LCD display.
+	  */
 	void clear();
+	  
+	/**
+	 * Next print/write operation will will start from the first position on the LCD display.
+	 */
 	void home();
+
+	 /**
+	  * Do not show any characters on the LCD display. Backlight state will remain unchanged.
+	  * Also all characters written on the display will return, when the display in enabled again.
+	  */
 	void noDisplay();
+	  
+	/**
+	 * Show the characters on the LCD display, this is the normal behaviour. This method should
+	 * only be used after noDisplay() has been used.
+	 */ 
 	void display();
+
+	/**
+	 * Do not blink the cursor indicator.
+	 */
 	void noBlink();
-	void blink();
+	 
+	/**
+	 * Start blinking the cursor indicator.
+	 */ 
+	void blink();	 
+
+	/**
+	 * Do not show a cursor indicator.
+	 */
 	void noCursor();
+
+	/**
+ 	 * Show a cursor indicator, cursor can blink on not blink. Use the
+	 * methods blink() and noBlink() for changing cursor blink.
+	 */ 
 	void cursor();
+
 	void scrollDisplayLeft();
 	void scrollDisplayRight();
 	void printLeft();