Diff: TextDisplay.h

Revision:

9:b8bc8296da24

Parent:

0:da1bf437cbc1

--- a/TextDisplay.h	Thu Mar 20 15:29:19 2014 +0000
+++ b/TextDisplay.h	Tue May 06 18:09:00 2014 +0000
@@ -18,17 +18,19 @@
 
 #include "mbed.h"
 
+/**
+ * TextDisplay interface
+ */
 class TextDisplay : public Stream {
 public:
 
-  // functions needing implementation in derived implementation class
-  /** Create a TextDisplay interface
+    /** Create a TextDisplay interface
      *
      * @param name The name used in the path to access the strean through the filesystem
      */
     TextDisplay(const char *name = NULL);
 
-    /** output a character at the given position
+    /** Output a character at the given position
      *
      * @param column column where charater must be written
      * @param  row where character must be written
@@ -36,25 +38,26 @@
      */
     virtual void character(int column, int row, int c) = 0;
 
-    /** return number if rows on TextDisplay
+    /** Return number if rows on TextDisplay
+     *
      * @result number of rows
      */
     virtual int rows() = 0;
 
-    /** return number if columns on TextDisplay
-    * @result number of rows
-    */
+    /** Return number if columns on TextDisplay
+     * @result number of rows
+     */
     virtual int columns() = 0;
     
     // functions that come for free, but can be overwritten
 
-    /** redirect output from a stream (stoud, sterr) to  display
-    * @param stream stream that shall be redirected to the TextDisplay
-    */
+    /** Redirect output from a stream (stoud, sterr) to  display
+     * @param stream stream that shall be redirected to the TextDisplay
+     */
     virtual bool claim (FILE *stream);
 
-    /** clear screen
-    */
+    /** Clear screen
+     */
     virtual void cls();
     virtual void locate(int column, int row);
     virtual void foreground(uint16_t colour);