mq303a: Adding doxygen comments and image from seeed wiki

Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
This commit is contained in:
John Van Drasek 2015-04-14 14:16:12 -07:00
parent 78f25b0157
commit f071ebe0ca
2 changed files with 14 additions and 1 deletions

BIN
docs/images/mq303a.jpg Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 185 KiB

View File

@ -29,6 +29,19 @@
namespace upm {
/**
* @brief mq303a Alcohol Sensor library
* @defgroup mq303a libupm-mq303a
* @ingroup seeed analog gpio gaseous
*/
/**
* @library libupm-mq303a
* @sensor mq303a
* @comname mq303a Alcohol Sensor
* @type gaseous
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_Alcohol_Sensor
* @con analog gpio
*
* @brief C++ API for the MQ303A Alcohol Sensor
*
* UPM module for the MQ303A Alcohol Sensor.
@ -36,7 +49,7 @@ namespace upm {
* obtained. The higher the value returned from value(),
* the higher the amount of alcohol that was detected.
*
* @ingroup analog gas alcohol
* @image html mq303a.jpg
* @snippet mq303a.cxx Interesting
*/
class MQ303A {