grovespeaker: header updated with new tags

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2015-04-10 14:33:34 -07:00
parent d932fa606f
commit 1e45d8e712

View File

@ -32,7 +32,11 @@
#define LOW 0
namespace upm {
/**
* @brief UPM library for the Grove Speaker
* @defgroup grovespeaker libupm-grovespeaker
* @ingroup seeed gpio sound
*/
typedef struct
{
int delayTimeLow;
@ -42,15 +46,20 @@ typedef struct
int delayTimeHigh;
int delayTimeHighSharp;
} NoteData;
/**
* @library grovespeaker
* @sensor grovespeaker
* @comname Grove Speaker
* @type sound
* @man seeed
* @con gpio
*
* @brief C++ API for the GroveSpeaker speaker
*
* UPM module for the GroveSpeaker.
* This sensor can generate different tones and sounds depending on the
* frequency of the input signal.
*
* @ingroup gpio
* @snippet grovespeaker.cxx Interesting
*/
class GroveSpeaker {
@ -90,5 +99,3 @@ typedef struct
int noteDelayHigh, int noteDelayHighSharp);
};
}