doxygen: Added documentation to Buzzer sensor

Signed-off-by: Kiveisha Yevgeniy <yevgeniy.kiveisha@intel.com>

diff --git a/examples/buzzer-sound.cxx b/examples/buzzer-sound.cxx
index 3941c3e..a3a5377 100644 (file)
--- a/examples/buzzer-sound.cxx
+++ b/examples/buzzer-sound.cxx
@@ -43,6 +43,8 @@ sig_handler(int signo)
 int
 main(int argc, char **argv) {
     int chord[] = { DO, RE, MI, FA, SOL, LA, SI, DO, SI };
+
+    //! [Interesting]
     // create Buzzer instance
     upm::Buzzer* sound = new upm::Buzzer(5);
     // print sensor name
@@ -57,10 +59,11 @@ main(int argc, char **argv) {
             usleep(1000);
         }
     }
+    //! [Interesting]
 
     std::cout << "exiting application" << std::endl;
 
     delete sound;
-    
+
     return 0;
 }

diff --git a/src/buzzer/buzzer.h b/src/buzzer/buzzer.h
index 0a3ac1c..70d578e 100644 (file)
--- a/src/buzzer/buzzer.h
+++ b/src/buzzer/buzzer.h
@@ -36,11 +36,38 @@
 
 namespace upm {
 
+/**
+ * @brief C++ API for Buzzer servo component
+ *
+ * This file defines the Buzzer C++ interface for libbuzzer
+ *
+ * @snippet es08a.cxx Interesting
+ *
+ */
 class Buzzer {
     public:
+        /**
+         * Instanciates a Buzzer object
+         *
+         * @param pin Buzzer pin number
+         */
         Buzzer (int pinNumber);
+
+        /**
+         * Buzzer object destructor.
+         */
         ~Buzzer ();
+
+        /**
+         * Play chords.
+         *
+         * @param note chords (DO, RE, ME, etc...)
+         */
         int playSound (int note);
+
+        /**
+         * Return name of the component
+         */
         std::string name()
         {
             return m_name;