Diff: Ka.h

Revision:

2:14bfd1fc2163

Parent:

0:2270b7a3a8ad

--- a/Ka.h	Thu Nov 16 15:51:43 2017 +0000
+++ b/Ka.h	Sun Jan 21 21:59:04 2018 +0000
@@ -1,10 +1,21 @@
 #ifndef Ka_FILE
 #define Ka_FILE
+#include "mbed.h"
 
-#include "mbed.h"
-/** Ka class. 
-* Lab assignment for manipulating led0 
-*/
+/** My led class.
+ *  Used for manipulating led light on the EFM32 Happy Gecko
+ *
+ * Example: Setting the led ON
+ * @code
+ * #include "mbed.h"
+ * #include "Ka.h"
+ * 
+ * int main() {
+ *     Ka obj; 
+ *     obj.set_led0();
+ * }
+ * @endcode
+ */
 class Ka{    
     public : 
     /**  Constructor binds a object made from the Ka class to digitalout from mbed library
@@ -16,8 +27,8 @@
     void clear_led0();  
     /** Function for inverting led0 (on to off, off to on) */ 
     void invert();  
-    /** Function for making led0 blink X amount seconds */
-    void toggle (int a);  
+    /** Function for making led0 blink. Takes amount of blink seconds as parameter*/
+    void blinker (int a);  
     
     private:
     DigitalOut m;