Diff: toggle.h

Revision:

1:27360e9dc2c5

Parent:

0:847ab1eb73cf

Child:

2:cd17c7393c05

--- a/toggle.h	Sat Jun 11 12:19:44 2016 +0000
+++ b/toggle.h	Sat Jun 11 12:52:07 2016 +0000
@@ -1,30 +1,36 @@
 #ifndef TOGGLE_H
 #define TOGGLE_H
- 
+
 #include "mbed.h"
 
 
- 
+
 /** Toggle pin for debugging purposes
- *
- * @code
- * #include "mbed.h"
- * #include "toggle.h"
- *
- * Toggle pin(P1_24); 
- * Toggle led(P1.25);
- *  
- * int main() {
- *     
- *   pin.toggle(3);   // toggle pin P1_24 3 times
- *   led.toggle(5);   // toggle led P1_25 5 times
- *
- * }
- * @endcode
- */ 
- 
- 
-class Togglen {
+*
+* Example:
+* @code
+* #include "mbed.h"
+* #include "toggle.h"
+*
+* Toggle pin(P1_24);
+*
+* main()
+* {
+*
+*    while(1) {
+*    
+*        pin.toggle(5);
+*        wait(1);
+*
+*    }
+*
+* }
+* @endcode
+*/
+
+
+class Toggle
+{
 public:
 
     /**
@@ -32,28 +38,22 @@
       *
       * @param pin  "pin" to toggle
       */
-    Togglen(PinName pin);
-
+    Toggle(PinName pin);
 
-    /**
-      * toggle destructor
-      */
-
-    ~Togglen();
 
     /**
     * Command to n times toggle the pin
     */
-    
-    void Toggle(int n);
-  
-private:  
+
+    void toggle(int n);
+
+private:
 
     /**
      * Set the Digital out pin
      */
-     
+
     DigitalOut _p;
 };
- 
+
 #endif
\ No newline at end of file