alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-03-24 01:10:22 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

buzzer: documentation fixes

Browse Source 
Signed-off-by: Sarah Knepper <sarah.knepper@intel.com>
This commit is contained in:
Sarah Knepper 2015-01-20 14:34:13 -08:00
parent 063abf7163
commit ddf32f9cb7
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/buzzer/buzzer.h
View File

@ -44,15 +44,17 @@ namespace upm {
/** /**
* @brief C++ API for Buzzer component * @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 * @snippet buzzer-sound.cxx Interesting
*/ */
class Buzzer { class Buzzer {
public: public:
/** /**
* Instanciates a Buzzer object * Instantiates a Buzzer object
* *
* @param pinNumber Buzzer pin number * @param pinNumber Buzzer pin number
*/ */
@ -64,15 +66,19 @@ class Buzzer {
~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 * @param delay time in microsec for playing the sound
*
* @return the note played
*/ */
int playSound (int note, int delay); int playSound (int note, int delay);
/** /**
* Return name of the component * Return name of the component
*
* @return name of the sensor
*/ */
std::string name() std::string name()
{ {