Daniel Worrall / dispBoB

6 x 7 segment display library for PCA9637 driven breakout board

Dependents:   FTSE100 InternetDispBoB digitalThermometer Counter ... more

Diff: dispBoB.h

Revision:
2:b20aa44dec87
Parent:
1:d3d2fb119fa3
Child:
3:e767f379b823
--- a/dispBoB.h	Wed Jun 29 11:26:13 2011 +0000
+++ b/dispBoB.h	Wed Jun 29 11:31:06 2011 +0000
@@ -10,10 +10,28 @@
 #include "PCA9635.h"
 #include "ctype.h"
 
+/** dispBoB class, defined on the I2C master bus
+* 
+* Example:
+* @code
+* #include "mbed.h"
+* #include "dispBoB.h"
+*
+* dispBoB db(p28, p27, p26);
+* string str = "This is London calling";
+*
+* int main() {
+*     db.cls();
+*     while(1){
+*         db.scroll(str, 0.25);
+*     }
+* }
+* @endcode
+*/
 class dispBoB {
 public:
     //constructor
-    /** Create a dispBoB object defined on the I2C bus
+    /** Create a dispBoB object defined on the I2C master bus
     *
     */
     dispBoB(PinName sda, PinName scl, PinName en);