Diff: Pulsator.h

Revision:

1:bcddb9898625

Parent:

0:dda7f6f55dc1

Child:

5:26cc18306d95

--- a/Pulsator.h	Fri Apr 24 03:56:51 2015 +0000
+++ b/Pulsator.h	Fri Apr 24 05:14:06 2015 +0000
@@ -1,3 +1,21 @@
+/* Copyright (c) 2015 Liyang HU, MIT License
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software 
+ * and associated documentation files (the "Software"), to deal in the Software without restriction, 
+ * including without limitation the rights to use, copy, modify, merge, publish, distribute, 
+ * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is 
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or 
+ * substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING 
+ * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, 
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
 #include <mbed.h>
 #include <PwmOut.h>
 
@@ -6,7 +24,7 @@
 private:
     PwmOut out;
     Ticker ticker;
-    float phase_2; // phase / 2
+    float phase_2; //!< \a phase / 2
 
     const float period;
     const bool active_high;
@@ -19,5 +37,5 @@
 
 public:
     Pulsator(PinName pin = LED1, float period = 1.0, bool active_high = true, float gamma = 2.2, int levels = 32);
-    Pulsator& operator =(bool state);
+    Pulsator& operator=(bool state);
 };