tm1637.h: adding doxygen tags

Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
This commit is contained in:
John Van Drasek 2015-03-20 16:58:24 -07:00
parent 55c8ec0395
commit 8388a2867a

View File

@ -45,20 +45,26 @@
#define LOW 0 #define LOW 0
namespace upm { namespace upm {
/**
/**
* @brief tm1637 7-segment screen library
* @defgroup tm1637 libupm-tm1637
*/
/**
* @brief C++ API for Seven segments screen * @brief C++ API for Seven segments screen
* *
* This file defines the TM1637 C++ interface for lib4digitdisplay * This file defines the TM1637 C++ interface for lib4digitdisplay
* *
* @ingroup tm1637 gpio * @defgroup tm1637 libupm-tm1637
* @snippet tm1637.cxx Interesting * @ingroup seeed gpio display
*/
/**
* @library tm1637
* @sensor tm1637
* @comname Seven segment screen display
* @type display
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_4-Digit_Display
* @con gpio
* *
* @brief C++ API for Seven segments screen
*
* This file defines the TM1637 C++ interface for lib4digitdisplay
* A * A
* --- * ---
* F | | B * F | | B
@ -67,6 +73,7 @@ namespace upm {
* --- * ---
* D * D
* *
* @snippet tm1637.cxx Interesting
*/ */
class TM1637 { class TM1637 {
public: public: