Flasher class is useful to flash a pin for a given #n of times
Revision 1:777003f7824d, committed 2013-12-07
- Comitter:
- biank88
- Date:
- Sat Dec 07 17:05:09 2013 +0000
- Parent:
- 0:8eb512b1d1ed
- Commit message:
- doc added
Changed in this revision
| Flasher.h | Show annotated file Show diff for this revision Revisions of this file |
diff -r 8eb512b1d1ed -r 777003f7824d Flasher.h
--- a/Flasher.h Sat Dec 07 16:31:21 2013 +0000
+++ b/Flasher.h Sat Dec 07 17:05:09 2013 +0000
@@ -2,10 +2,34 @@
#define FLASHER_H
#include "mbed.h"
-
+
+/**Flasher class
+ * Used to flash a pin # times
+ *
+ * Example:
+ * @code
+ * #include "mbed.h"
+ * #include "Flasher.h"
+ *
+ * Flasher led(LED2);
+ *
+ * int main() {
+ * led.flash(5); //flash LED2 5 times
+ * }
+ * @endcode
+ */
class Flasher {
public:
+ /**Create Flasher instance
+ *
+ *@param pin Mbed pin reference
+ */
Flasher(PinName pin);
+
+ /**Flash method
+ *
+ *@param n Number of flashes to perform
+ */
void flash(int n);
private: