Browse Source

wt5001.h: adding doxygen tags

Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
John Van Drasek 10 years ago
parent
commit
fa4dabf173
1 changed files with 25 additions and 10 deletions
  1. 25
    10
      src/wt5001/wt5001.h

+ 25
- 10
src/wt5001/wt5001.h View File

@@ -48,16 +48,31 @@ const uint8_t WT5001_START = 0x7e;
48 48
 const uint8_t WT5001_END   = 0x7e;
49 49
 
50 50
 namespace upm {
51
-
52
-  /**
53
-   * @brief C++ API for the WT5001 Serial MP3 module
54
-   *
55
-   * UPM support for the WT5001 Serial MP3 Module.  This was tested
56
-   * specifically with the Grove Serial MP3 module.
57
-   *
58
-   * @ingroup grove uart
59
-   * @snippet wt5001.cxx Interesting
60
-   */
51
+    /**
52
+     * @brief C++ API for the WT5001 Serial MP3 module
53
+     *
54
+     *   UPM support for the WT5001 Serial MP3 Module.  This was tested
55
+     *   specifically with the Grove Serial MP3 module.
56
+     *
57
+     * @defgroup wt5001 libupm-wt5001
58
+     * @ingroup seeed uart sound
59
+     */
60
+    /**
61
+     * @library wt5001
62
+     * @sensor wt5001
63
+     * @comname Serial MP3 Module
64
+     * @type sound
65
+     * @man seeed
66
+     * @web http://www.seeedstudio.com/wiki/Grove_%E2%80%93_Serial_MP3_Player
67
+     * @con uart
68
+     *
69
+     * @brief C++ API for the WT5001 Serial MP3 module
70
+     * 
71
+     *   UPM support for the WT5001 Serial MP3 Module.  This was tested
72
+     *   specifically with the Grove Serial MP3 module.
73
+     *
74
+     * @snippet wt5001.cxx Interesting
75
+     */
61 76
   class WT5001 {
62 77
   public:
63 78