doxygen: Added documentation to Buzzer sensor

Signed-off-by: Kiveisha Yevgeniy <yevgeniy.kiveisha@intel.com>
This commit is contained in:
Kiveisha Yevgeniy
2014-06-10 06:54:45 +00:00
parent 864306acf5
commit 236cc9acc1
2 changed files with 31 additions and 1 deletions

View File

@ -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;