Diff: OLED.h

Revision:

10:8bf77efd1579

Parent:

8:5972683a7190

Child:

11:77aaf68a180b

--- a/OLED.h	Mon Feb 24 18:44:22 2020 +0000
+++ b/OLED.h	Tue Feb 25 18:13:33 2020 +0000
@@ -351,39 +351,43 @@
     void init();
     
     /**
-      * clears the display
+      * Clears the display
       */
     void clear();
 
     /** 
-      * Makes a newline by incrementing charY and assigning xOffset to charX
-      * if charY becomes 8 the display screen is scrolled one line and charY
+      * Makes a newline by incrementing charY and assigning xOffset to charX \n 
+      * if charY becomes 8 the display screen is scrolled one line and charY \n 
       * is decremented to 7. pendingNewline=false is done at last.
+      * pendingNewline=false is done at last.
       */
     void newLine();
     
     /**
-      * Put a char on display. A value in range [0x00,0xFF] i permitted -
-      * 0,0xff and 0x20 are bitpatterns with all null pixels (like space)
+      * Put a char on display. The font used displays characters in 6x8 pixels
+      * area (6 horizontal). The font does actual contain 5 colums - the six'd
+      * makes charcters seperation. Character values 0, 0x20, and 0xff are
+      * are bitpatterns with all null pixels (like space)
       *
       * @param x horizontal pixelwise position, range [0,displayWidth - 6]
       * @param y vertical position, range [0,7]
+      * @param character to put on display
       */
     void drawChar(uint8_t x, uint8_t y, uint8_t chr );
     
-    /** 
-      * Writes a string at charX, charY position. Afterwards are
-      * charX, charY set to the new starting point for writting
-      * \n and \r is processed - \n includes \r  functionality
-      *
-      * @param str to be displayed at (charX, charY).   
-      */
+  /** 
+    * Writes a string at charX, charY position. Afterwards are \n 
+    * charX, charY set to the next starting point for writting to display \n 
+    * \\n and \\r is processed - \\n includes \\r  functionality. \n 
+    *
+    * @param str to be displayed at (charX, charY).   
+    */
     void puts(string str);
     
     /**
-      * printf - the old clasic but don't use \n or \r in format string
-      *  \n and \r is processed - \n includes \r  functionality
-      * This function is the main reason to that OLED not works in fibers.
+      * printf - the old classic. \\n and \\r is processed. \n 
+      * \\n includes \\r  functionality. \n    
+      * This function is the main reason to that OLED not works in fibers. \n
       */
     uint8_t printf(const char * frmt, ...);