hmtrp: updated header with tags

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2015-04-13 12:04:54 -07:00
parent e714b0eb24
commit 6428f43599

View File

@ -43,30 +43,41 @@
#define HMTRP_DEFAULT_UART 0 #define HMTRP_DEFAULT_UART 0
namespace upm { namespace upm {
/**
* @brief HMTRP Serial RF Pro library
* @defgroup hmtrp libupm-hmtrp
* @ingroup seeed uart wifi
*/
/** /**
* @brief C++ API for the HMTRP Serial RF Pro * @library hmtrp
* * @sensor hmtrp
* UPM support for the HMTRP Serial RF Pro. This was tested * @comname Grove Serial RF Pro
* specifically with the Grove Serial RF Pro module. In theory, * @altname HMTRP-433 HMTRP-470 HMTRP-868 HMTRP-915
* this class should work with the following devices: * @type wifi
* * @man seeed
* HM-TRP-433: 414000000-454000000Hz * @con uart
* HM-TRP-470: 450000000-490000000Hz *
* HM-TRP-868: 849000000-889000000Hz * @brief C++ API for the HMTRP Serial RF Pro
* HM-TRP-915: 895000000-935000000Hz *
* * UPM support for the HMTRP Serial RF Pro. This was tested
* The only difference being the transmit and receive frequencies * specifically with the Grove Serial RF Pro module. In theory,
* supported. * this class should work with the following devices:
* *
* By default, the device will simply send and receive any data * HM-TRP-433: 414000000-454000000Hz
* presented on it's UART interface. It can be placed into a * HM-TRP-470: 450000000-490000000Hz
* configuration mode by grounding the CONFIG pin on the module. * HM-TRP-868: 849000000-889000000Hz
* * HM-TRP-915: 895000000-935000000Hz
* @ingroup grove uart radio *
* @defgroup hmtrp libupm-hmtrp * The only difference being the transmit and receive frequencies
* @snippet hmtrp.cxx Interesting * supported.
*/ *
* By default, the device will simply send and receive any data
* presented on it's UART interface. It can be placed into a
* configuration mode by grounding the CONFIG pin on the module.
*
* @snippet hmtrp.cxx Interesting
*/
class HMTRP { class HMTRP {
public: public: