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

grovespeaker: header updated with new tags

Browse Source 
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
1 changed files with 24 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/grovespeaker/grovespeaker.h
View File

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