doxygen: removed library to group name conflicts from new generic classes

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2016-09-19 17:25:36 -07:00
parent 06547dcd07
commit e08b97ff85
6 changed files with 24 additions and 23 deletions

View File

@ -33,16 +33,16 @@ namespace upm {
/** /**
* @brief Button library * @brief Button library
* @defgroup button libupm-button * @defgroup buttonlib libupm-button
* @ingroup seeed gpio button touch gsk * @ingroup seeed gpio button gsk
*/ */
/** /**
* @library button * @library buttonlib
* @sensor button * @sensor button
* @comname Button * @comname Button
* @altname Grove Touch Sensor * @altname Grove Button
* @type button touch * @type button
* @man seeed * @man seeed
* @con gpio * @con gpio
* @kit gsk * @kit gsk

View File

@ -32,13 +32,13 @@
namespace upm { namespace upm {
/** /**
* @brief Led Sensor library * @brief LED library
* @defgroup led libupm-led * @defgroup ledlib libupm-led
* @ingroup seeed gpio led gsk * @ingroup seeed gpio led gsk
*/ */
/** /**
* @library led * @library ledlib
* @sensor led * @sensor led
* @comname LED * @comname LED
* @altname Grove LED * @altname Grove LED

View File

@ -38,13 +38,13 @@ namespace upm {
/** /**
* @brief MAX31723 Temperature Sensor library * @brief MAX31723 Temperature Sensor library
* @defgroup max31723 libupm-max31723 * @defgroup max31723 libupm-max31723
* @ingroup maxim spi temperature * @ingroup maxim spi temp
*/ */
/** /**
* @library max31723 * @library max31723
* @sensor max31723 * @sensor max31723
* @comname MAX31723 Temperature Sensor * @comname MAX31723 Temperature Sensor
* @type temperature * @type temp
* @man maxim * @man maxim
* @con spi * @con spi
* *

View File

@ -55,13 +55,13 @@ namespace upm {
/** /**
* @brief MLX90614 Temperature Sensor library * @brief MLX90614 Temperature Sensor library
* @defgroup mlx90614 libupm-mlx90614 * @defgroup mlx90614 libupm-mlx90614
* @ingroup generic i2c temperature * @ingroup generic i2c temp
*/ */
/** /**
* @library mlx90614 * @library mlx90614
* @sensor mlx90614 * @sensor mlx90614
* @comname MLX90614 Temperature Sensor * @comname MLX90614 Temperature Sensor
* @type temperature * @type temp
* @man generic * @man generic
* @con i2c * @con i2c
* *

View File

@ -31,13 +31,13 @@
namespace upm { namespace upm {
/** /**
* @brief relay sensor library * @brief Relay library
* @defgroup relay libupm-relay * @defgroup relaylib libupm-relay
* @ingroup seeed gpio relay gsk eak hak * @ingroup seeed gpio relay gsk eak hak
*/ */
/** /**
* @library relay * @library relaylib
* @sensor relay * @sensor relay
* @comname Relay * @comname Relay
* @altname Grove Relay * @altname Grove Relay
@ -48,10 +48,10 @@ namespace upm {
* *
* @brief API for the Relay * @brief API for the Relay
* *
* UPM module for the relay switch. The relay is a * UPM module for the relay switch. The relay is a digital normally-open
* digital normally-open switch that uses low voltage or current to * switch that uses low voltage or current to control a higher voltage and/or
* control a higher voltage and/or higher current. When closed, * higher current. When closed, the indicator LED (if present) lights up and
* the indicator LED lights up and current is allowed to flow. * current is allowed to flow.
* *
* @image html relay.jpg * @image html relay.jpg
* @snippet relay.cxx Interesting * @snippet relay.cxx Interesting

View File

@ -48,10 +48,11 @@ namespace upm {
* @brief API for the Grove Temperature Sensor * @brief API for the Grove Temperature Sensor
* *
* Basic UPM module for the Grove temperature sensor on analog. This sensor * Basic UPM module for the Grove temperature sensor on analog. This sensor
* uses a thermistor to measure ambient temperature. The conversion formula has * uses a NTC thermistor to measure ambient temperature. The conversion formula
* been updated to work with versions 1.1 and 1.2 of the sensor. For the older * has been updated to work with versions 1.1 and 1.2 of the sensor. For the
* v1.0 sensor you will have to specify R0 and B values when initializing the * older v1.0 sensor you will have to specify R0 and B values when initializing
* device. The range of this sensor is -40 to 125 C and accuracy is +/- 1.5 C. * the device. The range of this sensor is -40 to 125 C and accuracy is +/- 1.5
* C.
* *
* @image html temp.jpg * @image html temp.jpg
* @snippet temperature.cxx Interesting * @snippet temperature.cxx Interesting