grovevdiv: header updated with new tags

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2015-04-10 14:35:50 -07:00
parent 1e45d8e712
commit a2e7609263

View File

@ -31,17 +31,28 @@
// ref voltage in millivolts // ref voltage in millivolts
#define GROVEVDIV_VREF 4980 #define GROVEVDIV_VREF 4980
// default ADC resolution. // default ADC resolution.
#define GROVEVDIV_ADC_RES 1024 #define GROVEVDIV_ADC_RES 1024
namespace upm { namespace upm {
/**
* @brief UPM library for the Grove Voltage Divider
* @defgroup grovevdiv libupm-grovevdiv
* @ingroup seeed analog electric
*/
/** /**
* @library grovevdiv
* @sensor grovevdiv
* @comname Grove Voltage Divider
* @type electric
* @man seeed
* @con analog
*
* @brief C++ API for the Grove Voltage Divider Sensor * @brief C++ API for the Grove Voltage Divider Sensor
* *
* UPM module for the Grove Voltage Divider Sensor * UPM module for the Grove Voltage Divider Sensor
* *
* @ingroup grove analog
* @snippet grovevdiv.cxx Interesting * @snippet grovevdiv.cxx Interesting
*/ */
class GroveVDiv { class GroveVDiv {
@ -76,12 +87,10 @@ namespace upm {
* *
* @return the measured voltage * @return the measured voltage
*/ */
float computedValue(uint8_t gain, uint16_t val, int vref=GROVEVDIV_VREF, float computedValue(uint8_t gain, uint16_t val, int vref=GROVEVDIV_VREF,
int res=GROVEVDIV_ADC_RES); int res=GROVEVDIV_ADC_RES);
private: private:
mraa_aio_context m_aio; mraa_aio_context m_aio;
}; };
} }