Diff: beep.h

Revision:

3:5a8242af60ba

Parent:

1:ddccf0a4a414

diff -r a34405c20cf5 -r 5a8242af60ba beep.h
--- a/beep.h	Tue Feb 01 19:17:44 2011 +0000
+++ b/beep.h	Wed Feb 02 22:38:30 2011 +0000
@@ -4,23 +4,23 @@
 #include "mbed.h"
 
 /** class to make sound with a buzzer, based on a PwmOut
-*   The class use a timeout to switch off the sound  - it is not blocking while making noise
-*
-* Example:
-* @code
-* // Beep with 1Khz for 0.5 seconds
-* #include "mbed.h"
-* #include "beep.h"
-* 
-* Beep buzzer(p21);
-* 
-* int main() {
-*       ...
-*   buzzer.beep(1000,0.5);    
-*       ...
-* }
-* @endcode
-*/
+ *   The class use a timeout to switch off the sound  - it is not blocking while making noise
+ *
+ * Example:
+ * @code
+ * // Beep with 1Khz for 0.5 seconds
+ * #include "mbed.h"
+ * #include "beep.h"
+ * 
+ * Beep buzzer(p21);
+ * 
+ * int main() {
+ *        ...
+ *   buzzer.beep(1000,0.5);    
+ *       ...
+ * }
+ * @endcode
+ */
 
 
 namespace mbed {
@@ -32,22 +32,22 @@
 
 public:
 
-    /** Create a Beep object connected to the specified PwmOut pin
-    *
-    * @param pin PwmOut pin to connect to 
-    */
+/** Create a Beep object connected to the specified PwmOut pin
+ *
+ * @param pin PwmOut pin to connect to 
+ */
     Beep (PinName pin);
 
-    /** Beep with given frequency and duration.
-     *
-     * @param frequency - the frequency of the tone in Hz
-     * @param time - the duration of the tone in seconds
-     */
+/** Beep with given frequency and duration.
+ *
+ * @param frequency - the frequency of the tone in Hz
+ * @param time - the duration of the tone in seconds
+ */
     void beep (float frequency, float time);
 
-    /** stop the beep instantaneous 
-    * usually not used 
-    */
+/** stop the beep instantaneous 
+ * usually not used 
+ */
     void nobeep();
 
 private :