Diff: beep.h

Revision:

1:ddccf0a4a414

Parent:

0:18e4a9c978ec

Child:

3:5a8242af60ba

diff -r 18e4a9c978ec -r ddccf0a4a414 beep.h
--- a/beep.h	Tue Feb 01 18:44:45 2011 +0000
+++ b/beep.h	Tue Feb 01 19:08:44 2011 +0000
@@ -3,6 +3,26 @@
 
 #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
+*/
+
+
 namespace mbed {
 
 /* Class: Beep
@@ -12,23 +32,22 @@
 
 public:
 
-    /* Constructor: Beep
-     *  Creates a new beeper object.
-     *
-     * Variables:
-     *  pin - The pin which is connected to the beeper.
-     */
+    /** Create a Beep object connected to the specified PwmOut pin
+    *
+    * @param pin PwmOut pin to connect to 
+    */
     Beep (PinName pin);
 
-    /* Function: beep
-     *  Beep with given frequency and duration.
+    /** Beep with given frequency and duration.
      *
-     * Variables:
-     *  frequency - The frequency to use.
-     *  time - The turation to beep.
+     * @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 
+    */
     void nobeep();
 
 private :