diff --git a/src/a110x/a110x.h b/src/a110x/a110x.h index 7c8b28b7..1ee51d2b 100644 --- a/src/a110x/a110x.h +++ b/src/a110x/a110x.h @@ -38,6 +38,7 @@ namespace upm { * @sensor a110x * @comname A110X Hall Effect Sensor * @altname A1101, A1102, A1103, A1004, A1106 + * @altname Grove Hall Sensor * @type electric * @man seeed * @web http://www.allegromicro.com/en/Products/Magnetic-Digital-Position-Sensor-ICs/Hall-Effect-Unipolar-Switches/A1101-2-3-4-6.aspx diff --git a/src/ad8232/ad8232.h b/src/ad8232/ad8232.h index beaac59d..ac23a4ad 100644 --- a/src/ad8232/ad8232.h +++ b/src/ad8232/ad8232.h @@ -34,7 +34,7 @@ namespace upm { /** - * @brief UPM support for the AD8232 Heart Rate Monitor + * @brief AD8232 heart rate monitor library * @defgroup ad8232 libupm-ad8232 * @ingroup sparkfun gpio medical */ diff --git a/src/adafruitms1438/adafruitms1438.h b/src/adafruitms1438/adafruitms1438.h index 5123a96f..c5cf5d74 100644 --- a/src/adafruitms1438/adafruitms1438.h +++ b/src/adafruitms1438/adafruitms1438.h @@ -38,7 +38,7 @@ namespace upm { /** - * @brief UPM module for the Adafruit Motor Shield 1438 + * @brief Adafruit Motor Shield 1438 library * @defgroup adafruitms1438 libupm-adafruitms1438 * @ingroup adafruit i2c motor */ diff --git a/src/adc121c021/adc121c021.h b/src/adc121c021/adc121c021.h index 058a8c66..3f201e51 100644 --- a/src/adc121c021/adc121c021.h +++ b/src/adc121c021/adc121c021.h @@ -49,7 +49,7 @@ namespace upm { /** - * @brief ADC121C021 I2C Analog Digital Converter library + * @brief ADC121C021 I2C analog digital converter library * @defgroup adc121c021 libupm-adc121c021 * @ingroup seeed i2c electric */ @@ -73,6 +73,7 @@ namespace upm { * @library adc121c021 * @sensor adc121c021 * @comname ADC121C021 Analog Digital Converter + * @altname Grove I2C ADC * @type electric * @man seeed * @web http://www.seeedstudio.com/depot/Grove-I2C-ADC-p-1580.html diff --git a/src/adis16448/adis16448.h b/src/adis16448/adis16448.h index 0d9770c6..b3f762e1 100644 --- a/src/adis16448/adis16448.h +++ b/src/adis16448/adis16448.h @@ -84,7 +84,7 @@ namespace upm { /** - * @brief Adis16448 + * @brief ADIS16448 accelerometer library * @defgroup adis16448 libupm-adis16488 * @ingroup generic spi accelerometer */ diff --git a/src/adxl335/adxl335.h b/src/adxl335/adxl335.h index 0b71a333..64a53e6e 100644 --- a/src/adxl335/adxl335.h +++ b/src/adxl335/adxl335.h @@ -44,6 +44,7 @@ namespace upm { * @library adxl335 * @sensor adxl335 * @comname ADXL335 3-Axis Analog Accelerometer + * @altname Grove 3-Axis Analog Accelerometer * @type accelerometer * @man seeed * @con analog diff --git a/src/adxl345/adxl345.h b/src/adxl345/adxl345.h index 8fe5401d..f239a9d1 100644 --- a/src/adxl345/adxl345.h +++ b/src/adxl345/adxl345.h @@ -30,7 +30,7 @@ namespace upm { /** - * @brief Adxl345 accelerometer library + * @brief ADXL345 accelerometer library * @defgroup adxl345 libupm-adxl345 * @ingroup seeed i2c accelerometer */ @@ -38,7 +38,8 @@ namespace upm { /** * @library adxl345 * @sensor adxl345 - * @comname Adxl345 3-Axis Digital Accelerometer + * @comname ADXL345 3-Axis Digital Accelerometer + * @altname Grove 3-Axis Digital Accelerometer (16g) * @type accelerometer * @man seeed * @con i2c diff --git a/src/apds9002/apds9002.h b/src/apds9002/apds9002.h index e4908bc9..7488475b 100644 --- a/src/apds9002/apds9002.h +++ b/src/apds9002/apds9002.h @@ -36,7 +36,7 @@ namespace upm { /** * @library apds9002 * @sensor apds9002 - * @comname APDS-9002 + * @comname APDS-9002 Luminance Sensor * @altname Grove Luminance Sensor * @type light * @man seeed diff --git a/src/at42qt1070/at42qt1070.h b/src/at42qt1070/at42qt1070.h index 549bc44f..03b3c748 100644 --- a/src/at42qt1070/at42qt1070.h +++ b/src/at42qt1070/at42qt1070.h @@ -35,7 +35,7 @@ namespace upm { /** - * @brief UPM module for the Atmel AT42QT1070 QTouch sensor + * @brief Atmel AT42QT1070 QTouch sensor library * @defgroup at42qt1070 libupm-at42qt1070 * @ingroup seeed i2c touch */ @@ -43,7 +43,8 @@ namespace upm { /** * @library at42qt1070 * @sensor at42qt1070 - * @comname Atmel AT42QT1070 QTouch Sensor + * @comname AT42QT1070 QTouch Sensor + * @altname Grove QTouch Sensor * @type touch * @man seeed * @con i2c diff --git a/src/biss0001/biss0001.h b/src/biss0001/biss0001.h index d34e3b60..163c0d4c 100644 --- a/src/biss0001/biss0001.h +++ b/src/biss0001/biss0001.h @@ -36,7 +36,8 @@ namespace upm { /** * @library biss0001 * @sensor biss0001 - * @comname PIR Motion Sensor + * @comname BISS0001 Motion Sensor + * @altname Grove PIR Motion Sensor * @type light * @man seeed * @web http://www.seeedstudio.com/depot/Grove-PIR-Motion-Sensor-p-802.html diff --git a/src/bmpx8x/bmpx8x.h b/src/bmpx8x/bmpx8x.h index 116daada..76406b67 100644 --- a/src/bmpx8x/bmpx8x.h +++ b/src/bmpx8x/bmpx8x.h @@ -62,7 +62,7 @@ namespace upm { /** - * @brief GY65/BPM085, and BMP180 atmospheric pressure sensor library + * @brief Bosch BPM & GY65 atmospheric pressure sensor library * @defgroup bmpx8x libupm-bmpx8x * @ingroup seeed adafruit sparkfun i2c pressure */ @@ -70,7 +70,7 @@ namespace upm { /** * @library bmpx8x * @sensor bmpx8x - * @comname Bosch BMP Atmospheric Pressure Sensor + * @comname BMP Atmospheric Pressure Sensor * @altname GY65 BMP085 BMP180 BMP183 * @type pressure * @man seeed adafruit sparkfun diff --git a/src/ds1307/ds1307.h b/src/ds1307/ds1307.h index 48e3e28e..ed61d0ff 100644 --- a/src/ds1307/ds1307.h +++ b/src/ds1307/ds1307.h @@ -43,7 +43,7 @@ namespace upm { /** - * @brief DS1307 Real Time CLock library + * @brief DS1307 real-time clock library * @defgroup ds1307 libupm-ds1307 * @ingroup seeed i2c time */ @@ -51,8 +51,8 @@ namespace upm { /** * @library ds1307 * @sensor ds1307 - * @comname Grove RTC (Real Time Clock) - * @altname DS1307 + * @comname Grove RTC (Real-Time Clock) + * @altname DS1307 RTC * @type time * @man seeed * @con i2c diff --git a/src/enc03r/enc03r.h b/src/enc03r/enc03r.h index 7e683c13..973eebf8 100644 --- a/src/enc03r/enc03r.h +++ b/src/enc03r/enc03r.h @@ -37,8 +37,8 @@ namespace upm { /** * @library enc03r * @sensor enc03r - * @comname Grove Single Axis Analog Gyro - * @altname ENC03R + * @comname ENC03R Single Axis Gyro + * @altname Grove Single Axis Analog Gyro * @type compass * @man seeed * @con analog diff --git a/src/flex/flex.h b/src/flex/flex.h index d2f22404..4f9c2499 100644 --- a/src/flex/flex.h +++ b/src/flex/flex.h @@ -29,7 +29,7 @@ namespace upm { /** - * @brief UPM module for the Spectra Symbol Flex sensor + * @brief Spectra Symbol Flex sensor library * @defgroup flex libupm-flex * @ingroup sparkfun analog flexfor */ @@ -37,7 +37,7 @@ namespace upm { /** * @library flex * @sensor flex - * @comname Spectra Symbol Flex sensor + * @comname Flex Sensor * @type flexfor * @man sparkfun * @con analog diff --git a/src/gas/gas.h b/src/gas/gas.h index bc2e397e..d55ef54e 100644 --- a/src/gas/gas.h +++ b/src/gas/gas.h @@ -35,7 +35,7 @@ struct thresholdContext { namespace upm { /** - * @brief Gas Sensor Library + * @brief Gas sensor library * * Sensor Library for air quality and gas detecting sensors. Base class Gas provides buffered * sampling, threshold checking, a basic printing function and a standard read function. diff --git a/src/gas/mq2.h b/src/gas/mq2.h index dea06bca..1c95d9a3 100644 --- a/src/gas/mq2.h +++ b/src/gas/mq2.h @@ -31,12 +31,12 @@ namespace upm { /** * @library gas * @sensor mq2 - * @comname Grove MQ2 gas sensor + * @comname Grove MQ2 Gas Sensor * @type gaseous * @man seeed * @con analog * - * @brief API for MQ2 gas sensor + * @brief API for MQ2 Gas Sensor * * The Grove - Gas Sensor (MQ2) module is useful for gas leakage detecting * (in home and industry). It can detect LPG, i-butane, methane, alcohol, diff --git a/src/gas/mq3.h b/src/gas/mq3.h index ce44a9e6..d38a34e3 100644 --- a/src/gas/mq3.h +++ b/src/gas/mq3.h @@ -31,12 +31,12 @@ namespace upm { /** * @library gas * @sensor mq3 - * @comname Grove MQ3 gas sensor + * @comname Grove MQ3 Gas Sensor * @type gaseous * @man seeed * @con analog * - * @brief API for MQ3 gas sensor + * @brief API for MQ3 Gas Sensor * * The Grove MQ3 Gas Sensor module is useful for gas leakage detecting (in * home and industry). It can detect Alcohol Vapour and Benzine. It's diff --git a/src/gas/mq5.h b/src/gas/mq5.h index 1c3cc161..8a301342 100644 --- a/src/gas/mq5.h +++ b/src/gas/mq5.h @@ -31,12 +31,12 @@ namespace upm { /** * @library gas * @sensor mq5 - * @comname Grove MQ5 gas sensor + * @comname Grove MQ5 Gas Sensor * @type gaseous * @man seeed * @con analog * - * @brief API for MQ5 gas sensor + * @brief API for MQ5 Gas Sensor * * The Grove - Gas Sensor (MQ5) module is useful for gas leakage detecting * (in home and industry). It can detect LPG, natural gas, town gas and so diff --git a/src/gas/mq9.h b/src/gas/mq9.h index 3c4e4bb8..9046e135 100644 --- a/src/gas/mq9.h +++ b/src/gas/mq9.h @@ -31,12 +31,12 @@ namespace upm { /** * @library gas * @sensor mq9 - * @comname Grove MQ9 gas sensor + * @comname Grove MQ9 Gas Sensor * @type gaseous * @man seeed * @con analog * - * @brief API for MQ9 gas sensor + * @brief API for MQ9 Gas Sensor * * The Grove MQ9 Gas Sensor module is useful for gas leakage detecting (in * home and industry). It can detect Carbon Monoxide, Coal Gas and diff --git a/src/gas/tp401.h b/src/gas/tp401.h index 43cb5eac..35825ba1 100644 --- a/src/gas/tp401.h +++ b/src/gas/tp401.h @@ -32,7 +32,7 @@ namespace upm { * @library gas * @sensor tp401 * @comname Grove Air Quality Sensor - * @altname TP401 + * @altname TP401 Gas Sensor * @type gaseous * @man seeed * @con analog diff --git a/src/gp2y0a/gp2y0a.h b/src/gp2y0a/gp2y0a.h index 1b89edf1..1919111e 100644 --- a/src/gp2y0a/gp2y0a.h +++ b/src/gp2y0a/gp2y0a.h @@ -29,7 +29,7 @@ namespace upm { /** - * @brief UPM library for the GP2Y0A family of IR Proximity Sensors + * @brief GP2Y0A based IR proximity sensor library * @defgroup gp2y0a libupm-gp2y0a * @ingroup seeed analog light */ @@ -37,7 +37,8 @@ namespace upm { /** * @library gp2y0a * @sensor gp2y0a - * @comname GP2Y0A family of IR Proximity Sensors + * @comname GP2Y0A IR Proximity Sensor + * @altname Grove 80cm IR Proximity Sensor * @type light * @man seeed * @con analog diff --git a/src/grove/grovebutton.h b/src/grove/grovebutton.h index fae74604..52ffc8c3 100644 --- a/src/grove/grovebutton.h +++ b/src/grove/grovebutton.h @@ -33,7 +33,7 @@ * @con gpio * @kit gsk * - * @brief API for Grove button + * @brief API for Grove Button * * Very basic UPM module for Grove button * diff --git a/src/grove/grovelight.h b/src/grove/grovelight.h index f72d9dcb..189728c4 100644 --- a/src/grove/grovelight.h +++ b/src/grove/grovelight.h @@ -32,7 +32,7 @@ * @con analog * @kit gsk * - * @brief API for Grove light sensor + * @brief API for Grove Light Sensor * * The Grove light sensor detects the intensity of the ambient light. * As the light intensity of the environment increases, the resistance diff --git a/src/grove/groverotary.h b/src/grove/groverotary.h index 285320f9..534e1d1f 100644 --- a/src/grove/groverotary.h +++ b/src/grove/groverotary.h @@ -27,6 +27,7 @@ * @library grove * @sensor groverotary * @comname Grove Rotary Angle Sensor + * @altname Rotary Potentiometer * @type ainput * @man seeed * @con analog diff --git a/src/grove/grovetemp.h b/src/grove/grovetemp.h index a9b30efe..39aec8ec 100644 --- a/src/grove/grovetemp.h +++ b/src/grove/grovetemp.h @@ -32,7 +32,7 @@ * @con analog * @kit gsk * - * @brief API for Grove temperature sensor + * @brief API for Grove Temperature Sensor * * Very basic UPM module for Grove temperature sensor on analog * diff --git a/src/grovecollision/grovecollision.h b/src/grovecollision/grovecollision.h index 64488355..a68df72d 100644 --- a/src/grovecollision/grovecollision.h +++ b/src/grovecollision/grovecollision.h @@ -27,7 +27,7 @@ namespace upm { /** - * @brief UPM library for the Grove Collision Sensor + * @brief Grove Collision sensor library * @defgroup grovecollision libupm-grovecollision * @ingroup seeed gpio accelerometer */ diff --git a/src/groveeldriver/groveeldriver.h b/src/groveeldriver/groveeldriver.h index ce0f2461..a76e1f72 100644 --- a/src/groveeldriver/groveeldriver.h +++ b/src/groveeldriver/groveeldriver.h @@ -30,7 +30,7 @@ namespace upm { /** - * @brief UPM library for the Grove El Driver Module + * @brief Grove El Driver module library * @defgroup groveeldriver libupm-groveeldriver * @ingroup seeed gpio electric */ diff --git a/src/groveelectromagnet/groveelectromagnet.h b/src/groveelectromagnet/groveelectromagnet.h index 32d07268..dc2b4103 100644 --- a/src/groveelectromagnet/groveelectromagnet.h +++ b/src/groveelectromagnet/groveelectromagnet.h @@ -30,7 +30,7 @@ namespace upm { /** - * @brief UPM library for the Grove Electromagnet + * @brief Grove Electromagnet library * @defgroup groveelectromagnet libupm-groveelectromagnet * @ingroup seeed gpio electric */ diff --git a/src/groveemg/groveemg.h b/src/groveemg/groveemg.h index f1f4fa80..783f3247 100644 --- a/src/groveemg/groveemg.h +++ b/src/groveemg/groveemg.h @@ -28,7 +28,7 @@ namespace upm { /** - * @brief UPM library for the GroveEMG Muscle Signal reader sensor + * @brief GroveEMG Muscle Signal reader sensor library * @defgroup groveemg libupm-groveemg * @ingroup seeed analog electric */ diff --git a/src/grovegsr/grovegsr.h b/src/grovegsr/grovegsr.h index ca145683..b023b46f 100644 --- a/src/grovegsr/grovegsr.h +++ b/src/grovegsr/grovegsr.h @@ -28,7 +28,7 @@ namespace upm { /** - * @brief UPM library for the GroveGSR Galvanic Skin Response Sensor + * @brief GroveGSR Galvanic Skin Response sensor library * @defgroup grovegsr libupm-grovegsr * @ingroup seeed analog electric */ diff --git a/src/grovelinefinder/grovelinefinder.h b/src/grovelinefinder/grovelinefinder.h index 13f950b5..f4305bc4 100644 --- a/src/grovelinefinder/grovelinefinder.h +++ b/src/grovelinefinder/grovelinefinder.h @@ -28,7 +28,7 @@ namespace upm { /** - * @brief UPM library for the Grove Line Finder + * @brief Grove Line Finder sensor library * @defgroup grovelinefinder libupm-grovelinefinder * @ingroup seeed gpio color */ diff --git a/src/groveloudness/groveloudness.h b/src/groveloudness/groveloudness.h index 1cac82b3..2e5ff21f 100644 --- a/src/groveloudness/groveloudness.h +++ b/src/groveloudness/groveloudness.h @@ -28,7 +28,7 @@ namespace upm { /** - * @brief UPM library for the Grove Loudness Sensor + * @brief Grove Loudness sensor library * @defgroup groveloudness libupm-groveloudness * @ingroup seeed analog sound */ diff --git a/src/grovemd/grovemd.h b/src/grovemd/grovemd.h index d3502167..49640ac4 100644 --- a/src/grovemd/grovemd.h +++ b/src/grovemd/grovemd.h @@ -34,7 +34,7 @@ namespace upm { /** - * @brief UPM module for the Grove I2C Motor Driver + * @brief Grove I2C motor driver library * @defgroup grovemd libupm-grovemd * @ingroup seeed i2c motor */ diff --git a/src/grovemoisture/grovemoisture.h b/src/grovemoisture/grovemoisture.h index cf7fe59b..d4cdd1aa 100644 --- a/src/grovemoisture/grovemoisture.h +++ b/src/grovemoisture/grovemoisture.h @@ -28,7 +28,7 @@ namespace upm { /** - * @brief UPM library for the Grove Moisture Sensor + * @brief Grove Moisture sensor library * @defgroup grovemoisture libupm-grovemoisture * @ingroup seeed analog liquid */ diff --git a/src/groveo2/groveo2.h b/src/groveo2/groveo2.h index b4c82376..2efcb4ff 100644 --- a/src/groveo2/groveo2.h +++ b/src/groveo2/groveo2.h @@ -28,7 +28,7 @@ namespace upm { /** - * @brief UPM module for the GroveO2 Oxygen Gas Sensor + * @brief GroveO2 Oxygen Gas Sensor library * @defgroup groveo2 libupm-groveo2 * @ingroup seeed analog gaseous */ diff --git a/src/grovescam/grovescam.h b/src/grovescam/grovescam.h index 74c51ae2..8471ce5b 100644 --- a/src/grovescam/grovescam.h +++ b/src/grovescam/grovescam.h @@ -48,9 +48,9 @@ namespace upm { /** - * @brief UPM library for the Grove Serial Camera + * @brief Grove Serial Camera library * @defgroup grovescam libupm-grovescam - * @ingroup seeed serial + * @ingroup seeed serial */ /** @@ -131,7 +131,7 @@ namespace upm { * setup the proper tty i/o modes and the baudrate. The default * baud rate is 9600 (B9600) for this device. * - * @param baud the desired baud rate. + * @param baud the desired baud rate. * @return true if successful */ bool setupTty(speed_t baud=B115200); diff --git a/src/grovespeaker/grovespeaker.h b/src/grovespeaker/grovespeaker.h index a8b9d3b7..6e1b49e2 100644 --- a/src/grovespeaker/grovespeaker.h +++ b/src/grovespeaker/grovespeaker.h @@ -33,7 +33,7 @@ namespace upm { /** - * @brief UPM library for the Grove Speaker + * @brief Grove Speaker library * @defgroup grovespeaker libupm-grovespeaker * @ingroup seeed gpio sound */ diff --git a/src/grovevdiv/grovevdiv.h b/src/grovevdiv/grovevdiv.h index 6e2cf735..c2732066 100644 --- a/src/grovevdiv/grovevdiv.h +++ b/src/grovevdiv/grovevdiv.h @@ -36,7 +36,7 @@ namespace upm { /** - * @brief UPM library for the Grove Voltage Divider + * @brief Grove Voltage Divider sensor library * @defgroup grovevdiv libupm-grovevdiv * @ingroup seeed analog electric */ diff --git a/src/grovewater/grovewater.h b/src/grovewater/grovewater.h index dcd5eea8..be8eab11 100644 --- a/src/grovewater/grovewater.h +++ b/src/grovewater/grovewater.h @@ -28,7 +28,7 @@ namespace upm { /** - * @brief UPM library for the Grove Water Sensor + * @brief Grove Water sensor library * @defgroup grovewater libupm-grovewater * @ingroup seeed gpio liquid */ diff --git a/src/grovewfs/grovewfs.h b/src/grovewfs/grovewfs.h index a4832ca1..d34ba08f 100644 --- a/src/grovewfs/grovewfs.h +++ b/src/grovewfs/grovewfs.h @@ -31,7 +31,7 @@ namespace upm { /** - * @brief UPM module for the Grove Water Flow sensor + * @brief Grove Water Flow sensor library * @defgroup grovewfs libupm-grovewfs * @ingroup seeed gpio liquid */ diff --git a/src/guvas12d/guvas12d.h b/src/guvas12d/guvas12d.h index db3ae2fb..41065e25 100644 --- a/src/guvas12d/guvas12d.h +++ b/src/guvas12d/guvas12d.h @@ -28,7 +28,7 @@ namespace upm { /** - * @brief UPM library for the GUVA-S12D Sensor + * @brief GUVA-S12D UV sensor library * @defgroup guvas12d libupm-guvas12d * @ingroup seeed analog light */ @@ -37,7 +37,7 @@ namespace upm { * @library guvas12d * @sensor guvas12d * @comname Grove UV Sensor - * @altname GUVA-S12D + * @altname GUVA-S12D UV Sensor * @type light * @man seeed * @con analog diff --git a/src/h3lis331dl/h3lis331dl.h b/src/h3lis331dl/h3lis331dl.h index 4b9adc6e..d1a1e9b8 100644 --- a/src/h3lis331dl/h3lis331dl.h +++ b/src/h3lis331dl/h3lis331dl.h @@ -32,7 +32,7 @@ namespace upm { /** - * @brief Grove 3-axis I2C Accelerometer (400G) + * @brief H3LIS331DL I2C accelerometer (400g) library * @defgroup h3lis331dl libupm-h3lis331dl * @ingroup seeed i2c accelerometer */ @@ -40,14 +40,16 @@ namespace upm { /** * @library h3lis331dl * @sensor h3lis331dl - * @comname Grove 3-axis I2C Accelerometer (400G) + * @comname H3LIS331DL 3-Axis Digital Accelerometer + * @altname Grove 3-Axis Digital Accelerometer (400g) * @type accelerometer * @man seeed * @web http://www.seeedstudio.com/depot/Grove-3Axis-Digital-Accelerometer400g-p-1897.html * @con i2c * - * @brief API for the H3LIS331DL based Grove 3-axis I2C Accelerometer - * (400G) + * @brief API for the H3LIS331DL based Grove 3-axis I2C (400G) + * + * This is a high performance, high range accelerometer for extreme applications. * * @image html h3lis331dl.jpg * @snippet h3lis331dl.cxx Interesting diff --git a/src/hm11/hm11.h b/src/hm11/hm11.h index 467f892e..e5b5f274 100644 --- a/src/hm11/hm11.h +++ b/src/hm11/hm11.h @@ -47,7 +47,7 @@ namespace upm { /** - * @brief UPM library for the HM-11 Bluetooth 4.0 Low Energy Module + * @brief HM-11 Bluetooth 4.0 Low Energy module library * @defgroup hm11 libupm-hm11 * @ingroup seeed serial wifi */ @@ -55,8 +55,9 @@ namespace upm { /** * @library hm11 * @sensor hm11 - * @comname HM-11 Bluetooth 4.0 Low Energy Module + * @comname HM-11 Bluetooth Low Energy * @altname HM-10, HM-12 + * @altname Grove BLE * @category wifi * @manufacturer seeed * @connection uart @@ -73,7 +74,7 @@ namespace upm { * * It is connected via a UART at 9600 baud. * - * @image html hm11.jpg + * @image html hm11.jpg * @snippet hm11.cxx Interesting */ @@ -125,7 +126,7 @@ namespace upm { * setup the proper tty i/o modes and the baudrate. The default * baud rate is 9600 (B9600) for this device. * - * @param baud the desired baud rate. + * @param baud the desired baud rate. * @return true if successful */ bool setupTty(speed_t baud=B9600); diff --git a/src/hmc5883l/hmc5883l.h b/src/hmc5883l/hmc5883l.h index 7fc4b432..d5af6798 100644 --- a/src/hmc5883l/hmc5883l.h +++ b/src/hmc5883l/hmc5883l.h @@ -39,7 +39,8 @@ namespace upm { /** * @library hmc5883l * @sensor hmc5883l - * @comname Hmc5883l 3-Axis Digital Compass + * @comname HMC5883L 3-Axis Digital Compass + * @altname Grove 3-Axis Digital Compass * @type compass * @man seeed * @con i2c diff --git a/src/ht9170/ht9170.h b/src/ht9170/ht9170.h index 8638404f..9c842f19 100644 --- a/src/ht9170/ht9170.h +++ b/src/ht9170/ht9170.h @@ -29,7 +29,7 @@ namespace upm { /** - * @brief UPM library for the HT9170 DTMF Decoder + * @brief HT9170 DTMF decoder library * @defgroup ht9170 libupm-ht9170 * @ingroup seeed gpio other */ diff --git a/src/hx711/hx711.h b/src/hx711/hx711.h index 7e5692a5..e81bfdb9 100644 --- a/src/hx711/hx711.h +++ b/src/hx711/hx711.h @@ -37,7 +37,7 @@ namespace upm { /** * @library hx711 * @sensor hx711 - * @comname HX711 24bit Analog-to-Digital Converter + * @comname HX711 Analog-to-Digital Converter * @type electric * @man generic * @web http://www.dfrobot.com/image/data/SEN0160/hx711_english.pdf diff --git a/src/ina132/ina132.h b/src/ina132/ina132.h index 14b1515a..2774a46c 100644 --- a/src/ina132/ina132.h +++ b/src/ina132/ina132.h @@ -28,7 +28,7 @@ namespace upm { /** - * @brief UPM library for the INA132 Differential Amplifier Sensor + * @brief INA132 differential amplifier sensor library * @defgroup ina132 libupm-ina132 * @ingroup seeed analog electric */ @@ -36,7 +36,7 @@ namespace upm { * @library ina132 * @sensor ina132 * @comname Grove Differential Amplifier - * @altname INA132 + * @altname INA132 * @type electric * @man seeed * @con analog diff --git a/src/isd1820/isd1820.h b/src/isd1820/isd1820.h index 24e8f009..bdea3347 100644 --- a/src/isd1820/isd1820.h +++ b/src/isd1820/isd1820.h @@ -29,7 +29,7 @@ namespace upm { /** - * @brief UPM support for the ISD1820 based Grove Recorder + * @brief ISD1820 recorder module library * @defgroup isd1820 libupm-isd1820 * @ingroup seeed gpio sound */ @@ -37,7 +37,8 @@ namespace upm { /** * @library libupm-isd1820 * @sensor isd1820 - * @comname Grove Recorder v1.0 + * @comname Grove Recorder + * @altname ISD1820 Recorder * @type sound * @man seeed * @con gpio diff --git a/src/itg3200/itg3200.h b/src/itg3200/itg3200.h index c5fef329..0760a2b4 100644 --- a/src/itg3200/itg3200.h +++ b/src/itg3200/itg3200.h @@ -30,7 +30,7 @@ namespace upm { /** - * @brief Itg3200 gyroscope library + * @brief ITG3200 gyroscope library * @defgroup itg3200 libupm-itg3200 * @ingroup seeed i2c compass */ @@ -38,12 +38,13 @@ namespace upm { /** * @library itg3200 * @sensor itg3200 - * @comname Itg3200 3-Axis Digital Gyroscope + * @comname ITG3200 3-Axis Digital Gyroscope + * @altname Grove 3-Axis Digital Gyroscope * @type compass * @man seeed * @con i2c * - * @brief API for Itg3200 (3-axis digital gyroscope) + * @brief API for Itg3200 (3-Axis Digital Gyroscope) * * The InvenSense Itg3200 is a 3-axis digital gyroscope. * (https://www.sparkfun.com/datasheets/Sensors/Gyro/PS-ITG-3200-00-01.4.pdf) diff --git a/src/joystick12/joystick12.h b/src/joystick12/joystick12.h index 7fe32017..8389c8b8 100644 --- a/src/joystick12/joystick12.h +++ b/src/joystick12/joystick12.h @@ -45,9 +45,10 @@ namespace upm { * * @brief API for Elecfreaks Joystick v 1.2-1.4 breakout * - * This file defines the Joystick API and implemntation for X, Y + * This file defines the Joystick API and implementation for X, Y * button could be treated as normal GPIO, this enables easier - * interrupt support + * interrupt support. This driver should be compatible with any + * 2 axis analog joystick. * * @image html joystick12.jpg * @snippet joystick12-example.cxx Interesting diff --git a/src/l298/l298.h b/src/l298/l298.h index 0ad654e1..86b7cc2c 100644 --- a/src/l298/l298.h +++ b/src/l298/l298.h @@ -34,7 +34,7 @@ namespace upm { /** - * @brief UPM library for the L298 Dual H-Bridge Motor Driver + * @brief L298 dual H-bridge motor driver library * @defgroup l298 libupm-l298 * @ingroup seeed sparkfun gpio pwm motor */ diff --git a/src/lcd/i2clcd.h b/src/lcd/i2clcd.h index 42a4d21a..2063280a 100644 --- a/src/lcd/i2clcd.h +++ b/src/lcd/i2clcd.h @@ -76,7 +76,7 @@ const uint8_t LCD_RW = 0x02; // Read/Write bit const uint8_t LCD_RS = 0x01; // Register select bit /** - * @brief i2c LCD display library + * @brief I2C LCD display library * @defgroup i2clcd libupm-i2clcd * @ingroup seeed sparkfun adafruit i2c display gsk */ diff --git a/src/ldt0028/ldt0028.h b/src/ldt0028/ldt0028.h index be9664e4..46b4240a 100644 --- a/src/ldt0028/ldt0028.h +++ b/src/ldt0028/ldt0028.h @@ -29,7 +29,7 @@ namespace upm { /** - * @brief LDT0-028 Piezo Vibration sensor library + * @brief LDT0-028 piezo vibration sensor library * @defgroup ldt0028 libupm-ldt0028 * @ingroup seeed analog flexfor */ diff --git a/src/lol/lol.h b/src/lol/lol.h index a2ac5bcd..c6025d65 100644 --- a/src/lol/lol.h +++ b/src/lol/lol.h @@ -49,7 +49,7 @@ namespace upm { * * @brief API for Olimex LoL array * - * This file defines the LoL API and implemntation for a simple framebuffer + * This file defines the LoL API and implementation for a simple frame buffer. * * @snippet lol-example.cxx Interesting */ diff --git a/src/lsm303/lsm303.h b/src/lsm303/lsm303.h index 5e1fc3e3..a848dcaa 100644 --- a/src/lsm303/lsm303.h +++ b/src/lsm303/lsm303.h @@ -76,7 +76,7 @@ namespace upm { * @web http://www.seeedstudio.com/wiki/Grove_-_6-Axis_Accelerometer%26Compass * @con i2c * - * @brief API for LSM303 + * @brief API for LSM303 Accelerometer & Compass * * This file defines the LSM303DLH 3-axis magnetometer/3-axis accelerometer. * This module was tested with the SeedStudio Grove [6-Axis Accelerometer&Compass] diff --git a/src/max31723/max31723.h b/src/max31723/max31723.h index 4063081a..eac7f986 100644 --- a/src/max31723/max31723.h +++ b/src/max31723/max31723.h @@ -34,19 +34,19 @@ namespace upm { /** - * @brief max31723 temperature sensor library + * @brief MAX31723 temperature sensor library * @defgroup max31723 libupm-max31723 * @ingroup maxim spi temperature */ /** * @library max31723 * @sensor max31723 - * @comname max31723 temperature sensor + * @comname MAX31723 Temperature Sensor * @type temperature * @man maxim * @con spi * - * @brief API for MAX31723 chip (Temperature sensor) + * @brief API for MAX31723 chip (Temperature Sensor) * * The Maxim Integrated * [MAX31723](http://datasheets.maximintegrated.com/en/ds/MAX31722-MAX31723.pdf) diff --git a/src/max31855/max31855.h b/src/max31855/max31855.h index 9dc7559b..311f0bb2 100644 --- a/src/max31855/max31855.h +++ b/src/max31855/max31855.h @@ -30,19 +30,19 @@ namespace upm { /** - * @brief max31855 thermocouple library + * @brief MAX31855 thermocouple library * @defgroup max31855 libupm-max31855 - * @ingroup maxim spi other + * @ingroup maxim adafruit spi other */ /** * @library max31855 * @sensor max31855 - * @comname max31855 thermocouple library + * @comname MAX31855 Thermocouple Amplifier * @type other - * @man maxim + * @man maxim adafruit * @con spi * - * @brief API for MAX31855 + * @brief API for MAX31855 Thermocouple Amplifier * * The Maxim Integrated * [MAX31855](http://datasheets.maximintegrated.com/en/ds/MAX31855.pdf) diff --git a/src/max44000/max44000.h b/src/max44000/max44000.h index e63ec46a..1191a350 100644 --- a/src/max44000/max44000.h +++ b/src/max44000/max44000.h @@ -53,14 +53,14 @@ namespace upm { /** - * @brief max44000 proxmity sensor library + * @brief MAX44000 proximity sensor library * @defgroup max44000 libupm-max44000 * @ingroup maxim i2c light */ /** * @library max44000 * @sensor max44000 - * @comname max44000 proximity sensor + * @comname MAX44000 Proximity Sensor * @type light * @man maxim * @con i2c diff --git a/src/max5487/max5487.h b/src/max5487/max5487.h index 4ae29f1a..c1ad4b65 100644 --- a/src/max5487/max5487.h +++ b/src/max5487/max5487.h @@ -34,19 +34,19 @@ namespace upm { /** - * @brief max5847 digital potentiometer library - * @defgroup max5847 libupm-max5847 + * @brief MAX5487 digital potentiometer library + * @defgroup max5487 libupm-max5487 * @ingroup maxim spi digipot */ /** - * @library max5847 - * @sensor max5847 - * @comname max5847 potentiometer sensor + * @library max5487 + * @sensor max5487 + * @comname MAX5487 Digital Potentiometer * @type digipot * @man maxim * @con spi * - * @brief API for MAX5487 chip (SPI digital potentionmeter) + * @brief API for MAX5487 chip (SPI digital potentiometer) * * The Maxim Integrated * [MAX5487](http://datasheets.maximintegrated.com/en/ds/MAX5487-MAX5489.pdf) @@ -55,7 +55,7 @@ namespace upm { * PMOD module](http://datasheets.maximintegrated.com/en/ds/MAX5487PMB1.pdf) * from the analog PMOD kit. * - * @snippet max5847.cxx Interesting + * @snippet max5487.cxx Interesting */ class MAX5487 { public: diff --git a/src/maxds3231m/maxds3231m.h b/src/maxds3231m/maxds3231m.h index 51c4cb1e..9b3c53dc 100644 --- a/src/maxds3231m/maxds3231m.h +++ b/src/maxds3231m/maxds3231m.h @@ -63,21 +63,21 @@ struct Time3231 { }; /** - * @brief maxds3231m proximity sensor library + * @brief MAXDS3231M proximity sensor library * @defgroup maxds3231m libupm-maxds3231m * @ingroup maxim i2c light */ /** * @library maxds3231m * @sensor maxds3231m - * @comname maxds3231m proximity sensor + * @comname MAXDS3231M Real-Time Clock * @type light * @man maxim * @con i2c * - * @brief API for MAXDS3231M chip (Ambient and Infrared Proximity Sensor) + * @brief API for MAXDS3231M chip (I2C Real-Time Clock) * - * This file defines the maxds3231m interface for maxds3231m + * This file defines the API for maxds3231m * * @snippet maxds3231m.cxx Interesting */ diff --git a/src/maxsonarez/maxsonarez.h b/src/maxsonarez/maxsonarez.h index eba36e22..81dace1f 100644 --- a/src/maxsonarez/maxsonarez.h +++ b/src/maxsonarez/maxsonarez.h @@ -32,7 +32,7 @@ namespace upm { /** - * @brief UPM library for the MaxSonar-EZ family of ultrasonic rangers + * @brief MaxSonar-EZ family of ultrasonic rangers library * @defgroup maxsonarez libupm-maxsonarez * @ingroup seeed analog sound */ @@ -40,7 +40,7 @@ namespace upm { /** * @library maxsonarez * @sensor maxsonarez - * @comname LV-MaxSonar-EZ family of ultrasonic rangers + * @comname LV-MaxSonar-EZ Ultrasonic Ranger * @altname EZ1, EZ2, EZ3, EZ4 * @type sound * @man sparkfun diff --git a/src/mhz16/mhz16.h b/src/mhz16/mhz16.h index a17e0515..93daaf90 100644 --- a/src/mhz16/mhz16.h +++ b/src/mhz16/mhz16.h @@ -55,8 +55,9 @@ namespace upm { /** * @library mhz16 - * @sensor mhz16 - * @comname Grove CO2 sensor + * @sensor mhz16 + * @comname Grove CO2 Sensor + * @altname MHZ16 Serial CO2 Sensor * @type gaseous * @man seeed * @con uart @@ -67,14 +68,14 @@ namespace upm { * * It's CO2 detection ranges from 0PPM to 2000PPM. It requires a * 2-3 minute warm up time before reporting valid data. - * + * * @image html mhz16.jpg * @snippet mhz16.cxx Interesting */ class MHZ16 { public: - + /** * MHZ16 module constructor * @@ -120,7 +121,7 @@ namespace upm { * setup the proper tty i/o modes and the baudrate. The default * baud rate is 9600 (B9600). * - * @param baud the desired baud rate. + * @param baud the desired baud rate. * @return true if successful */ bool setupTty(speed_t baud=B9600); diff --git a/src/mic/mic.h b/src/mic/mic.h index 1466255d..db49b634 100644 --- a/src/mic/mic.h +++ b/src/mic/mic.h @@ -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 */ @@ -44,6 +44,7 @@ namespace upm { * @library mic * @sensor mic * @comname Analog Microphone + * @altname Grove Sound Sensor * @type sound * @man seeed * @web http://www.seeedstudio.com/wiki/Grove_-_Sound_Sensors diff --git a/src/mlx90614/mlx90614.h b/src/mlx90614/mlx90614.h index 309952c9..209a4860 100644 --- a/src/mlx90614/mlx90614.h +++ b/src/mlx90614/mlx90614.h @@ -53,14 +53,14 @@ namespace upm { /** - * @brief mlx90614 temperature sensor library + * @brief MLX90614 temperature sensor library * @defgroup mlx90614 libupm-mlx90614 * @ingroup generic i2c temperature */ /** * @library mlx90614 * @sensor mlx90614 - * @comname mlx90614 temperature sensor + * @comname MLX90614 Temperature Sensor * @type temperature * @man generic * @con i2c diff --git a/src/mma7455/mma7455.h b/src/mma7455/mma7455.h index 02ec36d1..3df18923 100644 --- a/src/mma7455/mma7455.h +++ b/src/mma7455/mma7455.h @@ -150,14 +150,14 @@ union accelData { #define BIT(n) (1<