Matthew Shuman / Mbed 2 deprecated Lab1TestAdvanced3

Example showing comments.

Dependencies:   mbed

Fork of Lab1TestAdvanced3 by Matthew Shuman

Files at this revision

API Documentation at this revision

Revision 1:94789e770417, committed 2016-08-13

Comitter:
mattshuman
Date:
Sat Aug 13 08:26:42 2016 +0000
Parent:
0:fbca7accb93b
Commit message:
Updated the documentation on the blink method.

Changed in this revision

Blinker.h Show annotated file Show diff for this revision Revisions of this file 
--- a/Blinker.h	Sat Aug 13 01:47:43 2016 +0000
+++ b/Blinker.h	Sat Aug 13 08:26:42 2016 +0000
@@ -23,7 +23,12 @@
 public:
     Blinker(void) {
     };
-// class method to blink and LED based on the PwmOut class
+
+/**
+     * @param outputLED selects the PwmOut that should be connected to the LED.
+     * @param frequency is the rate at which the LED blinks, in Hertz.
+     * @param brightness is the brightness of the LED, ranging between 0.00 and 1.00.
+     */
     void blink(PwmOut outputLED, float frequency, float brightness) {
         outputLED.period(.001f);
         outputLED = 1- brightness;