Diff: TextDisplay.h

Revision:

125:7a0b70f56550

Parent:

104:8d1d3832a215

Child:

167:8aa3fb2a5a31

--- a/TextDisplay.h	Sun Jul 31 20:59:01 2016 +0000
+++ b/TextDisplay.h	Mon Aug 01 22:31:42 2016 +0000
@@ -123,18 +123,27 @@
     // putc (from Stream)
     // printf (from Stream)
 
-protected:    
+protected:
+    /// a method to put a character to the display.
+    ///
+    /// @param value is the character value to send to the display
+    /// @returns the character that was sent.
+    ///
     virtual int _putc(int value);
+    
+    /// a method to get a character from the stdin
+    /// 
+    /// @returns the fetched character.
+    ///
     virtual int _getc();
 
-    // character location
-    uint16_t _column;
-    uint16_t _row;
+    uint16_t _column;           ///< character column location
+    uint16_t _row;              ///< character row location
 
     // colors
-    color_t _foreground;
-    color_t _background;
-    char *_path;
+    color_t _foreground;        ///< presently set foreground color
+    color_t _background;        ///< presently set background color
+    char *_path;                ///< stream name when redirecting stdio
 };
 
 #endif