pooja arawal / Blinker

Simple library for LED blinking.

Fork of Blinker by TVZ Mechatronics Team

Files at this revision

API Documentation at this revision

Revision 1:ea5bb72717cc, committed 2014-12-16

Comitter:
tbjazic
Date:
Tue Dec 16 09:25:44 2014 +0000
Parent:
0:c9a302c4bed9
Child:
2:190915d53c0b
Commit message:
Simple documentation added

Changed in this revision

Blinker.h Show annotated file Show diff for this revision Revisions of this file 
--- a/Blinker.h	Tue Dec 16 08:57:47 2014 +0000
+++ b/Blinker.h	Tue Dec 16 09:25:44 2014 +0000
@@ -3,6 +3,23 @@
 
 #include "mbed.h"
 
+/** Simple class for learning development of libraries.
+ * 
+ * Author: TVZ Mechatronics Team
+ *
+ * Example of use:
+ * @code
+ * #include "mbed.h"
+ * #include "Blinker.h"
+ *
+ * int main() {
+ *    Blinker mojBlinker(LED3);
+ *    mojBlinker.blink(10);
+ *    wait(2);
+ *    mojBlinker.blink(5, 0.5);
+ * }
+ * @endcode
+ */
 class Blinker {
 private:
     DigitalOut myled;