New LiquidCrystal / LiquidCrystal_SR.h

The default branch has multiple heads

Diff from to

LiquidCrystal_SR.h

 
 // two-wire indicator constant
 // ---------------------------------------------------------------------------
-#define TWO_WIRE 204
+#define TWO_WIRE  204
 #define SR_RS_BIT 0x04
 #define SR_EN_BIT 0x80
 
     The constructor does not initialize the LCD. Assuming 1 line 8 pixel high 
     font.
     
-    @param srdata   pin for shiftregister data line.
-    @param srclock  pin for shiftregister clock line.
-    @param enable   enable pin for the shiftregister.
+    @param srdata[in]   pin for shiftregister data line.
+    @param srclock[in]  pin for shiftregister clock line.
+    @param enable[in]   enable pin for the shiftregister.
     */
    LiquidCrystal_SR ( uint8_t srdata, uint8_t srclock, uint8_t enable );
-
-
+   
+   
    // Set nr. of lines, assume 8 pixel high font
    LiquidCrystal_SR ( uint8_t srdata, uint8_t srclock, uint8_t enable, 
-                      uint8_t lines );
+                     uint8_t lines );
    
    // Set nr. of lines and font
    LiquidCrystal_SR( uint8_t srdata, uint8_t srclock, uint8_t enable, 
-                     uint8_t lines, uint8_t font );
-
-      
+                    uint8_t lines, uint8_t font );
+   
+   
    /*!
     @function
     @abstract   LCD initialization.
     initializes the LCD, therefore, it MUST be called prior to using any other
     method from this class or parent class.
     
-    @param      cols: the number of columns that the display has
-    @param      rows: the number of rows that the display has
-    @param      charsize: size of the characters of the LCD: LCD_5x8DOTS or
+    @param      cols[in] the number of columns that the display has
+    @param      rows[in] the number of rows that the display has
+    @param      charsize[in] size of the characters of the LCD: LCD_5x8DOTS or
     LCD_5x10DOTS.
     */
    virtual void begin(uint8_t cols, uint8_t rows, uint8_t charsize = LCD_5x8DOTS);   
     
     Users should never call this method.
     
-    @param      value Value to send to the LCD.
+    @param      value[in] Value to send to the LCD.
     @result     mode LOW - write to the LCD CGRAM, HIGH - write a command to
     the LCD.
     */
     @discussion Initializes the LCD pin allocation and configuration.
     */
    void init ( uint8_t srdata, uint8_t srclock, uint8_t enable, uint8_t lines, 
-               uint8_t font );
+              uint8_t font );
    /*!
     @method     
     @abstract   For sending data when initializing the display to 4-bit
     @discussion Initializes the LCD pin allocation and configuration.
     */
    void init4bits ( uint8_t );
-
+   
    uint8_t _srdata_pin;  // Serial Data pin
    uint8_t _srclock_pin; // Clock Pin
    uint8_t _enable_pin;  // Enable Pin
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.