upm-c: added doxygen tags to generate documentation for C APIs

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu
2016-09-26 17:28:21 -07:00
parent 73719a6659
commit eb7a3ceac7
43 changed files with 265 additions and 356 deletions

View File

@ -30,29 +30,11 @@
#include "mraa/gpio.h"
/**
* @brief MQ303A Alcohol Sensor library
* @defgroup mq303a libupm-mq303a
* @ingroup analog gpio gaseous tsk
*/
/**
* @library mq303a
* @sensor mq303a
* @comname MQ303A Alcohol Sensor
* @type gaseous
* @man seeed
* @web http://www.seeedstudio.com/document/pdf/MQ303A.pdf
* @con analog gpio
* @kit tsk
* @file mq303a.h
* @library mq303
* @brief C API for the MQ303A Alcohol Sensor
*
* @brief API for the MQ303A Alcohol Sensor
*
* UPM module for the MQ303A alcohol sensor.
* This sensor needs to be warmed up before stable results are
* obtained. The higher the value returned from value(),
* the higher the amount of alcohol detected.
*
* @image html mq303a.jpg
* @snippet mq303a.cxx Interesting
* @include mq303.c
*/
/**