diff --git a/src/a110x/a110x.hpp b/src/a110x/a110x.hpp index fb5ca86a..71a0d784 100644 --- a/src/a110x/a110x.hpp +++ b/src/a110x/a110x.hpp @@ -28,7 +28,7 @@ namespace upm { /** - * @brief A110X Hall Effect library + * @brief A110X Hall Effect Sensors * @defgroup a110x libupm-a110x * @ingroup seeed gpio electric robok */ diff --git a/src/abp/abp.hpp b/src/abp/abp.hpp index e2e434fa..f1c407ee 100644 --- a/src/abp/abp.hpp +++ b/src/abp/abp.hpp @@ -28,6 +28,7 @@ namespace upm { /** + * @brief Honeywell ABP Pressure Sensors * @defgroup abp libupm-abp * @ingroup honeywell i2c */ diff --git a/src/ad8232/ad8232.hpp b/src/ad8232/ad8232.hpp index 8b60b52c..136514a6 100644 --- a/src/ad8232/ad8232.hpp +++ b/src/ad8232/ad8232.hpp @@ -35,9 +35,9 @@ namespace upm { /** - * @brief AD8232 Heart Rate Monitor library + * @brief AD8232 Heart Rate Monitor * @defgroup ad8232 libupm-ad8232 - * @ingroup sparkfun gpio medical + * @ingroup sparkfun gpio analog medical */ /** @@ -47,7 +47,7 @@ namespace upm { * @type medical * @man sparkfun * @web https://www.sparkfun.com/products/12650 - * @con gpio aio + * @con gpio analog * * @brief UPM module for the AD8232 Heart Rate Monitor * diff --git a/src/adafruitms1438/adafruitms1438.hpp b/src/adafruitms1438/adafruitms1438.hpp index d2895d15..30a1eee0 100644 --- a/src/adafruitms1438/adafruitms1438.hpp +++ b/src/adafruitms1438/adafruitms1438.hpp @@ -38,7 +38,7 @@ namespace upm { /** - * @brief Adafruit Motor Shield 1438 library + * @brief Adafruit Motor Shield * @defgroup adafruitms1438 libupm-adafruitms1438 * @ingroup adafruit i2c motor */ diff --git a/src/adafruitss/adafruitss.hpp b/src/adafruitss/adafruitss.hpp index e9dbb75c..bc1e531b 100644 --- a/src/adafruitss/adafruitss.hpp +++ b/src/adafruitss/adafruitss.hpp @@ -55,7 +55,7 @@ namespace upm { /** - * @brief Adafruit PCA9685-based Servo Shield library + * @brief Adafruit PCA9685-based Servo Shield * @defgroup adafruitss libupm-adafruitss * @ingroup adafruit i2c servos */ diff --git a/src/adc121c021/adc121c021.hpp b/src/adc121c021/adc121c021.hpp index 7585f2f9..7a8ff6fe 100644 --- a/src/adc121c021/adc121c021.hpp +++ b/src/adc121c021/adc121c021.hpp @@ -49,7 +49,7 @@ namespace upm { /** - * @brief ADC121C021 I2C Analog-to-Digital Converter library + * @brief ADC121C021 Analog-to-Digital Converter * @defgroup adc121c021 libupm-adc121c021 * @ingroup seeed i2c electric */ diff --git a/src/adis16448/adis16448.hpp b/src/adis16448/adis16448.hpp index bd277dc1..c662ab3d 100644 --- a/src/adis16448/adis16448.hpp +++ b/src/adis16448/adis16448.hpp @@ -84,7 +84,7 @@ namespace upm { /** - * @brief ADIS16448 Accelerometer library + * @brief ADIS16448 Accelerometer * @defgroup adis16448 libupm-adis16448 * @ingroup generic spi accelerometer */ diff --git a/src/ads1x15/ads1x15.hpp b/src/ads1x15/ads1x15.hpp index efd8c8ec..69f8412c 100644 --- a/src/ads1x15/ads1x15.hpp +++ b/src/ads1x15/ads1x15.hpp @@ -102,7 +102,7 @@ namespace mraa {class I2c;} namespace upm { /** - * @brief ADS1X15 family adc library + * @brief ADS1X15 Family ADC Library * * Library for TI analog to digital converter ic. Base clase fro ADS1X15 provides all the functionality that * ADS1115 and ADS1015 ics have in common. diff --git a/src/adxl335/adxl335.hpp b/src/adxl335/adxl335.hpp index 4877e835..9a840211 100644 --- a/src/adxl335/adxl335.hpp +++ b/src/adxl335/adxl335.hpp @@ -36,7 +36,7 @@ namespace upm { /** - * @brief ADXL335 Accelerometer library + * @brief ADXL335 Accelerometer * @defgroup adxl335 libupm-adxl335 * @ingroup seeed analog accelerometer */ diff --git a/src/adxl345/adxl345.hpp b/src/adxl345/adxl345.hpp index 0a4965da..8ff243f6 100644 --- a/src/adxl345/adxl345.hpp +++ b/src/adxl345/adxl345.hpp @@ -30,7 +30,7 @@ namespace upm { /** - * @brief ADXL345 Accelerometer library + * @brief ADXL345 Accelerometer * @defgroup adxl345 libupm-adxl345 * @ingroup seeed i2c accelerometer */ diff --git a/src/adxrs610/adxrs610.hpp b/src/adxrs610/adxrs610.hpp index ad2b0af2..81021b01 100644 --- a/src/adxrs610/adxrs610.hpp +++ b/src/adxrs610/adxrs610.hpp @@ -38,7 +38,7 @@ namespace upm { /** - * @brief DFRobot ADXRS610 Gyro Breakout Board + * @brief ADXRS610 Gyroscope * @defgroup adxrs610 libupm-adxrs610 * @ingroup dfrobot analog compass */ @@ -53,7 +53,7 @@ namespace upm { * @web http://www.dfrobot.com/index.php?route=product/product&product_id=642 * @con analog * - * @brief DFRobot ADXRS610 Gyro Beakout board + * @brief DFRobot ADXRS610 Gyro Breakout board * * The ADXRS610 is a MEMS based single axis gyroscope with a range * of +/- 300 degrees/sec. It also incorporates a temperature @@ -63,7 +63,7 @@ namespace upm { * rotation about the Z-axis in degrees/sec. The temperature * component returns a proportional analog values in degrees C. * - * This driver was developed using the DFRobot ADXRS610 Gyro Beakout board. + * This driver was developed using the DFRobot ADXRS610 Gyro Breakout board. * * @image html adxrs610.jpg * @snippet adxrs610.cxx Interesting diff --git a/src/am2315/am2315.hpp b/src/am2315/am2315.hpp index 4c1f4eda..75ad96cf 100644 --- a/src/am2315/am2315.hpp +++ b/src/am2315/am2315.hpp @@ -50,7 +50,7 @@ namespace upm { /** - * @brief AM2315 Temperature & Humidity Sensor library + * @brief AM2315 Temperature & Humidity Sensor * @defgroup am2315 libupm-am2315 * @ingroup adafruit i2c temp */ diff --git a/src/apa102/apa102.hpp b/src/apa102/apa102.hpp index ae525c13..2adf4790 100644 --- a/src/apa102/apa102.hpp +++ b/src/apa102/apa102.hpp @@ -33,7 +33,7 @@ namespace upm { /** - * @brief APA102 RGB LED Strip driver library + * @brief APA102 RGB LED Strip * @defgroup apa102 libupm-apa102 * @ingroup spi led */ diff --git a/src/apds9002/apds9002.hpp b/src/apds9002/apds9002.hpp index 5346579b..062525b1 100644 --- a/src/apds9002/apds9002.hpp +++ b/src/apds9002/apds9002.hpp @@ -28,7 +28,7 @@ namespace upm { /** - * @brief APDS-9002 Luminance Sensor library + * @brief APDS-9002 Luminance Sensor * @defgroup apds9002 libupm-apds9002 * @ingroup seeed analog light */ diff --git a/src/apds9930/apds9930.hpp b/src/apds9930/apds9930.hpp index e63b7f1a..38a46e0f 100644 --- a/src/apds9930/apds9930.hpp +++ b/src/apds9930/apds9930.hpp @@ -29,7 +29,7 @@ namespace upm { /** - * @brief APDS9930 Digital Proximity and Ambient Light Sensor library + * @brief APDS9930 Digital Proximity and Ambient Light Sensor * @defgroup apds9930 libupm-apds9930 * @ingroup Avago Technologies iio i2c proximity and ambient light sensor */ diff --git a/src/at42qt1070/at42qt1070.hpp b/src/at42qt1070/at42qt1070.hpp index 18971fa2..825ebdd3 100644 --- a/src/at42qt1070/at42qt1070.hpp +++ b/src/at42qt1070/at42qt1070.hpp @@ -35,7 +35,7 @@ namespace upm { /** - * @brief Atmel* AT42QT1070 QTouch* Sensor library + * @brief Atmel AT42QT1070 QTouch Sensor * @defgroup at42qt1070 libupm-at42qt1070 * @ingroup seeed i2c touch */ diff --git a/src/bacnetmstp/bacnetmstp.hpp b/src/bacnetmstp/bacnetmstp.hpp index 9d8c3221..7ad3ad15 100644 --- a/src/bacnetmstp/bacnetmstp.hpp +++ b/src/bacnetmstp/bacnetmstp.hpp @@ -51,7 +51,7 @@ namespace upm { /** - * @brief BACNETMSTP base class + * @brief BACNETMSTP Library * @defgroup bacnetmstp libupm-bacnetmstp * @ingroup uart */ diff --git a/src/bh1750/bh1750.hpp b/src/bh1750/bh1750.hpp index aff27d6a..a8a9b948 100644 --- a/src/bh1750/bh1750.hpp +++ b/src/bh1750/bh1750.hpp @@ -34,7 +34,7 @@ namespace upm { /** - * @brief DFRobot Light Sensor (BH1750) + * @brief BH1750 Light Sensor * @defgroup bh1750 libupm-bh1750 * @ingroup dfrobot i2c */ diff --git a/src/biss0001/biss0001.hpp b/src/biss0001/biss0001.hpp index bf806c69..80c3511b 100644 --- a/src/biss0001/biss0001.hpp +++ b/src/biss0001/biss0001.hpp @@ -28,7 +28,7 @@ namespace upm { /** - * @brief BISS0001 Motion Sensor library + * @brief BISS0001 Motion Sensor * @defgroup biss0001 libupm-biss0001 * @ingroup seeed gpio light tsk */ diff --git a/src/bma220/bma220.hpp b/src/bma220/bma220.hpp index 18a26b6a..a188f6e2 100644 --- a/src/bma220/bma220.hpp +++ b/src/bma220/bma220.hpp @@ -35,7 +35,7 @@ namespace upm { /** - * @brief BMA220 Accelerometer library + * @brief BMA220 Accelerometer * @defgroup bma220 libupm-bma220 * @ingroup i2c gpio accelerometer bosch dfrobot */ diff --git a/src/bma250e/bma250e.hpp b/src/bma250e/bma250e.hpp index 9b199757..5ebaba71 100644 --- a/src/bma250e/bma250e.hpp +++ b/src/bma250e/bma250e.hpp @@ -34,7 +34,7 @@ namespace upm { /** - * @brief Bosch 3-axis Accelerometer + * @brief BMA250E 3-axis Accelerometer * @defgroup bma250e libupm-bma250e * @ingroup i2c spi gpio bosch accelerometer */ diff --git a/src/bmg160/bmg160.hpp b/src/bmg160/bmg160.hpp index 46559f3a..b7fcf42b 100644 --- a/src/bmg160/bmg160.hpp +++ b/src/bmg160/bmg160.hpp @@ -34,7 +34,7 @@ namespace upm { /** - * @brief Bosch 3-axis Gyroscope + * @brief BMG160 3-axis Gyroscope * @defgroup bmg160 libupm-bmg160 * @ingroup i2c spi gpio bosch gyro */ diff --git a/src/bmi160/bmi160.hpp b/src/bmi160/bmi160.hpp index c2e492e9..ad135845 100644 --- a/src/bmi160/bmi160.hpp +++ b/src/bmi160/bmi160.hpp @@ -31,7 +31,7 @@ namespace upm { /** - * @brief BMI160 3-axis Accelerometer, Gyroscope and Magnetometer + * @brief BMI160 Inertial Measurement Unit * @defgroup bmi160 libupm-bmi160 * @ingroup i2c accelerometer compass bosch mouser */ diff --git a/src/bmm150/bmm150.hpp b/src/bmm150/bmm150.hpp index b7aad494..4d721955 100644 --- a/src/bmm150/bmm150.hpp +++ b/src/bmm150/bmm150.hpp @@ -34,13 +34,13 @@ namespace upm { /** - * @brief Bosch 3-axis Magnetometer + * @brief BMM150 3-axis Magnetometer * @defgroup bmm150 libupm-bmm150 * @ingroup i2c spi gpio bosch compass */ /** - * @library bmx050 + * @library bmm150 * @sensor bmm150 * @comname 3-axis Geomagnetic Sensor * @altname bmm050 diff --git a/src/bmp280/bmp280.hpp b/src/bmp280/bmp280.hpp index 73dae30a..18889681 100644 --- a/src/bmp280/bmp280.hpp +++ b/src/bmp280/bmp280.hpp @@ -34,7 +34,7 @@ namespace upm { /** - * @brief BMP280 Digital Pressure Sensor + * @brief BMP280/BME280 Digital Pressure Sensors * @defgroup bmp280 libupm-bmp280 * @ingroup i2c spi gpio pressure bosch adafruit */ diff --git a/src/bmpx8x/bmpx8x.hpp b/src/bmpx8x/bmpx8x.hpp index b25c8d3d..680c2b57 100644 --- a/src/bmpx8x/bmpx8x.hpp +++ b/src/bmpx8x/bmpx8x.hpp @@ -38,7 +38,7 @@ namespace upm { /** - * @brief Bosch BMP & GY65 Atmospheric Pressure Sensor library + * @brief BMP & GY65 Atmospheric Pressure Sensors * @defgroup bmpx8x libupm-bmpx8x * @ingroup bosch seeed adafruit sparkfun i2c * pressure diff --git a/src/bmx055/bmc150.hpp b/src/bmx055/bmc150.hpp index dcdf7b29..1f9233d0 100644 --- a/src/bmx055/bmc150.hpp +++ b/src/bmx055/bmc150.hpp @@ -59,7 +59,7 @@ namespace upm { * The BMC150 is essentially 2 separate devices in one: the BMA250E * Accelerometer and the BMM150 Magnetometer. They are completely - * independant of each other. + * independent of each other. * * This driver provides a very simple interface to these 2 devices. * If finer control is desired, you should just use the separate diff --git a/src/bmx055/bmi055.hpp b/src/bmx055/bmi055.hpp index 12a0f63c..e2c50952 100644 --- a/src/bmx055/bmi055.hpp +++ b/src/bmx055/bmi055.hpp @@ -53,7 +53,7 @@ namespace upm { * * The BMI055 is essentially 2 separate devices in one: the BMA250E * Accelerometer and the BMG160 Gyroscope. They are completely - * independant of each other. + * independent of each other. * * This driver provides a very simple interface to these two devices. * If finer control is desired, you should just use the separate diff --git a/src/bmx055/bmx055.hpp b/src/bmx055/bmx055.hpp index 8c19d2ea..333cd44a 100644 --- a/src/bmx055/bmx055.hpp +++ b/src/bmx055/bmx055.hpp @@ -37,7 +37,7 @@ namespace upm { /** - * @brief BMX055 9-axis Sensor Module + * @brief BMX055/BMI055/BMC150 Sensor Modules * @defgroup bmx055 libupm-bmx055 * @ingroup i2c spi accelerometer compass */ @@ -65,11 +65,11 @@ namespace upm { * * The BMX055 is essentially 3 separate devices in one: the BMA250E * Accelerometer, the BMG160 Gyroscope, and the BMM150 Magnetometer. - * They are completely independant of each other. + * They are completely independent of each other. * * This driver provides a very simple interface to these 3 devices. * If finer control is desired, you should just use the separate - * BMA25E, BMG160, and BMM150 device classes directly. This driver + * BMA250E, BMG160, and BMM150 device classes directly. This driver * simply initializes all three devices, and provides a mechanism to * read accelerometer, gyroscope and magnetometer data from them. * diff --git a/src/bno055/bno055.hpp b/src/bno055/bno055.hpp index ba25468a..744523d8 100644 --- a/src/bno055/bno055.hpp +++ b/src/bno055/bno055.hpp @@ -31,7 +31,7 @@ namespace upm { /** - * @brief BNO055 Absolute Orientation 9DOF Fusion Hub + * @brief BNO055 9DOF Fusion Hub * @defgroup bno055 libupm-bno055 * @ingroup i2c gpio accelerometer compass bosch adafruit */ diff --git a/src/button/button.hpp b/src/button/button.hpp index c760e5eb..f90bbe94 100644 --- a/src/button/button.hpp +++ b/src/button/button.hpp @@ -32,7 +32,7 @@ namespace upm { /** - * @brief Button library + * @brief Button/Switch Library * @defgroup buttonlib libupm-button * @ingroup seeed gpio button gsk */ diff --git a/src/buzzer/buzzer.hpp b/src/buzzer/buzzer.hpp index e4073ea7..ab1dac00 100644 --- a/src/buzzer/buzzer.hpp +++ b/src/buzzer/buzzer.hpp @@ -33,7 +33,7 @@ namespace upm { /** - * @brief Buzzer library + * @brief Piezoelectric Buzzers Library * @defgroup buzzer libupm-buzzer * @ingroup seeed pwm sound gsk */ diff --git a/src/cjq4435/cjq4435.hpp b/src/cjq4435/cjq4435.hpp index 423fb30b..0b7cf5e3 100644 --- a/src/cjq4435/cjq4435.hpp +++ b/src/cjq4435/cjq4435.hpp @@ -27,7 +27,7 @@ namespace upm { /** - * @brief CJQ4435 MOSFET library + * @brief CJQ4435 MOSFET * @defgroup cjq4435 libupm-cjq4435 * @ingroup seeed gpio pwm electric robok */ diff --git a/src/collision/collision.hpp b/src/collision/collision.hpp index dd288b39..2501a9c8 100644 --- a/src/collision/collision.hpp +++ b/src/collision/collision.hpp @@ -27,7 +27,7 @@ namespace upm { /** - * @brief Collision Sensor library + * @brief Collision Sensor * @defgroup collision libupm-collision * @ingroup seeed gpio accelerometer */ diff --git a/src/curieimu/curieimu.hpp b/src/curieimu/curieimu.hpp index 1a2d9c49..c9a556d8 100644 --- a/src/curieimu/curieimu.hpp +++ b/src/curieimu/curieimu.hpp @@ -46,9 +46,9 @@ namespace upm { /** - * @brief CurieIMU sensor for Arduino/Genuino 101 running Firmata + * @brief CurieIMU Library for Arduino/Genuino 101 Running Firmata * @defgroup curieimu libupm-curieimu - * @ingroup firmata accelerometer compass bosch + * @ingroup uart serial accelerometer compass bosch */ struct IMUDataItem { @@ -61,9 +61,9 @@ struct IMUDataItem { * @sensor curieimu * @comname Curie IMU Sensor using Firmata * @altname Curie IMU Sensor for Arduino/Genuino 101 running Firmata - * @type accelerometer compass + * @type serial accelerometer compass * @man bosch - * @con firmata + * @con uart * * @brief API for the Curie IMU via Firmata * diff --git a/src/cwlsxxa/cwlsxxa.hpp b/src/cwlsxxa/cwlsxxa.hpp index bdb188e9..27419017 100644 --- a/src/cwlsxxa/cwlsxxa.hpp +++ b/src/cwlsxxa/cwlsxxa.hpp @@ -33,9 +33,9 @@ namespace upm { /** - * @brief Veris CWLSXXA CO2 Sensor + * @brief Veris CWLSXXA CO2 Sensors * @defgroup cwlsxxa libupm-cwlsxxa - * @ingroup veris ainput temp gaseous + * @ingroup veris analog temp gaseous */ /** @@ -44,7 +44,7 @@ namespace upm { * @comname CO2/temperature/humidity Transmitter * @type temp gaseous * @man veris - * @con ainput + * @con analog * @web http://www.veris.com/Item/CWLSHTA.aspx * * @brief API for the Veris CWLSXXA CO2 Sensor Family diff --git a/src/dfrec/dfrec.hpp b/src/dfrec/dfrec.hpp index 6262a156..c62e9353 100644 --- a/src/dfrec/dfrec.hpp +++ b/src/dfrec/dfrec.hpp @@ -36,7 +36,7 @@ namespace upm { /** * @brief DFRobot EC Meter * @defgroup dfrec libupm-dfrec - * @ingroup dfrobot ainput uart liquid + * @ingroup dfrobot analog uart liquid */ /** @@ -45,7 +45,7 @@ namespace upm { * @comname Analog Electrical Conductivity (EC) Sensor * @type liquid * @man dfrobot - * @con ainput uart + * @con analog uart * @web https://www.dfrobot.com/index.php?route=product/product&product_id=1123&search=DFR0300&description=true#.Vx49p-_n-M8 * * @brief DFRobot EC Meter diff --git a/src/dfrorp/dfrorp.hpp b/src/dfrorp/dfrorp.hpp index b509bdd7..d56ddba3 100644 --- a/src/dfrorp/dfrorp.hpp +++ b/src/dfrorp/dfrorp.hpp @@ -34,10 +34,9 @@ namespace upm { /** - * @brief UPM C++ API for the DFRobot ORP (Oxidation/Reduction - * Potential) Sensor + * @brief DFRobot ORP (Oxidation/Reduction Potential) Sensor * @defgroup dfrorp libupm-dfrorp - * @ingroup dfrobot ainput liquid + * @ingroup dfrobot analog liquid */ /** diff --git a/src/dfrph/dfrph.hpp b/src/dfrph/dfrph.hpp index 58962aef..d6658d51 100644 --- a/src/dfrph/dfrph.hpp +++ b/src/dfrph/dfrph.hpp @@ -30,7 +30,7 @@ namespace upm { /** - * @brief DFRobot pH sensors + * @brief DFRobot pH Sensors * @defgroup dfrph libupm-dfrph * @ingroup dfrobot liquid analog */ diff --git a/src/ds1307/ds1307.hpp b/src/ds1307/ds1307.hpp index 8b120e12..d5d205cb 100644 --- a/src/ds1307/ds1307.hpp +++ b/src/ds1307/ds1307.hpp @@ -43,7 +43,7 @@ namespace upm { /** - * @brief DS1307 Real-Time Clock library + * @brief DS1307 Real-Time Clock * @defgroup ds1307 libupm-ds1307 * @ingroup seeed i2c time */ diff --git a/src/ds1808lc/ds1808lc.hpp b/src/ds1808lc/ds1808lc.hpp index 2ee07dc4..e6f3c7c1 100644 --- a/src/ds1808lc/ds1808lc.hpp +++ b/src/ds1808lc/ds1808lc.hpp @@ -28,7 +28,7 @@ namespace upm { /** - * @brief DS1808LC lighting controller library + * @brief DS1808LC Lighting Controller * @defgroup DS1808LC libupm-ds1808lc * @ingroup ds1808lc i2c maxim light ilightcontroller */ diff --git a/src/ds2413/ds2413.hpp b/src/ds2413/ds2413.hpp index 3e9e0d4c..f2d5834e 100644 --- a/src/ds2413/ds2413.hpp +++ b/src/ds2413/ds2413.hpp @@ -38,7 +38,7 @@ namespace upm { /** - * @brief DS2413 modules + * @brief DS2413 Modules Library * @defgroup ds2413 libupm-ds2413 * @ingroup maxim uart gpio */ diff --git a/src/ecezo/ecezo.hpp b/src/ecezo/ecezo.hpp index 91cee88d..2d2e64ff 100644 --- a/src/ecezo/ecezo.hpp +++ b/src/ecezo/ecezo.hpp @@ -33,7 +33,7 @@ namespace upm { /** - * @brief API for the EC-EZO EC Sensor + * @brief EC-EZO Sensor * @defgroup ecezo libupm-ecezo * @ingroup uart i2c liquid */ diff --git a/src/ecs1030/ecs1030.hpp b/src/ecs1030/ecs1030.hpp index ce18d564..477ca990 100644 --- a/src/ecs1030/ecs1030.hpp +++ b/src/ecs1030/ecs1030.hpp @@ -42,7 +42,7 @@ namespace upm { #define FALSE LOW /** - * @brief ECS1030 Electricity Sensor library + * @brief ECS1030 Electricity Sensor * @defgroup ecs1030 libupm-ecs1030 * @ingroup sparkfun analog electric */ diff --git a/src/ehr/ehr.hpp b/src/ehr/ehr.hpp index 688e4654..e83cded9 100644 --- a/src/ehr/ehr.hpp +++ b/src/ehr/ehr.hpp @@ -30,7 +30,7 @@ namespace upm { /** - * @brief Ear-clip Heart Rate Sensor library + * @brief Ear-clip Heart Rate Sensor * @defgroup ehr libupm-ehr * @ingroup seeed gpio medical */ diff --git a/src/eldriver/eldriver.hpp b/src/eldriver/eldriver.hpp index 95aeb48c..2491f910 100644 --- a/src/eldriver/eldriver.hpp +++ b/src/eldriver/eldriver.hpp @@ -30,7 +30,7 @@ namespace upm { /** - * @brief EL Driver Module library + * @brief EL Driver Module * @defgroup eldriver libupm-eldriver * @ingroup seeed gpio electric */ diff --git a/src/electromagnet/electromagnet.hpp b/src/electromagnet/electromagnet.hpp index 200cf077..abd41bfe 100644 --- a/src/electromagnet/electromagnet.hpp +++ b/src/electromagnet/electromagnet.hpp @@ -30,7 +30,7 @@ namespace upm { /** - * @brief Electromagnet library + * @brief Electromagnet Library * @defgroup electromagnet libupm-electromagnet * @ingroup seeed gpio electric */ diff --git a/src/emg/emg.hpp b/src/emg/emg.hpp index 66be2779..bc9c3e3d 100644 --- a/src/emg/emg.hpp +++ b/src/emg/emg.hpp @@ -28,7 +28,7 @@ namespace upm { /** - * @brief Grove EMG Muscle Signal Reader library + * @brief EMG Muscle Signal Reader * @defgroup emg libupm-emg * @ingroup seeed analog electric */ diff --git a/src/enc03r/enc03r.hpp b/src/enc03r/enc03r.hpp index eddb0f9a..50e438af 100644 --- a/src/enc03r/enc03r.hpp +++ b/src/enc03r/enc03r.hpp @@ -28,7 +28,7 @@ namespace upm { /** - * @brief ENC03R Single Axis Gyro library + * @brief ENC03R Single Axis Gyro * @defgroup enc03r libupm-enc03r * @ingroup seeed analog compass robok */ diff --git a/src/flex/flex.hpp b/src/flex/flex.hpp index a0b02f14..4ff3b15f 100644 --- a/src/flex/flex.hpp +++ b/src/flex/flex.hpp @@ -29,7 +29,7 @@ namespace upm { /** - * @brief Spectra Symbol Flex Sensor library + * @brief Spectra Symbol Flex Sensor * @defgroup flex libupm-flex * @ingroup sparkfun analog flexfor */ diff --git a/src/gas/gas.hpp b/src/gas/gas.hpp index 00f59b7a..c7edf63f 100644 --- a/src/gas/gas.hpp +++ b/src/gas/gas.hpp @@ -34,7 +34,7 @@ struct thresholdContext { namespace upm { /** - * @brief Gas Sensor library + * @brief Gas Sensors Library * * Library for air quality and gas detecting sensors. Base class Gas provides buffered * sampling, threshold checking, basic printing function, and standard read function. diff --git a/src/gp2y0a/gp2y0a.hpp b/src/gp2y0a/gp2y0a.hpp index e8d0ed85..fdfd5c89 100644 --- a/src/gp2y0a/gp2y0a.hpp +++ b/src/gp2y0a/gp2y0a.hpp @@ -29,7 +29,7 @@ namespace upm { /** - * @brief GP2Y0A-based IR Proximity Sensor library + * @brief GP2Y0A-based IR Proximity Sensors * @defgroup gp2y0a libupm-gp2y0a * @ingroup seeed analog light */ diff --git a/src/gprs/gprs.hpp b/src/gprs/gprs.hpp index 3e4e7de9..3bf704a8 100644 --- a/src/gprs/gprs.hpp +++ b/src/gprs/gprs.hpp @@ -40,7 +40,7 @@ namespace upm { /** - * @brief GPRS Module library + * @brief GPRS Modules Library * @defgroup gprs libupm-gprs * @ingroup seeed uart wifi */ diff --git a/src/groups.md b/src/groups.md index b4e21051..3aaef271 100644 --- a/src/groups.md +++ b/src/groups.md @@ -159,6 +159,11 @@ and is not meant to be installed anywhere. @brief Wireless sensors using RFID tags +@defgroup serial Serial +@ingroup bycat +@brief Sensors using serial communication + + @defgroup servos Servo @ingroup bycat @brief Various servo motors & controllers @@ -174,11 +179,6 @@ and is not meant to be installed anywhere. @brief Measure temperature & humidity -@defgroup serial Serial -@ingroup bycat -@brief Sensors using serial communication - - @defgroup time Time @ingroup bycat @brief Real time clocks & time measurement diff --git a/src/grove/grovebase.hpp b/src/grove/grovebase.hpp index dfa2e679..d51e8d52 100644 --- a/src/grove/grovebase.hpp +++ b/src/grove/grovebase.hpp @@ -32,7 +32,7 @@ namespace upm { /** * @deprecated This library is now deprecated and replaced by individual * libraries for every sensor. - * @brief Generic library for basic Grove sensors + * @brief Generic Library for Basic Grove Sensors * @defgroup grove libupm-grove * @ingroup seeed gpio pwm ainput button led light relay temp touch gsk eak hak */ diff --git a/src/grovecollision/grovecollision.hpp b/src/grovecollision/grovecollision.hpp index 6d6cc595..7c717b08 100644 --- a/src/grovecollision/grovecollision.hpp +++ b/src/grovecollision/grovecollision.hpp @@ -28,7 +28,7 @@ namespace upm { /** * @deprecated This library is being replaced by libupm-collision - * @brief Grove Collision Sensor library + * @brief Grove Collision Sensor * @defgroup grovecollision libupm-grovecollision * @ingroup seeed gpio accelerometer */ diff --git a/src/groveehr/groveehr.hpp b/src/groveehr/groveehr.hpp index e211be82..596644de 100644 --- a/src/groveehr/groveehr.hpp +++ b/src/groveehr/groveehr.hpp @@ -31,7 +31,7 @@ namespace upm { /** * @deprecated This library is being replaced by libupm-ehr - * @brief Grove Ear-clip Heart Rate Sensor library + * @brief Grove Ear-clip Heart Rate Sensor * @defgroup groveehr libupm-groveehr * @ingroup seeed gpio medical */ diff --git a/src/groveeldriver/groveeldriver.hpp b/src/groveeldriver/groveeldriver.hpp index 4d765fba..458ac6a1 100644 --- a/src/groveeldriver/groveeldriver.hpp +++ b/src/groveeldriver/groveeldriver.hpp @@ -31,7 +31,7 @@ namespace upm { /** * @deprecated This library is being replaced by libupm-eldriver - * @brief Grove EL Driver Module library + * @brief Grove EL Driver Module * @defgroup groveeldriver libupm-groveeldriver * @ingroup seeed gpio electric */ diff --git a/src/groveelectromagnet/groveelectromagnet.hpp b/src/groveelectromagnet/groveelectromagnet.hpp index e555f68f..c77402b5 100644 --- a/src/groveelectromagnet/groveelectromagnet.hpp +++ b/src/groveelectromagnet/groveelectromagnet.hpp @@ -31,7 +31,7 @@ namespace upm { /** * @deprecated This library is being replaced by libupm-electromagnet - * @brief Grove Electromagnet library + * @brief Grove Electromagnet Library * @defgroup groveelectromagnet libupm-groveelectromagnet * @ingroup seeed gpio electric */ diff --git a/src/groveemg/groveemg.hpp b/src/groveemg/groveemg.hpp index 62aaef9e..e5d4b077 100644 --- a/src/groveemg/groveemg.hpp +++ b/src/groveemg/groveemg.hpp @@ -29,7 +29,7 @@ namespace upm { /** * @deprecated This library is being replaced by libupm-emg - * @brief Grove EMG Muscle Signal Reader library + * @brief Grove EMG Muscle Signal Reader * @defgroup groveemg libupm-groveemg * @ingroup seeed analog electric */ diff --git a/src/grovegprs/grovegprs.hpp b/src/grovegprs/grovegprs.hpp index 318beac8..cad7e7dd 100644 --- a/src/grovegprs/grovegprs.hpp +++ b/src/grovegprs/grovegprs.hpp @@ -41,7 +41,7 @@ namespace upm { /** * @deprecated This library is being replaced by libupm-gprs - * @brief Grove GPRS Module library + * @brief Grove GPRS Module * @defgroup grovegprs libupm-grovegprs * @ingroup seeed uart wifi */ diff --git a/src/grovegsr/grovegsr.hpp b/src/grovegsr/grovegsr.hpp index 1f3c275d..4cca0354 100644 --- a/src/grovegsr/grovegsr.hpp +++ b/src/grovegsr/grovegsr.hpp @@ -29,7 +29,7 @@ namespace upm { /** * @deprecated This library is being replaced by libupm-gsr - * @brief Grove GSR Galvanic Skin Response Sensor library + * @brief Grove GSR Galvanic Skin Response Sensor * @defgroup grovegsr libupm-grovegsr * @ingroup seeed analog electric */ diff --git a/src/grovelinefinder/grovelinefinder.hpp b/src/grovelinefinder/grovelinefinder.hpp index c21ad981..442070da 100644 --- a/src/grovelinefinder/grovelinefinder.hpp +++ b/src/grovelinefinder/grovelinefinder.hpp @@ -29,7 +29,7 @@ namespace upm { /** * @deprecated This library is being replaced by libupm-linefinder - * @brief Grove Line Finder Sensor library + * @brief Grove Line Finder Sensor * @defgroup grovelinefinder libupm-grovelinefinder * @ingroup seeed gpio color robok */ diff --git a/src/grovemd/grovemd.hpp b/src/grovemd/grovemd.hpp index 88757c9a..8f3439f8 100644 --- a/src/grovemd/grovemd.hpp +++ b/src/grovemd/grovemd.hpp @@ -35,7 +35,7 @@ namespace upm { /** * @deprecated This library is being replaced by libupm-md - * @brief Grove I2C Motor Driver library + * @brief Grove I2C Motor Driver * @defgroup grovemd libupm-grovemd * @ingroup seeed i2c motor robok */ diff --git a/src/grovemoisture/grovemoisture.hpp b/src/grovemoisture/grovemoisture.hpp index e7f7b2cd..b80db604 100644 --- a/src/grovemoisture/grovemoisture.hpp +++ b/src/grovemoisture/grovemoisture.hpp @@ -29,7 +29,7 @@ namespace upm { /** * @deprecated This library is being replaced by libupm-moisture - * @brief Grove Moisture Sensor library + * @brief Grove Moisture Sensor * @defgroup grovemoisture libupm-grovemoisture * @ingroup seeed analog liquid eak hak */ diff --git a/src/groveo2/groveo2.hpp b/src/groveo2/groveo2.hpp index 3d410e01..0a3d776a 100644 --- a/src/groveo2/groveo2.hpp +++ b/src/groveo2/groveo2.hpp @@ -29,7 +29,7 @@ namespace upm { /** * @deprecated This library is being replaced by libupm-o2 - * @brief Grove O2 Oxygen Gas Sensor library + * @brief Grove O2 Oxygen Gas Sensor * @defgroup groveo2 libupm-groveo2 * @ingroup seeed analog gaseous */ diff --git a/src/grovescam/grovescam.hpp b/src/grovescam/grovescam.hpp index 7a9ae438..3ad69dbc 100644 --- a/src/grovescam/grovescam.hpp +++ b/src/grovescam/grovescam.hpp @@ -49,7 +49,7 @@ namespace upm { /** * @deprecated This library is being replaced by libupm-scam - * @brief Grove Serial Camera library + * @brief Grove Serial Camera * @defgroup grovescam libupm-grovescam * @ingroup seeed uart other */ diff --git a/src/grovespeaker/grovespeaker.hpp b/src/grovespeaker/grovespeaker.hpp index 33c3450d..ba61a39b 100644 --- a/src/grovespeaker/grovespeaker.hpp +++ b/src/grovespeaker/grovespeaker.hpp @@ -34,7 +34,7 @@ namespace upm { /** * @deprecated This library is being replaced by libupm-speaker - * @brief Grove Speaker library + * @brief Grove Speaker * @defgroup grovespeaker libupm-grovespeaker * @ingroup seeed gpio sound hak */ diff --git a/src/groveultrasonic/groveultrasonic.hpp b/src/groveultrasonic/groveultrasonic.hpp index e28514c7..c8adce04 100644 --- a/src/groveultrasonic/groveultrasonic.hpp +++ b/src/groveultrasonic/groveultrasonic.hpp @@ -37,7 +37,7 @@ namespace upm { /** * @deprecated This library is being replaced by libupm-ultrasonic - * @brief Grove ultrasonic sensor library + * @brief Grove Ultrasonic Sensor * @defgroup groveultrasonic libupm-groveultrasonic * @ingroup seeed gpio sound */ diff --git a/src/grovevdiv/grovevdiv.hpp b/src/grovevdiv/grovevdiv.hpp index 0c62f6aa..de74a855 100644 --- a/src/grovevdiv/grovevdiv.hpp +++ b/src/grovevdiv/grovevdiv.hpp @@ -37,7 +37,7 @@ namespace upm { /** * @deprecated This library is being replaced by libupm-vdiv - * @brief Grove Voltage Divider Sensor library + * @brief Grove Voltage Divider Sensor * @defgroup grovevdiv libupm-grovevdiv * @ingroup seeed analog electric robok */ diff --git a/src/grovewater/grovewater.hpp b/src/grovewater/grovewater.hpp index 7c514ed6..5728ddc4 100644 --- a/src/grovewater/grovewater.hpp +++ b/src/grovewater/grovewater.hpp @@ -29,7 +29,7 @@ namespace upm { /** * @deprecated This library is being replaced by libupm-water - * @brief Grove Water Sensor library + * @brief Grove Water Sensor * @defgroup grovewater libupm-grovewater * @ingroup seeed gpio liquid eak */ diff --git a/src/grovewfs/grovewfs.hpp b/src/grovewfs/grovewfs.hpp index 8c1eb190..f4d230ef 100644 --- a/src/grovewfs/grovewfs.hpp +++ b/src/grovewfs/grovewfs.hpp @@ -32,7 +32,7 @@ namespace upm { /** * @deprecated This library is being replaced by libupm-wfs - * @brief Grove Water Flow Sensor library + * @brief Grove Water Flow Sensor * @defgroup grovewfs libupm-grovewfs * @ingroup seeed gpio liquid eak */ diff --git a/src/gsr/gsr.hpp b/src/gsr/gsr.hpp index 6f1c70b4..b6d5e43a 100644 --- a/src/gsr/gsr.hpp +++ b/src/gsr/gsr.hpp @@ -28,7 +28,7 @@ namespace upm { /** - * @brief Grove GSR Galvanic Skin Response Sensor library + * @brief Grove GSR Galvanic Skin Response Sensor * @defgroup gsr libupm-gsr * @ingroup seeed analog electric */ diff --git a/src/guvas12d/guvas12d.hpp b/src/guvas12d/guvas12d.hpp index d289f1c2..894ef24e 100644 --- a/src/guvas12d/guvas12d.hpp +++ b/src/guvas12d/guvas12d.hpp @@ -27,7 +27,7 @@ namespace upm { /** - * @brief GUVA-S12D UV sensor library + * @brief GUVA-S12D UV Sensors * @defgroup guvas12d libupm-guvas12d * @ingroup seeed analog light eak */ diff --git a/src/h3lis331dl/h3lis331dl.hpp b/src/h3lis331dl/h3lis331dl.hpp index bf522dfd..903a4889 100644 --- a/src/h3lis331dl/h3lis331dl.hpp +++ b/src/h3lis331dl/h3lis331dl.hpp @@ -34,7 +34,7 @@ namespace upm { /** - * @brief H3LIS331DL I2C Accelerometer (400g) library + * @brief H3LIS331DL 400g Accelerometer * @defgroup h3lis331dl libupm-h3lis331dl * @ingroup seeed stmicro i2c accelerometer */ diff --git a/src/hcsr04/hcsr04.hpp b/src/hcsr04/hcsr04.hpp index 7fa5e3c0..495cddf6 100644 --- a/src/hcsr04/hcsr04.hpp +++ b/src/hcsr04/hcsr04.hpp @@ -28,7 +28,7 @@ namespace upm { /** - * @brief HC-SR04 Ultrasonic Sensor library + * @brief HC-SR04 Ultrasonic Sensor * @defgroup hcsr04 libupm-hcsr04 * @ingroup generic gpio sound */ diff --git a/src/hdxxvxta/hdxxvxta.hpp b/src/hdxxvxta/hdxxvxta.hpp index 196a6be6..6b8bc28a 100644 --- a/src/hdxxvxta/hdxxvxta.hpp +++ b/src/hdxxvxta/hdxxvxta.hpp @@ -33,9 +33,9 @@ namespace upm { /** - * @brief Veris HDXXVXTA Humidity Transmitter + * @brief Veris HDXXVXTA Humidity Transmitters * @defgroup hdxxvxta libupm-hdxxvxta - * @ingroup veris ainput temp + * @ingroup veris analog temp */ /** @@ -44,7 +44,7 @@ namespace upm { * @comname Veris HDXXVXTA Temperature/humidity Transmitter * @type temp * @man veris - * @con ainput + * @con analog * @web http://www.veris.com/Item/HD2NVSTA1.aspx * * @brief API for the Veris HDXXVXTA Humidity Transmitter diff --git a/src/hka5/hka5.hpp b/src/hka5/hka5.hpp index 04eb0b50..fc927944 100644 --- a/src/hka5/hka5.hpp +++ b/src/hka5/hka5.hpp @@ -33,7 +33,7 @@ namespace upm { /** - * @brief UPM C++ API for the DFRobot Laser PM2.5 Sensor + * @brief HKA5 Laser PM2.5 Sensor * @defgroup hka5 libupm-hka5 * @ingroup uart gpio gaseous */ diff --git a/src/hlg150h/hlg150h.hpp b/src/hlg150h/hlg150h.hpp index 84fe091f..9d03a16d 100644 --- a/src/hlg150h/hlg150h.hpp +++ b/src/hlg150h/hlg150h.hpp @@ -30,7 +30,7 @@ namespace upm { /** - * @brief Meanwell HLG150H Lighting power supply controller library + * @brief Meanwell HLG150H Lighting Power Supply Controller * @defgroup hlg150h libupm-hlg150h * @ingroup pwm light ilightcontroller */ diff --git a/src/hm11/hm11.hpp b/src/hm11/hm11.hpp index 0836406d..0e8359f3 100644 --- a/src/hm11/hm11.hpp +++ b/src/hm11/hm11.hpp @@ -47,7 +47,7 @@ namespace upm { /** - * @brief HM-11 Bluetooth 4.0 Low Energy Module library + * @brief HM-11 Bluetooth 4.0 Low Energy Module * @defgroup hm11 libupm-hm11 * @ingroup seeed uart wifi */ diff --git a/src/hmc5883l/hmc5883l.hpp b/src/hmc5883l/hmc5883l.hpp index 9a92dae8..2b995d0a 100644 --- a/src/hmc5883l/hmc5883l.hpp +++ b/src/hmc5883l/hmc5883l.hpp @@ -33,7 +33,7 @@ namespace upm { /** - * @brief HMC5883L Magnetometer library + * @brief HMC5883L Magnetometer * @defgroup hmc5883l libupm-hmc5883l * @ingroup seeed i2c compass robok */ diff --git a/src/hmtrp/hmtrp.hpp b/src/hmtrp/hmtrp.hpp index d477ecba..f5c958b0 100644 --- a/src/hmtrp/hmtrp.hpp +++ b/src/hmtrp/hmtrp.hpp @@ -44,7 +44,7 @@ namespace upm { /** - * @brief HMTRP Serial RF Pro library + * @brief HMTRP Serial RF Pro * @defgroup hmtrp libupm-hmtrp * @ingroup seeed uart wifi */ diff --git a/src/hp20x/hp20x.hpp b/src/hp20x/hp20x.hpp index 4c06f4e7..7e23e355 100644 --- a/src/hp20x/hp20x.hpp +++ b/src/hp20x/hp20x.hpp @@ -33,7 +33,7 @@ namespace upm { /** - * @brief HP20X I2C Barometer (High-Accuracy) library + * @brief HP20X I2C Barometer (High-Accuracy) * @defgroup hp20x libupm-hp20x * @ingroup seeed i2c pressure */ diff --git a/src/ht9170/ht9170.hpp b/src/ht9170/ht9170.hpp index 0cca16b4..747c1b96 100644 --- a/src/ht9170/ht9170.hpp +++ b/src/ht9170/ht9170.hpp @@ -29,7 +29,7 @@ namespace upm { /** - * @brief HT9170 DTMF Decoder library + * @brief HT9170 DTMF Decoder * @defgroup ht9170 libupm-ht9170 * @ingroup seeed gpio other */ diff --git a/src/htu21d/htu21d.hpp b/src/htu21d/htu21d.hpp index 0dcc0a06..e4e603cd 100644 --- a/src/htu21d/htu21d.hpp +++ b/src/htu21d/htu21d.hpp @@ -49,7 +49,7 @@ namespace upm { /** - * @brief HTU21D Humidity Sensor library + * @brief HTU21D Humidity Sensor * @defgroup htu21d libupm-htu21d * @ingroup seeed adafruit sparkfun i2c temp */ diff --git a/src/hx711/hx711.hpp b/src/hx711/hx711.hpp index e1377969..29157ef5 100644 --- a/src/hx711/hx711.hpp +++ b/src/hx711/hx711.hpp @@ -29,7 +29,7 @@ namespace upm { /** - * @brief HX711 24-bit ADC library + * @brief HX711 24-bit ADC * @defgroup hx711 libupm-hx711 * @ingroup generic gpio electric */ diff --git a/src/ili9341/ili9341.hpp b/src/ili9341/ili9341.hpp index 2cb3b3fd..08caf446 100644 --- a/src/ili9341/ili9341.hpp +++ b/src/ili9341/ili9341.hpp @@ -129,7 +129,7 @@ namespace upm { /** - * @brief ILI9341 LCD library + * @brief ILI9341 LCD Display * @defgroup ili9341 libupm-ili9341 * @ingroup adafruit spi display */ @@ -142,7 +142,7 @@ namespace upm { * @web http://www.adafruit.com/product/2090 * @con spi * - * @brief API for the ILI9342 LCd + * @brief API for the ILI9342 LCD * * This module defines the interface for the ILI9341 display library * diff --git a/src/ims/ims.hpp b/src/ims/ims.hpp index b80277ce..91be9a09 100644 --- a/src/ims/ims.hpp +++ b/src/ims/ims.hpp @@ -28,7 +28,7 @@ namespace upm { /** - * @brief Catnip Electronics I2C moisture sensor + * @brief Catnip Electronics I2C Moisture Sensor * @defgroup ims libupm-ims * @ingroup catnip i2c liquid light temp */ diff --git a/src/ina132/ina132.hpp b/src/ina132/ina132.hpp index 4c40398c..eead4c6d 100644 --- a/src/ina132/ina132.hpp +++ b/src/ina132/ina132.hpp @@ -28,7 +28,7 @@ namespace upm { /** - * @brief INA132 Differential Amplifier Sensor library + * @brief INA132 Differential Amplifier Sensor * @defgroup ina132 libupm-ina132 * @ingroup seeed analog electric */ diff --git a/src/isd1820/isd1820.hpp b/src/isd1820/isd1820.hpp index 89f5d5b1..7ad2fc06 100644 --- a/src/isd1820/isd1820.hpp +++ b/src/isd1820/isd1820.hpp @@ -29,7 +29,7 @@ namespace upm { /** - * @brief ISD1820 Voice Recorder Module library + * @brief ISD1820 Voice Recorder Module * @defgroup isd1820 libupm-isd1820 * @ingroup seeed gpio sound */ diff --git a/src/itg3200/itg3200.hpp b/src/itg3200/itg3200.hpp index bef37cc2..a5468d4f 100644 --- a/src/itg3200/itg3200.hpp +++ b/src/itg3200/itg3200.hpp @@ -30,7 +30,7 @@ namespace upm { /** - * @brief ITG-3200 Gyroscope library + * @brief ITG3200 Gyroscope * @defgroup itg3200 libupm-itg3200 * @ingroup seeed i2c compass */ diff --git a/src/jhd1313m1/jhd1313m1.hpp b/src/jhd1313m1/jhd1313m1.hpp index 701ca908..08f43559 100644 --- a/src/jhd1313m1/jhd1313m1.hpp +++ b/src/jhd1313m1/jhd1313m1.hpp @@ -40,7 +40,7 @@ namespace upm { /** - * @brief JHD1313M1 Display library + * @brief JHD1313M1 Display Controller * @defgroup jhd1313m1 libupm-jhd1313m1 * @ingroup seeed i2c display gsk */ diff --git a/src/joystick12/joystick12.hpp b/src/joystick12/joystick12.hpp index 8975b1c5..9ba9b399 100644 --- a/src/joystick12/joystick12.hpp +++ b/src/joystick12/joystick12.hpp @@ -30,7 +30,7 @@ namespace upm { /** - * @brief Analog Joystick library + * @brief Analog Joystick Library * @defgroup joystick12 libupm-joystick12 * @ingroup generic analog ainput robok */ diff --git a/src/l298/l298.hpp b/src/l298/l298.hpp index bb4a6d1b..94cc0f08 100644 --- a/src/l298/l298.hpp +++ b/src/l298/l298.hpp @@ -34,7 +34,7 @@ namespace upm { /** - * @brief L298 Dual H-Bridge Motor Driver library + * @brief L298 Dual H-Bridge Motor Driver * @defgroup l298 libupm-l298 * @ingroup seeed sparkfun gpio pwm motor */ diff --git a/src/lcd/lcd.hpp b/src/lcd/lcd.hpp index 46ea78e4..6950def0 100644 --- a/src/lcd/lcd.hpp +++ b/src/lcd/lcd.hpp @@ -30,7 +30,7 @@ namespace upm { /** - * @brief I2C LCD Display library + * @brief I2C LCD Displays Library * @defgroup lcd libupm-lcd * @ingroup dfrobot sainsmart seeed sparkfun adafruit i2c gpio display gsk */ diff --git a/src/lcdks/lcdks.hpp b/src/lcdks/lcdks.hpp index b411f7c3..0b71e10e 100644 --- a/src/lcdks/lcdks.hpp +++ b/src/lcdks/lcdks.hpp @@ -42,7 +42,7 @@ namespace upm { /** - * @brief LCDKS (LCD Keypad Shield) Display library + * @brief LCD Keypad Shield * @defgroup lcdks libupm-lcdks * @ingroup dfrobot sainsmart display */ diff --git a/src/lcm1602/lcm1602.hpp b/src/lcm1602/lcm1602.hpp index e97a1e61..a7f178fc 100644 --- a/src/lcm1602/lcm1602.hpp +++ b/src/lcm1602/lcm1602.hpp @@ -40,7 +40,7 @@ namespace upm { /** - * @brief LCM1602 Display library + * @brief LCM1602 Display Controller * @defgroup lcm1602 libupm-lcm1602 * @ingroup dfrobot sainsmart seeed sparkfun adafruit i2c gpio display */ diff --git a/src/ldt0028/ldt0028.hpp b/src/ldt0028/ldt0028.hpp index ac7c06b5..8cfe28f2 100644 --- a/src/ldt0028/ldt0028.hpp +++ b/src/ldt0028/ldt0028.hpp @@ -29,7 +29,7 @@ namespace upm { /** - * @brief LDT0-028 Piezo Vibration Sensor library + * @brief LDT0-028 Piezo Vibration Sensor * @defgroup ldt0028 libupm-ldt0028 * @ingroup seeed analog flexfor */ diff --git a/src/led/led.hpp b/src/led/led.hpp index d93e4f19..2947b002 100644 --- a/src/led/led.hpp +++ b/src/led/led.hpp @@ -31,7 +31,7 @@ namespace upm { /** - * @brief LED library + * @brief LED Library * @defgroup ledlib libupm-led * @ingroup seeed gpio led gsk */ diff --git a/src/lidarlitev3/lidarlitev3.hpp b/src/lidarlitev3/lidarlitev3.hpp index c17c56c4..7772e718 100644 --- a/src/lidarlitev3/lidarlitev3.hpp +++ b/src/lidarlitev3/lidarlitev3.hpp @@ -65,7 +65,7 @@ namespace upm { /** - * @brief LIDARLITEV3 Optical Distance Measurement Sensor library + * @brief LIDARLITEV3 Optical Distance Measurement Sensor * @defgroup lidarlitev3 libupm-lidarlitev3 * @ingroup garmin i2c light */ diff --git a/src/light/light.hpp b/src/light/light.hpp index 6b58eace..bcaef823 100644 --- a/src/light/light.hpp +++ b/src/light/light.hpp @@ -32,9 +32,14 @@ #include "light.h" namespace upm { + /** + * @brief Analog Light Sensors Library + * @defgroup alight libupm-light + * @ingroup seeed analog light gsk + */ /** - * @library light + * @library alight * @sensor light * @comname Analog Light Sensor * @type light @@ -56,7 +61,7 @@ namespace upm { class Light { public: /** - * analog light sensor constructor + * Analog light sensor constructor * * @param pin Analog pin to use * @throws std::runtime_error on initialization error diff --git a/src/linefinder/linefinder.hpp b/src/linefinder/linefinder.hpp index 24acb276..4ad4d219 100644 --- a/src/linefinder/linefinder.hpp +++ b/src/linefinder/linefinder.hpp @@ -27,7 +27,7 @@ namespace upm { /** - * @brief Line Finder Sensor library + * @brief Line Finder Sensor * @defgroup linefinder libupm-linefinder * @ingroup seeed dfrobot gpio color robok */ diff --git a/src/lis2ds12/lis2ds12.hpp b/src/lis2ds12/lis2ds12.hpp index fcc9b8cf..4534695c 100644 --- a/src/lis2ds12/lis2ds12.hpp +++ b/src/lis2ds12/lis2ds12.hpp @@ -34,7 +34,7 @@ namespace upm { /** - * @brief ST Micro 3-axis Accelerometer + * @brief LIS2DS12 3-axis Accelerometer * @defgroup lis2ds12 libupm-lis2ds12 * @ingroup i2c spi gpio stmicro accelerometer */ diff --git a/src/lis3dh/lis3dh.hpp b/src/lis3dh/lis3dh.hpp index a6827db6..4e311586 100644 --- a/src/lis3dh/lis3dh.hpp +++ b/src/lis3dh/lis3dh.hpp @@ -38,7 +38,7 @@ namespace upm { /** - * @brief ST Micro 3-axis Accelerometer + * @brief LIS3DH 3-axis Accelerometer * @defgroup lis3dh libupm-lis3dh * @ingroup i2c spi gpio stmicro accelerometer */ diff --git a/src/lm35/lm35.hpp b/src/lm35/lm35.hpp index 41249dcd..a63733bf 100644 --- a/src/lm35/lm35.hpp +++ b/src/lm35/lm35.hpp @@ -29,7 +29,7 @@ namespace upm { /** - * @brief DFRobot LM35 Linear Temperature Sensor + * @brief LM35 Linear Temperature Sensor * @defgroup lm35 libupm-lm35 * @ingroup dfrobot analog temp */ diff --git a/src/lol/lol.hpp b/src/lol/lol.hpp index d993b5ef..c052aac2 100644 --- a/src/lol/lol.hpp +++ b/src/lol/lol.hpp @@ -34,7 +34,7 @@ namespace upm { #define LOL_Y 9 /** - * @brief Olimex LoL Array library + * @brief Olimex LoL Shield * @defgroup lol libupm-lol * @ingroup adafruit gpio display */ diff --git a/src/loudness/loudness.hpp b/src/loudness/loudness.hpp index 526eaf2d..8fde58c5 100644 --- a/src/loudness/loudness.hpp +++ b/src/loudness/loudness.hpp @@ -29,7 +29,7 @@ namespace upm { /** - * @brief Generic loudness sensors + * @brief Loudness Sensors Library * @defgroup loudness libupm-loudness * @ingroup dfrobot seeed analog sound */ diff --git a/src/lp8860/lp8860.hpp b/src/lp8860/lp8860.hpp index fdca4ab4..99dac61f 100644 --- a/src/lp8860/lp8860.hpp +++ b/src/lp8860/lp8860.hpp @@ -28,7 +28,7 @@ namespace upm { /** - * @brief lp8860 LED lighting controller library + * @brief LP8860 LED Lighting Controller * @defgroup lp8860 libupm-lp8860 * @ingroup ti i2c light ilightcontroller */ diff --git a/src/lpd8806/lpd8806.hpp b/src/lpd8806/lpd8806.hpp index 0e23a688..f3df04de 100644 --- a/src/lpd8806/lpd8806.hpp +++ b/src/lpd8806/lpd8806.hpp @@ -36,7 +36,7 @@ namespace upm { /** - * @brief FastPixel LPD8806 library + * @brief FastPixel LPD8806 LED Strip * @defgroup lpd8806 libupm-lpd8806 * @ingroup adafruit spi led */ diff --git a/src/lsm303agr/lsm303agr.hpp b/src/lsm303agr/lsm303agr.hpp index 72542d07..35bd43ab 100644 --- a/src/lsm303agr/lsm303agr.hpp +++ b/src/lsm303agr/lsm303agr.hpp @@ -34,8 +34,7 @@ namespace upm { /** - * @brief ST Microelectronics Ultra-compact high-performance - * eCompass module + * @brief LSM303AGR Ultra-compact eCompass Module * @defgroup lsm303agr libupm-lsm303agr * @ingroup i2c gpio stmicro compass accelerometer */ diff --git a/src/lsm303d/lsm303d.hpp b/src/lsm303d/lsm303d.hpp index 3da005b8..1ae36f89 100644 --- a/src/lsm303d/lsm303d.hpp +++ b/src/lsm303d/lsm303d.hpp @@ -34,8 +34,7 @@ namespace upm { /** - * @brief ST Microelectronics Ultra-compact high-performance - * eCompass module + * @brief LSM303D Ultra-compact eCompass Module * @defgroup lsm303d libupm-lsm303d * @ingroup i2c gpio stmicro compass accelerometer */ diff --git a/src/lsm303dlh/lsm303dlh.hpp b/src/lsm303dlh/lsm303dlh.hpp index 48faa433..75b8e34c 100644 --- a/src/lsm303dlh/lsm303dlh.hpp +++ b/src/lsm303dlh/lsm303dlh.hpp @@ -61,7 +61,7 @@ namespace upm { #define Z 2 /** - * @brief LSM303DLH Accelerometer/Compass library + * @brief LSM303DLH Accelerometer/Compass * @defgroup lsm303dlh libupm-lsm303dlh * @ingroup seeed adafruit stmicro i2c accelerometer compass */ diff --git a/src/lsm6ds3h/lsm6ds3h.hpp b/src/lsm6ds3h/lsm6ds3h.hpp index 4eff1594..299282d9 100644 --- a/src/lsm6ds3h/lsm6ds3h.hpp +++ b/src/lsm6ds3h/lsm6ds3h.hpp @@ -34,7 +34,7 @@ namespace upm { /** - * @brief ST Micro 3-axis Accelerometer + * @brief LSM6DS6H 3-axis Accelerometer * @defgroup lsm6ds3h libupm-lsm6ds3h * @ingroup i2c spi gpio stmicro accelerometer */ diff --git a/src/lsm6dsl/lsm6dsl.hpp b/src/lsm6dsl/lsm6dsl.hpp index 77031a0e..cdebeea1 100644 --- a/src/lsm6dsl/lsm6dsl.hpp +++ b/src/lsm6dsl/lsm6dsl.hpp @@ -34,7 +34,7 @@ namespace upm { /** - * @brief ST Micro 3-axis Accelerometer + * @brief LSM6DSL 3-axis Accelerometer * @defgroup lsm6dsl libupm-lsm6dsl * @ingroup i2c spi gpio stmicro accelerometer */ diff --git a/src/m24lr64e/m24lr64e.hpp b/src/m24lr64e/m24lr64e.hpp index 332b05e0..7e57d006 100644 --- a/src/m24lr64e/m24lr64e.hpp +++ b/src/m24lr64e/m24lr64e.hpp @@ -43,7 +43,7 @@ namespace upm { /** - * @brief M24LR64E NFC Tag library + * @brief M24LR64E NFC Tag Module * @defgroup m24lr64e libupm-m24lr64e * @ingroup seeed i2c other */ diff --git a/src/max30100/max30100.hpp b/src/max30100/max30100.hpp index 4e1a1e27..a99149bc 100644 --- a/src/max30100/max30100.hpp +++ b/src/max30100/max30100.hpp @@ -43,7 +43,7 @@ class Callback { }; /** - * @brief Pulse oximeter and heart-rate sensor + * @brief MAX30100 Pulse Oximeter and Heart Rate Sensor * @defgroup max30100 libupm-max30100 * @ingroup maxim i2c medical */ diff --git a/src/max31723/max31723.hpp b/src/max31723/max31723.hpp index b6731677..aad5de57 100644 --- a/src/max31723/max31723.hpp +++ b/src/max31723/max31723.hpp @@ -36,7 +36,7 @@ namespace upm { /** - * @brief MAX31723 Temperature Sensor library + * @brief MAX31723 Temperature Sensor * @defgroup max31723 libupm-max31723 * @ingroup maxim spi temp */ diff --git a/src/max31855/max31855.hpp b/src/max31855/max31855.hpp index c895875e..c6ccac6f 100644 --- a/src/max31855/max31855.hpp +++ b/src/max31855/max31855.hpp @@ -30,7 +30,7 @@ namespace upm { /** - * @brief MAX31855 Thermocouple library + * @brief MAX31855 Thermocouple * @defgroup max31855 libupm-max31855 * @ingroup maxim adafruit spi other */ diff --git a/src/max44000/max44000.hpp b/src/max44000/max44000.hpp index f17d86d7..333c73cb 100644 --- a/src/max44000/max44000.hpp +++ b/src/max44000/max44000.hpp @@ -53,7 +53,7 @@ namespace upm { /** - * @brief MAX44000 Proximity Sensor library + * @brief MAX44000 Proximity Sensor * @defgroup max44000 libupm-max44000 * @ingroup maxim i2c light */ diff --git a/src/max44009/max44009.hpp b/src/max44009/max44009.hpp index eedb4d61..0b78b90f 100644 --- a/src/max44009/max44009.hpp +++ b/src/max44009/max44009.hpp @@ -81,7 +81,7 @@ namespace upm { /** - * @brief max44009 ambient light sensor library + * @brief MAX44009 Ambient Light Sensor * @defgroup max44009 libupm-max44009 * @ingroup maxim i2c light ilightsensor */ diff --git a/src/max5487/max5487.hpp b/src/max5487/max5487.hpp index 4b906dce..6a1c19b0 100644 --- a/src/max5487/max5487.hpp +++ b/src/max5487/max5487.hpp @@ -35,7 +35,7 @@ namespace upm { /** - * @brief MAX5487 Digital Potentiometer library + * @brief MAX5487 Digital Potentiometer * @defgroup max5487 libupm-max5487 * @ingroup maxim spi digipot */ diff --git a/src/maxds3231m/maxds3231m.hpp b/src/maxds3231m/maxds3231m.hpp index 2a873127..546544d2 100644 --- a/src/maxds3231m/maxds3231m.hpp +++ b/src/maxds3231m/maxds3231m.hpp @@ -63,7 +63,7 @@ struct Time3231 { }; /** - * @brief MAXDS3231M Proximity Sensor library + * @brief MAXDS3231M Proximity Sensor * @defgroup maxds3231m libupm-maxds3231m * @ingroup maxim i2c light */ diff --git a/src/maxsonarez/maxsonarez.hpp b/src/maxsonarez/maxsonarez.hpp index b63226d7..a6b7f983 100644 --- a/src/maxsonarez/maxsonarez.hpp +++ b/src/maxsonarez/maxsonarez.hpp @@ -32,7 +32,7 @@ namespace upm { /** - * @brief MaxSonar-EZ Family of Ultrasonic Rangers library + * @brief MaxSonar-EZ Family of Ultrasonic Rangers * @defgroup maxsonarez libupm-maxsonarez * @ingroup seeed analog sound */ diff --git a/src/mb704x/mb704x.hpp b/src/mb704x/mb704x.hpp index d4cd6b84..d40247ef 100644 --- a/src/mb704x/mb704x.hpp +++ b/src/mb704x/mb704x.hpp @@ -33,7 +33,7 @@ namespace upm { /** - * @brief API for the MB704x MaxSonar-WR Ultrasonic Ranger + * @brief MB704x MaxSonar-WR Ultrasonic Ranger * @defgroup mb704x libupm-mb704x * @ingroup i2c sound */ diff --git a/src/mcp2515/mcp2515.hpp b/src/mcp2515/mcp2515.hpp index ce6ce5f6..81e07ad8 100644 --- a/src/mcp2515/mcp2515.hpp +++ b/src/mcp2515/mcp2515.hpp @@ -30,7 +30,7 @@ namespace upm { /** - * @brief MCP2515 Can bus controller + * @brief MCP2515 CAN Bus Controller * @defgroup mcp2515 libupm-mcp2515 * @ingroup spi gpio */ diff --git a/src/mcp9808/mcp9808.hpp b/src/mcp9808/mcp9808.hpp index 4f14ce2b..2f0e72da 100644 --- a/src/mcp9808/mcp9808.hpp +++ b/src/mcp9808/mcp9808.hpp @@ -43,7 +43,7 @@ namespace mraa { class I2c;} namespace upm { /** - * @brief MCP9808 precision temperature sensor library + * @brief MCP9808 Precision Temperature Sensor * @defgroup mcp9808 libupm-mcp9808 * @ingroup adafruit i2c temp */ diff --git a/src/md/md.hpp b/src/md/md.hpp index fd2d6580..de2ecdad 100644 --- a/src/md/md.hpp +++ b/src/md/md.hpp @@ -29,7 +29,7 @@ namespace upm { /** - * @brief I2C Motor Driver library + * @brief I2C Motor Driver * @defgroup md libupm-md * @ingroup seeed i2c motor robok */ diff --git a/src/mg811/mg811.hpp b/src/mg811/mg811.hpp index eb59dc49..ae26d446 100644 --- a/src/mg811/mg811.hpp +++ b/src/mg811/mg811.hpp @@ -30,7 +30,7 @@ namespace upm { /** - * @brief DFRobot CO2 Sensor + * @brief MG811 CO2 Sensor * @defgroup mg811 libupm-mg811 * @ingroup dfrobot analog gaseous */ diff --git a/src/mhz16/mhz16.hpp b/src/mhz16/mhz16.hpp index 68ec14f6..999996c0 100644 --- a/src/mhz16/mhz16.hpp +++ b/src/mhz16/mhz16.hpp @@ -48,7 +48,7 @@ const uint8_t MHZ16_END = 0x7e; namespace upm { /** - * @brief MHZ16 Serial CO2 Sensor library + * @brief MHZ16 Serial CO2 Sensor * @defgroup mhz16 libupm-mhz16 * @ingroup seeed uart gaseous */ diff --git a/src/mic/mic.hpp b/src/mic/mic.hpp index d79a716e..25e99767 100644 --- a/src/mic/mic.hpp +++ b/src/mic/mic.hpp @@ -36,7 +36,7 @@ struct thresholdContext { namespace upm { /** - * @brief Analog Microphone library + * @brief Analog Microphone Library * @defgroup mic libupm-mic * @ingroup seeed pwm sound gsk */ diff --git a/src/micsv89/micsv89.hpp b/src/micsv89/micsv89.hpp index ee20d3e8..ca4d822d 100644 --- a/src/micsv89/micsv89.hpp +++ b/src/micsv89/micsv89.hpp @@ -31,7 +31,7 @@ namespace mraa { class I2c;} namespace upm { /** - * @brief MICS-VZ89 environmental sensor library + * @brief MICS-VZ89 Environmental Sensor * @defgroup micsv89 libupm-micsv89 * @ingroup generic i2c gaseous */ diff --git a/src/mlx90614/mlx90614.hpp b/src/mlx90614/mlx90614.hpp index d7b4ac6d..fae82427 100644 --- a/src/mlx90614/mlx90614.hpp +++ b/src/mlx90614/mlx90614.hpp @@ -53,7 +53,7 @@ namespace upm { /** - * @brief MLX90614 Temperature Sensor library + * @brief MLX90614 Temperature Sensor * @defgroup mlx90614 libupm-mlx90614 * @ingroup generic i2c temp */ diff --git a/src/mma7361/mma7361.hpp b/src/mma7361/mma7361.hpp index b5a91c19..7db3aeef 100644 --- a/src/mma7361/mma7361.hpp +++ b/src/mma7361/mma7361.hpp @@ -34,9 +34,9 @@ namespace upm { /** - * @brief UPM C++ API for the DFRobot MMA7361 Analog Accelerometer + * @brief MMA7361 Analog Accelerometer * @defgroup mma7361 libupm-mma7361 - * @ingroup dfrobot gpio ainput accelerometer + * @ingroup dfrobot gpio analog accelerometer */ /** @@ -45,7 +45,7 @@ namespace upm { * @comname Triaxial Analog Accelerometer * @type accelerometer * @man dfrobot - * @con ainput gpio + * @con analog gpio * @web http://www.dfrobot.com/index.php?route=product/product&path=36&product_id=507#.V7YEj99ytNJ * * @brief API for the DFRobot MMA7361 Analog Accelerometer diff --git a/src/mma7455/mma7455.hpp b/src/mma7455/mma7455.hpp index 30161d18..ce9bae92 100644 --- a/src/mma7455/mma7455.hpp +++ b/src/mma7455/mma7455.hpp @@ -151,7 +151,7 @@ typedef union { #define BIT(n) (1<