Diff: GraphicOLED.h

Revision:

1:a104653979bf

Parent:

0:67d983a1ed3e

Child:

2:337a2655f815

--- a/GraphicOLED.h	Fri Mar 23 09:20:04 2012 +0000
+++ b/GraphicOLED.h	Wed Apr 18 10:17:51 2012 +0000
@@ -6,14 +6,35 @@
 #define iskanji(c) ((c)>=0x81 && (c)<=0x9F || (c)>=0xE0 && (c)<=0xFC)
 #define iskanji2(c) ((c)>=0x40 && (c)<=0xFC && (c)!=0x7F)
 
+/** GraphicOLED interface for WS0010
+ *
+ * Currently support shift-jis KANJI(misaki font) 
+ *
+ * @code
+ * #include "mbed.h"
+ * #include "GraphicOLED.h"
+ * 
+ * GraphicOLED oled(p24, p26, p27, p28, p29, p30); // rs, e, d4-d7
+ * 
+ * int main() {
+ *     oled.printf("Hello World!\n");
+ * }
+ * @endcode
+ */
 class GraphicOLED : public TextLCD {
 public:
-    GraphicOLED(PinName rs, PinName e, PinName d0, PinName d1, PinName d2, PinName d3);
-    void g_wrtie(int pat, int x, int y);
-    void g_wrtie(char *buf, int len, int x, int y);
+    /** Create a GraphicOLED interface
+     *
+     * @param rs    Instruction/data control line
+     * @param e     Enable line (clock)
+     * @param d4-d7 Data lines for using as a 4-bit interface
+     */
+    GraphicOLED(PinName rs, PinName e, PinName d4, PinName d5, PinName d6, PinName d7);
     void cls();
     int columns();
 protected:
+    void g_wrtie(int pat, int x, int y);
+    void g_wrtie(char *buf, int len, int x, int y);
     virtual int _putc(int value);
     void character(int column, int row, int c);
     void character2(int column, int row, int c);