Revision 12:6bf9d9957d31, committed 2013-02-05

Comitter:

wim

Date:

Tue Feb 05 21:50:43 2013 +0000

Parent:

11:9ec02df863a1

Child:

13:24506ba22480

Commit message:

Updated Documentation

Changed in this revision

--- a/TextLCD.cpp	Tue Feb 05 21:03:43 2013 +0000
+++ b/TextLCD.cpp	Tue Feb 05 21:50:43 2013 +0000
@@ -1,6 +1,6 @@
 /* mbed TextLCD Library, for a 4-bit LCD based on HD44780
  * Copyright (c) 2007-2010, sford, http://mbed.org
- *               2013, WH, Updated LCD types and fixed lcd address issues
+ *               2013, WH, Added LCD types, fixed LCD address issues, added Cursor and UDCs
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -319,7 +319,8 @@
         case LCD20x4:
         case LCD24x4:        
             return 4;
-      
+
+// Should never get here.      
         default:
             return 0;        
     }
@@ -349,6 +350,7 @@
                            _cursor = show;
                            break;
 
+// Should never get here.
       default : 
                            break;
                       

--- a/TextLCD.h	Tue Feb 05 21:03:43 2013 +0000
+++ b/TextLCD.h	Tue Feb 05 21:50:43 2013 +0000
@@ -1,6 +1,6 @@
 /* mbed TextLCD Library, for a 4-bit LCD based on HD44780
  * Copyright (c) 2007-2010, sford, http://mbed.org
- *               2013, WH, Updated LCD types and fixed lcd address issues
+ *               2013, WH, Added LCD types, fixed LCD address issues, added Cursor and UDCs 
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -84,10 +84,10 @@
 
     /** LCD Cursor control */
     enum LCDCursor {
-        CurOff_BlkOff,
-        CurOn_BlkOff,
-        CurOff_BlkOn,        
-        CurOn_BlkOn,
+        CurOff_BlkOff,  /**<  Cursor Off, Blinking Char Off */    
+        CurOn_BlkOff,   /**<  Cursor On, Blinking Char Off */    
+        CurOff_BlkOn,   /**<  Cursor Off, Blinking Char On */    
+        CurOn_BlkOn,    /**<  Cursor On, Blinking Char On */    
     };
 
 
@@ -165,7 +165,7 @@
     /** Set User Defined Characters
      *
      * @param unsigned char c   The Index of the UDC (0..7)
-     * @param char *udc_char    The bitpatterns for the UDC (8 bytes of 5 significant bits)     
+     * @param char *udc_data    The bitpatterns for the UDC (8 bytes of 5 significant bits)     
      */
     void setUDC(unsigned char c, char *udc_data);