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: header update

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2015-04-09 11:15:36 -07:00
parent 090035bf1d
commit 1cf3f43db0
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/buzzer/buzzer.h
View File

@ -39,16 +39,25 @@ namespace upm {
/** /**
* @brief Buzzer library * @brief Buzzer library
* @defgroup buzzer libupm-buzzer * @defgroup buzzer libupm-buzzer
* @ingroup seeed pwm sound
*/ */
/** /**
* @library buzzer
* @sensor buzzer
* @comname Grove Buzzer
* @type sound
* @man seeed
* @con pwm
*
* @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 * This sensor can make different tones when connected to
* a pin capable of analog pulse-width modulation. * a pin capable of analog pulse-width modulation. It emits
* sound using a piezoelectric material that vibrates at different
* frequencies based on the input voltage.
* *
* @ingroup buzzer pwm
* @snippet buzzer-sound.cxx Interesting * @snippet buzzer-sound.cxx Interesting
*/ */
class Buzzer { class Buzzer {