Diff: Sseg.h

Revision:

4:858e42224b50

Parent:

3:77ec0c031053

Child:

5:d99849505bf7

--- a/Sseg.h	Thu Aug 07 02:36:42 2014 +0000
+++ b/Sseg.h	Thu Aug 07 02:58:19 2014 +0000
@@ -1,5 +1,5 @@
 /*
-  SSeg.cpp - mbed library for 7seg 2/4/8digit seven segment LED driver.
+  SSeg.cpp - mbed library for 2/4/8 digit seven segment LED driver.
   Copyright 2013,2014 by morecat_lab
  
   based on Dots library.
@@ -34,8 +34,8 @@
 #define NUM_PAT_F 0x8e
 
 /**
- * Seven segment display driver library
- */
+ * Seven segment display driver library
+ */
 class Sseg
 {
 private:
@@ -141,7 +141,7 @@
     char segCh(char i);
 
     /**
-     * turn on DP 
+     * turn on DP
      *
      * @param dight
      *
@@ -294,6 +294,7 @@
      * write patterns to a dight 
      *
      * @param d digit
+     *
      * @param value pattern
      *
      */
@@ -314,10 +315,32 @@
      * Turn on LED
      */
     void turnOn(void);
+
+    /**
+     * Update One dight of LED
+     */
     void updateSeg(void);
+
+    /**
+     * Update LED (by internal clock)
+     *
+     * @returns sync = 1, if digit == 0
+     *
+     */
     bool update(void);
+
+    /**
+     * keep updating LED for specified period
+     *
+     * @param ms period (ms)
+     *
+     */
     void updateWithDelay(int ms);
-    void updateOnce(void);
+
+    /**
+     * Update LED Once with 1ms delay
+     */
+     void updateOnce(void);
 };
 
 #endif  // SSEG.h