Diff: buzzer.h

Revision:

2:857083873b09

Parent:

1:622b1d533a1c

--- a/buzzer.h	Thu May 05 14:17:20 2016 +0000
+++ b/buzzer.h	Thu Nov 19 10:41:25 2020 +0000
@@ -2,50 +2,17 @@
 #define MBED_BEEP_H
  
 #include "mbed.h"
-/**
-@namespace Beep Library 
-@brief Contains member functions for the speaker funtion that allow for sending of frequency of sounds and duration through pwm
-@Author Peter Drescher (I do not own the rights to this library and it has been rightly attributed to its owner
-@Revision 2012 
 
-**/
-
-
- 
-/** class to make sound with a buzzer, roughly based on a library created by Peter Drescher 
- *   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 "buzzer.h"
- * 
- * Beep buzzer(PTC2);
- * 
- * int main() {
- *        ...
- *   buzzer.beep(1000,0.5);    
- *       ...
- * }
- * @endcode
- */
- 
- 
 namespace mbed {
  
 /* Class: Beep
- *  A class witch uses pwm to controle a beeper to generate sounds.
+ *  A class which uses pwm to controle a beeper to generate sounds.
  */
 class Beep {
  
 public:
  
-/** Create a Beep object connected to the specified PwmOut pin
- *
- * @param pin PwmOut pin to connect to 
- */
-    Beep (PinName pin);
+    Beep (PinName pin);//Specified PwmOut pin for buzzer
  
 /** Beep with given frequency and duration.
  *
@@ -54,9 +21,6 @@
  */
     void beep (float frequency, float time);
  
-/** stop the beep instantaneous 
- * usually not used 
- */
     void nobeep();
  
 private :