Browse Source

buzzer: header update

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
Mihai Tudor Panu 9 years ago
parent
commit
1cf3f43db0
1 changed files with 11 additions and 2 deletions
  1. 11
    2
      src/buzzer/buzzer.h

+ 11
- 2
src/buzzer/buzzer.h View File

@@ -39,16 +39,25 @@ namespace upm {
39 39
 /**
40 40
  * @brief Buzzer library
41 41
  * @defgroup buzzer libupm-buzzer
42
+ * @ingroup seeed pwm sound
42 43
  */
43 44
 
44 45
 /**
46
+ * @library buzzer
47
+ * @sensor buzzer
48
+ * @comname Grove Buzzer
49
+ * @type sound
50
+ * @man seeed
51
+ * @con pwm
52
+ *
45 53
  * @brief C++ API for Buzzer component
46 54
  *
47 55
  * This file defines the Buzzer C++ interface for libbuzzer.
48 56
  * This sensor can make different tones when connected to
49
- * a pin capable of analog pulse-width modulation.
57
+ * a pin capable of analog pulse-width modulation. It emits 
58
+ * sound using a piezoelectric material that vibrates at different
59
+ * frequencies based on the input voltage.
50 60
  *
51
- * @ingroup buzzer pwm
52 61
  * @snippet buzzer-sound.cxx Interesting
53 62
  */
54 63
 class Buzzer {