Diff: TTU_CSC1300.h

Revision:

2:b1b9fba116c2

Parent:

1:62c831ab7306

Child:

3:8f43225dc286

--- a/TTU_CSC1300.h	Mon Jun 29 16:57:39 2020 +0000
+++ b/TTU_CSC1300.h	Mon Jun 29 17:15:27 2020 +0000
@@ -168,13 +168,16 @@
  * THE SOFTWARE.
  */
  
-/**  A TextLCD interface for driving 4-bit HD44780-based LCDs
+/**  A TextLCD interface for driving a HD44780 LCD character
+ *   module connected via a 74HC595 using the F031K6 SPI peripheral.
+ *   Specifically, the Nucleo32 F031K6 boards plugged into the Edubase-V2
+ *   via the adapter used at Tennessee Tech.
  *
  * Supports only the 16x2 display on the EduBase-V2 board
  *
  * @code
  * #include "mbed.h"
- * #include "TextLCD.h"
+ * #include "TTU_CSC1300.h"
  * 
  * TextLCD lcd(TextLCD::LCD_CURSOR_ON_BLINKING_ON);     // select your cursor style
  * 
@@ -194,36 +197,66 @@
         LCD_CURSOR_DEFAULT = 0x03
     } LCDCursor;
   
-    /** Declare a TextLCD interface */
+    /** Constructor to create a TextLCD interface
+     *
+     * @param cur   Desired behavior of LCD cursor
+     *
+     * @see setCursor()
+     * @see TextLCD::LCD_CURSOR_OFF_BLINKING_OFF    No cursor and no blinking block
+     * @see TextLCD::LCD_CURSOR_OFF_BLINKING_ON     No cursor and but blinking block
+     * @see TextLCD::LCD_CURSOR_ON_BLINKING_OFF     Underline cursor and no blinking block
+     * @see TextLCD::LCD_CURSOR_ON_BLINKING_ON      Both underlinecursor and blinking block
+     */ 
     TextLCD(LCDCursor cur);      // default constructor
  
 #if DOXYGEN_ONLY
-    /** Write a character to the LCD
+    /** Write a character to the LCD at the current cursor location
      *
      * @param c The character to write to the display
+     *
+     * @see setLocation()
      */
     int putc(int c);
  
-    /** Write a formated string to the LCD
+    /** Write a formated string to the LCD at the curren cursor location
      *
      * @param format A printf-style format string, followed by the
      *               variables to use in formating the string.
+     *
+     * @note    A string is denoted whthin double-quotes.
      */
     int printf(const char* format, ...);
 #endif
  
-    /** Locate to a screen column and row
+    /** Locate cursor to a screen row and column
      *
-     * @param column  The horizontal position from the left, indexed from 0
      * @param row     The vertical position from the top, indexed from 0
+     * @param column  The horizontal position from the left, indexed from 0     
      */
     void setLocation(int column, int row);
  
     /** Clear the screen and locate to 0,0 */
     void cls();
  
-    /** low-level single character putter **/
+    /** Right a single character to a specific location
+     *
+     * @param row     The vertical position from the top, indexed from 0
+     * @param column  The horizontal position from the left, indexed from 0     
+     * @param c       The character to display on-screen
+     *
+     * @note    A character is denoted within single-quotes (apostrophes)
+     */
     void setCharacter(int row, int column, int c);
+
+    /** Change the LCD cursor mode
+     *
+     * @param c     A LCDCursor type denoted the cursor and blink
+     *
+     * @see TextLCD::LCD_CURSOR_OFF_BLINKING_OFF    No cursor and no blinking block
+     * @see TextLCD::LCD_CURSOR_OFF_BLINKING_ON     No cursor and but blinking block
+     * @see TextLCD::LCD_CURSOR_ON_BLINKING_OFF     Underline cursor and no blinking block
+     * @see TextLCD::LCD_CURSOR_ON_BLINKING_ON      Both underlinecursor and blinking block
+     */
     void setCursor(LCDCursor c);
  
 protected: