Diff: RA8875.h

Revision:

31:c72e12cd5c67

Parent:

30:e0f2da88bdf6

Child:

32:0e4f2ae512e2

diff -r e0f2da88bdf6 -r c72e12cd5c67 RA8875.h
--- a/RA8875.h	Sun Jan 19 04:42:25 2014 +0000
+++ b/RA8875.h	Mon Jan 20 19:19:48 2014 +0000
@@ -87,9 +87,13 @@
 /// of column and row, which is measured in character positions (and dependent
 /// on the font size), and other text APIs permit pixel level positioning.
 ///
+/// @todo Bitmap support.
+/// @todo Bitmap support could be sped up significantly using more hw features 
+///         (e.g. graphics cursor to avoid setting x,y coords for every pixel)
+/// @todo Add Scroll support for text.
 /// @todo Add 2-Layer support.
+/// @todo Improve sync between internal and externa font support - cursor, window, scroll.
 /// @todo Find out why it can't shift frequency after constructor runs.
-/// @todo Bitmap support.
 /// @todo Add Hardware reset signal.
 /// @todo Add Touch Screen support.
 /// @todo Add Keypad Support.
@@ -101,24 +105,24 @@
     /// font type selection.
     typedef enum
     {
-        ISO8859_1,
-        ISO8859_2,
-        ISO8859_3,
-        ISO8859_4
+        ISO8859_1,      ///< ISO8859-1 font
+        ISO8859_2,      ///< ISO8859-2 font
+        ISO8859_3,      ///< ISO8859-3 font
+        ISO8859_4       ///< ISO8859-4 font
     } font_t;
     
     /// font rotation selection
     typedef enum
     {
-        normal,
-        rotated
+        normal,         ///< normal orientation
+        rotated         ///< rotated orientation
     } font_angle_t;
     
     /// alignment  
     typedef enum
     {
-        align_none,
-        align_full
+        align_none,     ///< align - none
+        align_full      ///< align - full
     } alignment_t;    
     
     /// Scale factor - 1, 2, 3 4
@@ -130,8 +134,8 @@
     /// Clear screen region
     typedef enum
     {
-        FULLWINDOW,
-        ACTIVEWINDOW
+        FULLWINDOW,     ///< Full screen
+        ACTIVEWINDOW    ///< active window/region
     } Region_t;
     
     /// Constructor for a display based on the RAiO RA8875