diff --git a/src/button/button.hpp b/src/button/button.hpp index bf582a6f..e59c4b99 100644 --- a/src/button/button.hpp +++ b/src/button/button.hpp @@ -33,16 +33,16 @@ namespace upm { /** * @brief Button library - * @defgroup button libupm-button - * @ingroup seeed gpio button touch gsk + * @defgroup buttonlib libupm-button + * @ingroup seeed gpio button gsk */ /** - * @library button + * @library buttonlib * @sensor button * @comname Button - * @altname Grove Touch Sensor - * @type button touch + * @altname Grove Button + * @type button * @man seeed * @con gpio * @kit gsk diff --git a/src/led/led.hpp b/src/led/led.hpp index 64e21420..693451f1 100644 --- a/src/led/led.hpp +++ b/src/led/led.hpp @@ -32,13 +32,13 @@ namespace upm { /** - * @brief Led Sensor library - * @defgroup led libupm-led + * @brief LED library + * @defgroup ledlib libupm-led * @ingroup seeed gpio led gsk */ /** - * @library led + * @library ledlib * @sensor led * @comname LED * @altname Grove LED diff --git a/src/max31723/max31723.hpp b/src/max31723/max31723.hpp index 9aaaca23..f71c4be6 100644 --- a/src/max31723/max31723.hpp +++ b/src/max31723/max31723.hpp @@ -38,13 +38,13 @@ namespace upm { /** * @brief MAX31723 Temperature Sensor library * @defgroup max31723 libupm-max31723 - * @ingroup maxim spi temperature + * @ingroup maxim spi temp */ /** * @library max31723 * @sensor max31723 * @comname MAX31723 Temperature Sensor - * @type temperature + * @type temp * @man maxim * @con spi * diff --git a/src/mlx90614/mlx90614.hpp b/src/mlx90614/mlx90614.hpp index 0cfe27ce..e742ed52 100644 --- a/src/mlx90614/mlx90614.hpp +++ b/src/mlx90614/mlx90614.hpp @@ -55,13 +55,13 @@ namespace upm { /** * @brief MLX90614 Temperature Sensor library * @defgroup mlx90614 libupm-mlx90614 - * @ingroup generic i2c temperature + * @ingroup generic i2c temp */ /** * @library mlx90614 * @sensor mlx90614 * @comname MLX90614 Temperature Sensor - * @type temperature + * @type temp * @man generic * @con i2c * diff --git a/src/relay/relay.hpp b/src/relay/relay.hpp index 305806b3..37e2b437 100644 --- a/src/relay/relay.hpp +++ b/src/relay/relay.hpp @@ -31,13 +31,13 @@ namespace upm { /** - * @brief relay sensor library - * @defgroup relay libupm-relay + * @brief Relay library + * @defgroup relaylib libupm-relay * @ingroup seeed gpio relay gsk eak hak */ /** - * @library relay + * @library relaylib * @sensor relay * @comname Relay * @altname Grove Relay @@ -48,10 +48,10 @@ namespace upm { * * @brief API for the Relay * - * UPM module for the relay switch. The relay is a - * digital normally-open switch that uses low voltage or current to - * control a higher voltage and/or higher current. When closed, - * the indicator LED lights up and current is allowed to flow. + * UPM module for the relay switch. The relay is a digital normally-open + * switch that uses low voltage or current to control a higher voltage and/or + * higher current. When closed, the indicator LED (if present) lights up and + * current is allowed to flow. * * @image html relay.jpg * @snippet relay.cxx Interesting diff --git a/src/temperature/temperature.hpp b/src/temperature/temperature.hpp index 9045bdc8..a08a2a7a 100644 --- a/src/temperature/temperature.hpp +++ b/src/temperature/temperature.hpp @@ -48,10 +48,11 @@ namespace upm { * @brief API for the Grove Temperature Sensor * * Basic UPM module for the Grove temperature sensor on analog. This sensor - * uses a thermistor to measure ambient temperature. The conversion formula has - * been updated to work with versions 1.1 and 1.2 of the sensor. For the older - * v1.0 sensor you will have to specify R0 and B values when initializing the - * device. The range of this sensor is -40 to 125 C and accuracy is +/- 1.5 C. + * uses a NTC thermistor to measure ambient temperature. The conversion formula + * has been updated to work with versions 1.1 and 1.2 of the sensor. For the + * older v1.0 sensor you will have to specify R0 and B values when initializing + * the device. The range of this sensor is -40 to 125 C and accuracy is +/- 1.5 + * C. * * @image html temp.jpg * @snippet temperature.cxx Interesting