From ddf32f9cb7c7265e10c1f3c10bb56a69f97c830d Mon Sep 17 00:00:00 2001
From: Sarah Knepper <sarah.knepper@intel.com>
Date: Tue, 20 Jan 2015 14:34:13 -0800
Subject: [PATCH] buzzer: documentation fixes

Signed-off-by: Sarah Knepper <sarah.knepper@intel.com>
---
 src/buzzer/buzzer.h | 16 +++++++++++-----
 1 file changed, 11 insertions(+), 5 deletions(-)

diff --git a/src/buzzer/buzzer.h b/src/buzzer/buzzer.h
index 3b8ea4b4..c5b5fb49 100644
--- a/src/buzzer/buzzer.h
+++ b/src/buzzer/buzzer.h
@@ -44,15 +44,17 @@ namespace upm {
 /**
  * @brief C++ API for Buzzer component
  *
- * This file defines the Buzzer C++ interface for libbuzzer
+ * This file defines the Buzzer C++ interface for libbuzzer.
+ * This sensor can make different tones when connected to
+ * a pin capable of analog pulse-width modulation.
  *
- * @ingroup buzzer
+ * @ingroup buzzer pwm
  * @snippet buzzer-sound.cxx Interesting
  */
 class Buzzer {
     public:
         /**
-         * Instanciates a Buzzer object
+         * Instantiates a Buzzer object
          *
          * @param pinNumber Buzzer pin number
          */
@@ -64,15 +66,19 @@ class Buzzer {
         ~Buzzer ();
 
         /**
-         * Play chords.
+         * Play a tone for a certain amount of time.
          *
-         * @param note chords (DO, RE, ME, etc...)
+         * @param note the note to be played (DO, RE, MI, etc...)
          * @param delay time in microsec for playing the sound
+         *
+         * @return the note played
          */
         int playSound (int note, int delay);
 
         /**
          * Return name of the component
+         *
+         * @return name of the sensor
          */
         std::string name()
         {