alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-03-15 04:57:30 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

wt5001.h: adding doxygen tags

Browse Source 
Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
This commit is contained in:
John Van Drasek 2015-03-20 15:51:56 -07:00
parent 5c16dd44a7
commit fa4dabf173
1 changed files with 25 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
src/wt5001/wt5001.h
View File

@ -48,16 +48,31 @@ const uint8_t WT5001_START = 0x7e;
const uint8_t WT5001_END = 0x7e;
namespace upm {
/**
* @brief C++ API for the WT5001 Serial MP3 module
*
* UPM support for the WT5001 Serial MP3 Module. This was tested
* specifically with the Grove Serial MP3 module.
*
* @ingroup grove uart
* @snippet wt5001.cxx Interesting
*/
/**
* @brief C++ API for the WT5001 Serial MP3 module
*
* UPM support for the WT5001 Serial MP3 Module. This was tested
* specifically with the Grove Serial MP3 module.
*
* @defgroup wt5001 libupm-wt5001
* @ingroup seeed uart sound
*/
/**
* @library wt5001
* @sensor wt5001
* @comname Serial MP3 Module
* @type sound
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_%E2%80%93_Serial_MP3_Player
* @con uart
*
* @brief C++ API for the WT5001 Serial MP3 module
*
* UPM support for the WT5001 Serial MP3 Module. This was tested
* specifically with the Grove Serial MP3 module.
*
* @snippet wt5001.cxx Interesting
*/
class WT5001 {
public: