Diff: DebouncedInterrupt.h

Revision:

15:948e85b22efe

Parent:

14:da09706b92f5

Child:

16:7eaa188de0f9

--- a/DebouncedInterrupt.h	Tue Feb 18 17:26:42 2014 +0000
+++ b/DebouncedInterrupt.h	Tue Feb 18 20:18:12 2014 +0000
@@ -1,25 +1,27 @@
-/**
-* DebouncedInterrupt.h
-* Monitors and debounces an InterruptIn
-**/
 
-/**
-Example:
-DebouncedInterrupt up_button(p15);
-
-void onUp()
-{
-    // Do Something
-}
-
-int main()
-{
-    up_button.attach(&onUp, INT_FALL, 100);
-    while(1) {
-        ...
-    }
-}
-**/
+/** A replacement for InterruptIn that debounces the interrupt
+ *  Anil Kandangath
+ *
+ * @code
+ *
+ * #include "DebouncedInterrupt.h"
+ *
+ * DebouncedInterrupt up_button(p15);
+ * 
+ * void onUp()
+ * {
+ *    // Do Something
+ * }
+ * 
+ * int main()
+ * {
+ *     up_button.attach(&onUp, INT_FALL, 100);
+ *     while(1) {
+ *         ...
+ *     }
+ * }
+ * @endcode
+ */
  
 #ifndef DEBOUNCED_INTERRUPT_H
 #define DEBOUNCED_INTERRUPT_H