Diff: OLED.h

Revision:

12:b4d5e007640e

Parent:

11:77aaf68a180b

--- a/OLED.h	Tue Feb 25 18:22:01 2020 +0000
+++ b/OLED.h	Tue Feb 25 20:59:35 2020 +0000
@@ -31,9 +31,10 @@
 #define SSD1306_SETSTARTLINE 0x40
 
 /**
-  * Access to bit 0-7, named  by0 or x, and bit 8-15, named by1 or y 
-  * of 16 bit named that16. Can be consructed with either two uint8_t or
-  * a uint16_t
+  * Access to bitfields under different names.
+  * Access to bit 0-7, named  by0 or x, and bit 8-15, named by1 or y \n  
+  * of 16 bit named that16. Can be consructed with either two \n  
+  * uint8_t or a uint16_t
   */
 union uint16 {
     struct {
@@ -307,7 +308,7 @@
     {0x00,0x00,0x00,0x00,0x00}};
 
 /**
-  * Representation of a 128x64 pixels, SSD1306 compatibel OLED display
+  * Representation of a 128x64 pixels, SSD1306 compatibel OLED display.
   */ 
 class OLED {
     
@@ -339,19 +340,19 @@
 
     /**
       * ssd1306 compatible device of 128x64 pixels OLED display.
-      * Init() must be called after construction.
+      * Init() must be called after construction. \n 
       * Works for some untraced circumstances not in fibers
       */
     OLED();
 
     /**
-      * Initialisere display and clears it. A buffer representing charaters are 
-      * filled with space characters
+      * Initialisere display and clears it. 
+      * A buffer representing charaters are filled with space characters.
       */ 
     void init();
     
     /**
-      * Clears the display. only in h
+      * Clears the display.
       */
     void clear();
 
@@ -359,15 +360,15 @@
       * 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. 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)
+      * Put a char on display. 
+      * The font represent display characters as 6x8 pixels areas (6 horizontal). \n 
+      * The font does actual contain 5 colums - the six'd makes characters \n 
+      * seperation. Character values 0, 0x20, and 0xff are bitpatterns with \n
+      * all null pixels (like space)
       *
       * @param x horizontal pixelwise position, range [0,displayWidth - 6]
       * @param y vertical position, range [0,7]
@@ -391,8 +392,10 @@
       */
     uint8_t printf(const char * frmt, ...);   
     
+    /**
+     *  Scroll the display one line
+     */
     void scroll();
     
 };
 #endif
-