Browse Source

buzzer: documentation fixes

Signed-off-by: Sarah Knepper <sarah.knepper@intel.com>
Sarah Knepper 10 years ago
parent
commit
ddf32f9cb7
1 changed files with 11 additions and 5 deletions
  1. 11
    5
      src/buzzer/buzzer.h

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

@@ -44,15 +44,17 @@ namespace upm {
44 44
 /**
45 45
  * @brief C++ API for Buzzer component
46 46
  *
47
- * This file defines the Buzzer C++ interface for libbuzzer
47
+ * This file defines the Buzzer C++ interface for libbuzzer.
48
+ * This sensor can make different tones when connected to
49
+ * a pin capable of analog pulse-width modulation.
48 50
  *
49
- * @ingroup buzzer
51
+ * @ingroup buzzer pwm
50 52
  * @snippet buzzer-sound.cxx Interesting
51 53
  */
52 54
 class Buzzer {
53 55
     public:
54 56
         /**
55
-         * Instanciates a Buzzer object
57
+         * Instantiates a Buzzer object
56 58
          *
57 59
          * @param pinNumber Buzzer pin number
58 60
          */
@@ -64,15 +66,19 @@ class Buzzer {
64 66
         ~Buzzer ();
65 67
 
66 68
         /**
67
-         * Play chords.
69
+         * Play a tone for a certain amount of time.
68 70
          *
69
-         * @param note chords (DO, RE, ME, etc...)
71
+         * @param note the note to be played (DO, RE, MI, etc...)
70 72
          * @param delay time in microsec for playing the sound
73
+         *
74
+         * @return the note played
71 75
          */
72 76
         int playSound (int note, int delay);
73 77
 
74 78
         /**
75 79
          * Return name of the component
80
+         *
81
+         * @return name of the sensor
76 82
          */
77 83
         std::string name()
78 84
         {