From 1cf3f43db0f9f0c4ce52c028d1009d597913df32 Mon Sep 17 00:00:00 2001 From: Mihai Tudor Panu Date: Thu, 9 Apr 2015 11:15:36 -0700 Subject: [PATCH] buzzer: header update Signed-off-by: Mihai Tudor Panu --- src/buzzer/buzzer.h | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/src/buzzer/buzzer.h b/src/buzzer/buzzer.h index aee6d8f4..e3eb6172 100644 --- a/src/buzzer/buzzer.h +++ b/src/buzzer/buzzer.h @@ -39,16 +39,25 @@ namespace upm { /** * @brief Buzzer library * @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 * * 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. + * 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 */ class Buzzer {