From 8614cb322adc546191367cdb2900f56026cd2590 Mon Sep 17 00:00:00 2001 From: Mihai Tudor Panu Date: Mon, 1 Jun 2015 10:56:03 -0700 Subject: [PATCH] docs: removed C++ references from documentation to make API language agnostic Signed-off-by: Mihai Tudor Panu --- src/a110x/a110x.h | 2 +- src/adafruitms1438/adafruitms1438.h | 2 +- src/adafruitss/adafruitss.h | 2 +- src/adc121c021/adc121c021.h | 2 +- src/adis16448/adis16448.h | 2 +- src/adxl335/adxl335.h | 2 +- src/adxl345/adxl345.h | 2 +- src/am2315/am2315.h | 2 +- src/at42qt1070/at42qt1070.h | 2 +- src/biss0001/biss0001.h | 2 +- src/bmpx8x/bmpx8x.h | 2 +- src/buzzer/buzzer.h | 4 ++-- src/cjq4435/cjq4435.h | 2 +- src/ds1307/ds1307.h | 2 +- src/ecs1030/ecs1030.h | 2 +- src/enc03r/enc03r.h | 2 +- src/flex/flex.h | 2 +- src/gas/mq2.h | 2 +- src/gas/mq3.h | 2 +- src/gas/mq5.h | 2 +- src/gas/mq9.h | 2 +- src/gas/tp401.h | 2 +- src/gp2y0a/gp2y0a.h | 2 +- src/grove/grove.h | 14 +++++++------- src/grove/grovebutton.h | 2 +- src/grove/groveled.h | 2 +- src/grove/grovelight.h | 2 +- src/grove/groverelay.h | 2 +- src/grove/groverotary.h | 2 +- src/grove/groveslide.h | 2 +- src/grove/grovetemp.h | 2 +- src/grovecollision/grovecollision.h | 2 +- src/groveehr/groveehr.h | 2 +- src/groveeldriver/groveeldriver.h | 2 +- src/groveelectromagnet/groveelectromagnet.h | 2 +- src/groveemg/groveemg.h | 2 +- src/grovegsr/grovegsr.h | 2 +- src/grovelinefinder/grovelinefinder.h | 2 +- src/groveloudness/groveloudness.h | 2 +- src/grovemd/grovemd.h | 2 +- src/grovemoisture/grovemoisture.h | 2 +- src/groveo2/groveo2.h | 2 +- src/grovescam/grovescam.h | 2 +- src/grovespeaker/grovespeaker.h | 2 +- src/grovevdiv/grovevdiv.h | 2 +- src/grovewater/grovewater.h | 2 +- src/grovewfs/grovewfs.h | 2 +- src/guvas12d/guvas12d.h | 2 +- src/h3lis331dl/h3lis331dl.h | 2 +- src/hcsr04/hcsr04.h | 4 ++-- src/hm11/hm11.h | 2 +- src/hmc5883l/hmc5883l.h | 2 +- src/hmtrp/hmtrp.h | 2 +- src/ht9170/ht9170.h | 2 +- src/htu21d/htu21d.h | 2 +- src/hx711/hx711.h | 2 +- src/ina132/ina132.h | 2 +- src/isd1820/isd1820.h | 2 +- src/itg3200/itg3200.h | 2 +- src/joystick12/joystick12.h | 2 +- src/l298/l298.h | 2 +- src/lcd/jhd1313m1.h | 2 +- src/lcd/lcm1602.h | 2 +- src/lcd/ssd1308.h | 2 +- src/lcd/ssd1327.h | 2 +- src/ldt0028/ldt0028.h | 4 ++-- src/lol/lol.h | 2 +- src/lpd8806/lpd8806.h | 2 +- src/lsm303/lsm303.h | 2 +- src/max31723/max31723.h | 2 +- src/max31855/max31855.h | 2 +- src/max44000/max44000.h | 2 +- src/max5487/max5487.h | 2 +- src/maxds3231m/maxds3231m.h | 4 ++-- src/maxsonarez/maxsonarez.h | 2 +- src/mhz16/mhz16.h | 2 +- src/mic/mic.h | 2 +- src/mlx90614/mlx90614.h | 4 ++-- src/mma7455/mma7455.h | 4 ++-- src/mma7660/mma7660.h | 2 +- src/mpl3115a2/mpl3115a2.h | 2 +- src/mpr121/mpr121.h | 4 ++-- src/mpu9150/mpu9150.h | 4 ++-- src/mq303a/mq303a.h | 2 +- src/my9221/my9221.h | 4 ++-- src/nrf24l01/nrf24l01.h | 4 ++-- src/nrf8001/nrf8001.h | 2 +- src/nunchuck/nunchuck.h | 2 +- src/otp538u/otp538u.h | 2 +- src/pca9685/pca9685.h | 2 +- src/ppd42ns/ppd42ns.h | 2 +- src/rfr359f/rfr359f.h | 2 +- src/rotaryencoder/rotaryencoder.h | 2 +- src/rpr220/rpr220.h | 2 +- src/servo/es08a.h | 4 ++-- src/si114x/si114x.h | 2 +- src/sm130/sm130.h | 4 ++-- src/st7735/st7735.h | 8 ++++---- src/stepmotor/stepmotor.h | 8 ++++---- src/sx6119/sx6119.h | 2 +- src/ta12200/ta12200.h | 4 ++-- src/tcs3414cs/tcs3414cs.h | 8 ++++---- src/th02/th02.h | 8 ++++---- src/tm1637/tm1637.h | 2 +- src/ublox6/ublox6.h | 4 ++-- src/waterlevel/waterlevel.h | 2 +- src/wt5001/wt5001.h | 4 ++-- src/yg1006/yg1006.h | 2 +- src/zfm20/zfm20.h | 2 +- 109 files changed, 142 insertions(+), 142 deletions(-) diff --git a/src/a110x/a110x.h b/src/a110x/a110x.h index 56145ea8..7c8b28b7 100644 --- a/src/a110x/a110x.h +++ b/src/a110x/a110x.h @@ -43,7 +43,7 @@ namespace upm { * @web http://www.allegromicro.com/en/Products/Magnetic-Digital-Position-Sensor-ICs/Hall-Effect-Unipolar-Switches/A1101-2-3-4-6.aspx * @con gpio * - * @brief C++ API for the A110X Hall Effect sensors + * @brief API for the A110X Hall Effect sensors * * UPM module for the A110X (A1101, A1102, A1103, A1104, and A1106) * Hall Effect sensors. It outputs a digital signal indicating diff --git a/src/adafruitms1438/adafruitms1438.h b/src/adafruitms1438/adafruitms1438.h index fa21720c..5123a96f 100644 --- a/src/adafruitms1438/adafruitms1438.h +++ b/src/adafruitms1438/adafruitms1438.h @@ -52,7 +52,7 @@ namespace upm { * @web http://www.adafruit.com/products/1438 * @con i2c * - * @brief C++ API for the ADAFRUITMS1438 motor shield + * @brief API for the ADAFRUITMS1438 motor shield * * This class implements support for the stepper and DC motors that * can be connected to this Motor Shield. diff --git a/src/adafruitss/adafruitss.h b/src/adafruitss/adafruitss.h index 6d286a49..db259e72 100644 --- a/src/adafruitss/adafruitss.h +++ b/src/adafruitss/adafruitss.h @@ -70,7 +70,7 @@ namespace upm { * @web http://www.adafruit.com/product/1411 * @con i2c * - * @brief C++ API for Adafruit Servo Shield + * @brief API for Adafruit Servo Shield * * UPM library for the PCA9685 based Adafruit 16-channel servo shield. When 3 * or more GWS servos attached results unpredictable. Adafruit do recommend a diff --git a/src/adc121c021/adc121c021.h b/src/adc121c021/adc121c021.h index 24408cf7..058a8c66 100644 --- a/src/adc121c021/adc121c021.h +++ b/src/adc121c021/adc121c021.h @@ -78,7 +78,7 @@ namespace upm { * @web http://www.seeedstudio.com/depot/Grove-I2C-ADC-p-1580.html * @con i2c * - * @brief C++ API for the ADC121C021 I2C ADC + * @brief API for the ADC121C021 I2C ADC * * UPM module for the ADC121C021 12 bit Analog to Digital (ADC) converter. * By providing a constant reference voltage, this sensor helps diff --git a/src/adis16448/adis16448.h b/src/adis16448/adis16448.h index e990b740..0d9770c6 100644 --- a/src/adis16448/adis16448.h +++ b/src/adis16448/adis16448.h @@ -98,7 +98,7 @@ namespace upm { * @web http://www.analog.com/en/products/sensors/isensor-mems-inertial-measurement-units/adis16448.html * @con spi * - * @brief C++ API for Analog Devices ADIS16448 + * @brief API for Analog Devices ADIS16448 * * This is an industrial grade accelerometer by Analog Devices. * diff --git a/src/adxl335/adxl335.h b/src/adxl335/adxl335.h index aebda8d0..0b71a333 100644 --- a/src/adxl335/adxl335.h +++ b/src/adxl335/adxl335.h @@ -48,7 +48,7 @@ namespace upm { * @man seeed * @con analog * - * @brief C++ API for the ADXL335 3-axis Analog Accelerometer + * @brief API for the ADXL335 3-axis Analog Accelerometer * * UPM module for the ADXL335 3-axis analog accelerometer. This * was tested on a Grove 3-axis Analog Accelerometer. It uses 3 diff --git a/src/adxl345/adxl345.h b/src/adxl345/adxl345.h index df0ae7dd..8fe5401d 100644 --- a/src/adxl345/adxl345.h +++ b/src/adxl345/adxl345.h @@ -43,7 +43,7 @@ namespace upm { * @man seeed * @con i2c * - * @brief C++ API for Adxl345 (3-axis digital accelerometer) + * @brief API for Adxl345 (3-axis digital accelerometer) * * The Adxl345 is a 3-axis digital accelerometer. * (http://www.seeedstudio.com/wiki/images/2/2c/ADXL345_datasheet.pdf) diff --git a/src/am2315/am2315.h b/src/am2315/am2315.h index 095e6044..5be6e5ed 100644 --- a/src/am2315/am2315.h +++ b/src/am2315/am2315.h @@ -64,7 +64,7 @@ namespace upm { * @web http://www.adafruit.com/products/1293 * @con i2c * - * @brief C++ API for AM2315 chip (Temperature & Humidity Sensor) + * @brief API for AM2315 chip (Temperature & Humidity Sensor) * * Measurement Specialties [AM2315] * (http://www.aosong.com/asp_bin/Products/en/AM2315.pdf) diff --git a/src/at42qt1070/at42qt1070.h b/src/at42qt1070/at42qt1070.h index 104f0a14..549bc44f 100644 --- a/src/at42qt1070/at42qt1070.h +++ b/src/at42qt1070/at42qt1070.h @@ -48,7 +48,7 @@ namespace upm { * @man seeed * @con i2c * - * @brief C++ API for the Atmel AT42QT1070 QTouch sensor + * @brief API for the Atmel AT42QT1070 QTouch sensor * * This class implements support for the Atmel AT42QT1070 QTouch * sensor, which supports 7 capacitive buttons. diff --git a/src/biss0001/biss0001.h b/src/biss0001/biss0001.h index b1924f6f..d34e3b60 100644 --- a/src/biss0001/biss0001.h +++ b/src/biss0001/biss0001.h @@ -42,7 +42,7 @@ namespace upm { * @web http://www.seeedstudio.com/depot/Grove-PIR-Motion-Sensor-p-802.html * @con gpio * - * @brief C++ API for the BISS0001 Motion Sensor + * @brief API for the BISS0001 Motion Sensor * * UPM module for the BISS0001 Motion Sensor * diff --git a/src/bmpx8x/bmpx8x.h b/src/bmpx8x/bmpx8x.h index e0430c23..116daada 100644 --- a/src/bmpx8x/bmpx8x.h +++ b/src/bmpx8x/bmpx8x.h @@ -76,7 +76,7 @@ namespace upm { * @man seeed adafruit sparkfun * @con i2c * - * @brief C++ API for GY65/BMP085 and BMP180 chips (Atmospheric Pressure Sensor) + * @brief API for GY65/BMP085 and BMP180 chips (Atmospheric Pressure Sensor) * * The Bosch GY65/BMP085 and BMP180 are high precision, ultra-low * power consumption pressure sensors. They have a range of between diff --git a/src/buzzer/buzzer.h b/src/buzzer/buzzer.h index 0210e7d1..3aa0867e 100644 --- a/src/buzzer/buzzer.h +++ b/src/buzzer/buzzer.h @@ -51,9 +51,9 @@ namespace upm { * @con pwm * @kit gsk * - * @brief C++ API for Buzzer component + * @brief API for Buzzer component * - * This file defines the Buzzer C++ interface for libbuzzer. + * This file defines the Buzzer interface for libbuzzer. * This sensor can make different tones when connected to * a pin capable of analog pulse-width modulation. It emits * sound using a piezoelectric material that vibrates at different diff --git a/src/cjq4435/cjq4435.h b/src/cjq4435/cjq4435.h index 83580d12..b2e76427 100644 --- a/src/cjq4435/cjq4435.h +++ b/src/cjq4435/cjq4435.h @@ -41,7 +41,7 @@ namespace upm { * @man seeed * @con gpio pwm * - * @brief C++ API for the CJQ4435 MOSFET + * @brief API for the CJQ4435 MOSFET * * UPM module for the CJQ4435 MOSFET. It was developed using the * Grove MOSFET module. A MOSFET is like a switch, but it can diff --git a/src/ds1307/ds1307.h b/src/ds1307/ds1307.h index d77a5328..48e3e28e 100644 --- a/src/ds1307/ds1307.h +++ b/src/ds1307/ds1307.h @@ -57,7 +57,7 @@ namespace upm { * @man seeed * @con i2c * - * @brief C++ API for the DS1307 Real Time CLock + * @brief API for the DS1307 Real Time CLock * * UPM module for the DS1307 based RTC. The clock can provide information * about the seconds, minutes, hours, day of the week, day of the month, diff --git a/src/ecs1030/ecs1030.h b/src/ecs1030/ecs1030.h index c097683d..b95c1b3d 100644 --- a/src/ecs1030/ecs1030.h +++ b/src/ecs1030/ecs1030.h @@ -55,7 +55,7 @@ namespace upm { * @man sparkfun * @con analog * - * @brief C++ API for the ECS1030 Non-Invasive Current/Electricity Sensor + * @brief API for the ECS1030 Non-Invasive Current/Electricity Sensor * * This non-invasive current sensor can be clamped around the supply line of * an electrical load to tell you how much current is passing through it. It diff --git a/src/enc03r/enc03r.h b/src/enc03r/enc03r.h index 31a4359e..7e683c13 100644 --- a/src/enc03r/enc03r.h +++ b/src/enc03r/enc03r.h @@ -43,7 +43,7 @@ namespace upm { * @man seeed * @con analog * - * @brief C++ API for the ENC03R Single Axis Analog Gyro + * @brief API for the ENC03R Single Axis Analog Gyro * * UPM module for the ENC03R Single Axis Analog Gyro. * This gyroscope measures the x-axis angular velocity; that is, diff --git a/src/flex/flex.h b/src/flex/flex.h index d64ac071..d2f22404 100644 --- a/src/flex/flex.h +++ b/src/flex/flex.h @@ -42,7 +42,7 @@ namespace upm { * @man sparkfun * @con analog * - * @brief C++ API for the Spectra Symbol Flex sensor + * @brief API for the Spectra Symbol Flex sensor * * A simple flex sensor, the resistance across the sensor increases when * bent. Patented technology by Spectra Symbol, these sensors were used in diff --git a/src/gas/mq2.h b/src/gas/mq2.h index 08175676..dea06bca 100644 --- a/src/gas/mq2.h +++ b/src/gas/mq2.h @@ -36,7 +36,7 @@ namespace upm { * @man seeed * @con analog * - * @brief C++ 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 aa31a591..ce44a9e6 100644 --- a/src/gas/mq3.h +++ b/src/gas/mq3.h @@ -36,7 +36,7 @@ namespace upm { * @man seeed * @con analog * - * @brief C++ 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 f8ab0c9e..1c3cc161 100644 --- a/src/gas/mq5.h +++ b/src/gas/mq5.h @@ -36,7 +36,7 @@ namespace upm { * @man seeed * @con analog * - * @brief C++ 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 809718be..3c4e4bb8 100644 --- a/src/gas/mq9.h +++ b/src/gas/mq9.h @@ -36,7 +36,7 @@ namespace upm { * @man seeed * @con analog * - * @brief C++ 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 de5070a4..43cb5eac 100644 --- a/src/gas/tp401.h +++ b/src/gas/tp401.h @@ -37,7 +37,7 @@ namespace upm { * @man seeed * @con analog * - * @brief C++ API for Grove TP401 Air Quality Sensor + * @brief API for Grove TP401 Air Quality Sensor * * The Grove TP401 Air Quality Sensor module is useful for monitoring air purity indoors. * It can detect CO and a wide range of other harmful gases, but due to limited sensing diff --git a/src/gp2y0a/gp2y0a.h b/src/gp2y0a/gp2y0a.h index 2281955a..1b89edf1 100644 --- a/src/gp2y0a/gp2y0a.h +++ b/src/gp2y0a/gp2y0a.h @@ -42,7 +42,7 @@ namespace upm { * @man seeed * @con analog * - * @brief C++ API for the GP2Y0A family of IR Proximity Sensors + * @brief API for the GP2Y0A family of IR Proximity Sensors * * This sensor family returns an analog voltage corresponding to the distance * of an object from the sensor. The voltage is lower when objects diff --git a/src/grove/grove.h b/src/grove/grove.h index dc181ee3..76189f76 100644 --- a/src/grove/grove.h +++ b/src/grove/grove.h @@ -48,7 +48,7 @@ class Grove { }; /** - * @brief C++ API for Grove LED + * @brief API for Grove LED * * UPM module for Grove LED (or other similar light-emitting diode). * An LED is a small lightbulb that will emit light (turn on) in @@ -102,7 +102,7 @@ class GroveLed: public Grove { }; /** - * @brief C++ API for Grove Relay + * @brief API for Grove Relay * * UPM module for Grove relay switch. The Grove relay is a * digital normally-open switch that uses low voltage or current to @@ -155,7 +155,7 @@ class GroveRelay: public Grove { }; /** - * @brief C++ API for Grove temperature sensor + * @brief API for Grove temperature sensor * * Very basic UPM module for Grove temperature sensor on analog * @@ -191,7 +191,7 @@ class GroveTemp: public Grove { }; /** - * @brief C++ 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 @@ -231,7 +231,7 @@ class GroveLight: public Grove { }; /** - * @brief C++ API for Grove Rotary Angle Sensor (Knob) + * @brief API for Grove Rotary Angle Sensor (Knob) * * Very basic UPM module for Grove rotary angle sensor (knob) on analog. Provides * a set of functions to read the absolute pin value, degrees or radians and another @@ -295,7 +295,7 @@ class GroveRotary: public Grove { }; /** - * @brief C++ API for Grove Slide Potentiometer + * @brief API for Grove Slide Potentiometer * * Very basic UPM module for Grove slide potentiometer on analog, * returns either raw value or scaled voltage value. @@ -342,7 +342,7 @@ class GroveSlide: public Grove { }; /** - * @brief C++ API for Grove button + * @brief API for Grove button * * Very basic UPM module for Grove button * diff --git a/src/grove/grovebutton.h b/src/grove/grovebutton.h index 07425373..fae74604 100644 --- a/src/grove/grovebutton.h +++ b/src/grove/grovebutton.h @@ -33,7 +33,7 @@ * @con gpio * @kit gsk * - * @brief C++ API for Grove button + * @brief API for Grove button * * Very basic UPM module for Grove button * diff --git a/src/grove/groveled.h b/src/grove/groveled.h index 30e90361..f6ec1f5e 100644 --- a/src/grove/groveled.h +++ b/src/grove/groveled.h @@ -32,7 +32,7 @@ * @con gpio * @kit gsk * - * @brief C++ API for Grove LED + * @brief API for Grove LED * * UPM module for Grove LED (or other similar light-emitting diode). * An LED is a small lightbulb that will emit light (turn on) in diff --git a/src/grove/grovelight.h b/src/grove/grovelight.h index 78eb3757..f72d9dcb 100644 --- a/src/grove/grovelight.h +++ b/src/grove/grovelight.h @@ -32,7 +32,7 @@ * @con analog * @kit gsk * - * @brief C++ 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/groverelay.h b/src/grove/groverelay.h index b21adf8f..5fa15185 100644 --- a/src/grove/groverelay.h +++ b/src/grove/groverelay.h @@ -32,7 +32,7 @@ * @con gpio * @kit gsk * - * @brief C++ API for Grove Relay + * @brief API for Grove Relay * * UPM module for Grove relay switch. The Grove relay is a * digital normally-open switch that uses low voltage or current to diff --git a/src/grove/groverotary.h b/src/grove/groverotary.h index 9eb211e7..285320f9 100644 --- a/src/grove/groverotary.h +++ b/src/grove/groverotary.h @@ -31,7 +31,7 @@ * @man seeed * @con analog * - * @brief C++ API for Grove Rotary Angle Sensor (Knob) + * @brief API for Grove Rotary Angle Sensor (Knob) * * Very basic UPM module for Grove rotary angle sensor (knob) on analog. Provides * a set of functions to read the absolute pin value, degrees or radians and another diff --git a/src/grove/groveslide.h b/src/grove/groveslide.h index 6bc8e30f..bc57db37 100644 --- a/src/grove/groveslide.h +++ b/src/grove/groveslide.h @@ -31,7 +31,7 @@ * @man seeed * @con analog * - * @brief C++ API for Grove Slide Potentiometer + * @brief API for Grove Slide Potentiometer * * Very basic UPM module for Grove slide potentiometer on analog, * returns either raw value or scaled voltage value. diff --git a/src/grove/grovetemp.h b/src/grove/grovetemp.h index 5c169379..a9b30efe 100644 --- a/src/grove/grovetemp.h +++ b/src/grove/grovetemp.h @@ -32,7 +32,7 @@ * @con analog * @kit gsk * - * @brief C++ 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 0b3a9685..64488355 100644 --- a/src/grovecollision/grovecollision.h +++ b/src/grovecollision/grovecollision.h @@ -40,7 +40,7 @@ namespace upm { * @man seeed * @con gpio * - * @brief C++ API for the Grove Collision Sensor + * @brief API for the Grove Collision Sensor * * The Grove Collision Sensor can detect whether any * collision movement or vibration happens. diff --git a/src/groveehr/groveehr.h b/src/groveehr/groveehr.h index 53a4bbdd..02f9642b 100644 --- a/src/groveehr/groveehr.h +++ b/src/groveehr/groveehr.h @@ -43,7 +43,7 @@ namespace upm { * @man seeed * @con gpio * - * @brief C++ API for the Grove Ear-clip Heart Rate sensor + * @brief API for the Grove Ear-clip Heart Rate sensor * * UPM module for the GroveEHR sensor. It is used to measure your * heartbeat. diff --git a/src/groveeldriver/groveeldriver.h b/src/groveeldriver/groveeldriver.h index d2b3f6c1..ce0f2461 100644 --- a/src/groveeldriver/groveeldriver.h +++ b/src/groveeldriver/groveeldriver.h @@ -43,7 +43,7 @@ namespace upm { * @man seeed * @con gpio * - * @brief C++ API for the Grove El Driver Module + * @brief API for the Grove El Driver Module * * The Grove EL Driver allows you to easily light up an * EL Wire with just one single Grove cable. diff --git a/src/groveelectromagnet/groveelectromagnet.h b/src/groveelectromagnet/groveelectromagnet.h index d48c5609..32d07268 100644 --- a/src/groveelectromagnet/groveelectromagnet.h +++ b/src/groveelectromagnet/groveelectromagnet.h @@ -43,7 +43,7 @@ namespace upm { * @man seeed * @con gpio * - * @brief C++ API for the Grove Electromagnet + * @brief API for the Grove Electromagnet * * The Grove Electromagnet can hold up to 1 KG (approximately 2.2 lbs) * diff --git a/src/groveemg/groveemg.h b/src/groveemg/groveemg.h index 446c1041..f1f4fa80 100644 --- a/src/groveemg/groveemg.h +++ b/src/groveemg/groveemg.h @@ -41,7 +41,7 @@ namespace upm { * @man seeed * @con analog * - * @brief C++ API for the GroveEMG Muscle Signal Reader Sensor + * @brief API for the GroveEMG Muscle Signal Reader Sensor * * GroveEMG Muscle Signal reader gathers small muscle signals, * then processes and returns the result diff --git a/src/grovegsr/grovegsr.h b/src/grovegsr/grovegsr.h index 41577d5f..ca145683 100644 --- a/src/grovegsr/grovegsr.h +++ b/src/grovegsr/grovegsr.h @@ -41,7 +41,7 @@ namespace upm { * @man seeed * @con analog * - * @brief C++ API for the GroveGSR Galvanic Skin Response Sensor + * @brief API for the GroveGSR Galvanic Skin Response Sensor * * Measure the electrical conductance of skin in order * to measure strong emotional reaction. diff --git a/src/grovelinefinder/grovelinefinder.h b/src/grovelinefinder/grovelinefinder.h index f2b657b3..13f950b5 100644 --- a/src/grovelinefinder/grovelinefinder.h +++ b/src/grovelinefinder/grovelinefinder.h @@ -41,7 +41,7 @@ namespace upm { * @man seeed * @con gpio * - * @brief C++ API for the Grove Line Finder sensor + * @brief API for the Grove Line Finder sensor * * UPM module for the Grove Line Finder sensor. It outputs a * digital signal indicating whether it is detecting black on a diff --git a/src/groveloudness/groveloudness.h b/src/groveloudness/groveloudness.h index d55ae806..1cac82b3 100644 --- a/src/groveloudness/groveloudness.h +++ b/src/groveloudness/groveloudness.h @@ -41,7 +41,7 @@ namespace upm { * @man seeed * @con analog * - * @brief C++ API for the Grove Loudness Sensor + * @brief API for the Grove Loudness Sensor * * UPM module for the Grove Loudness Sensor. This sensor * detects how loud the surrounding environment is. diff --git a/src/grovemd/grovemd.h b/src/grovemd/grovemd.h index 7ca85b89..d3502167 100644 --- a/src/grovemd/grovemd.h +++ b/src/grovemd/grovemd.h @@ -47,7 +47,7 @@ namespace upm { * @man seeed * @con i2c * - * @brief C++ API for the Grove I2C Motor Driver + * @brief API for the Grove I2C Motor Driver * * This class implements support for the Grove I2C Motor Driver. * This device can support a single 4-wire stepper motor, OR two diff --git a/src/grovemoisture/grovemoisture.h b/src/grovemoisture/grovemoisture.h index f36c9c0a..cf7fe59b 100644 --- a/src/grovemoisture/grovemoisture.h +++ b/src/grovemoisture/grovemoisture.h @@ -41,7 +41,7 @@ namespace upm { * @man seeed * @con analog * - * @brief C++ API for the Grove Moisture Sensor + * @brief API for the Grove Moisture Sensor * * UPM module for the Grove Moisture Sensor. * This sensor can be used to detect the moisture content diff --git a/src/groveo2/groveo2.h b/src/groveo2/groveo2.h index cbb1787c..b4c82376 100644 --- a/src/groveo2/groveo2.h +++ b/src/groveo2/groveo2.h @@ -41,7 +41,7 @@ namespace upm { * @man seeed * @con analog * - * @brief C++ API for the GroveO2 Oxygen Gas Sensor + * @brief API for the GroveO2 Oxygen Gas Sensor * * The Grove O2 sensor measures the oxygen concentration in the air * diff --git a/src/grovescam/grovescam.h b/src/grovescam/grovescam.h index 2a2e28e7..74c51ae2 100644 --- a/src/grovescam/grovescam.h +++ b/src/grovescam/grovescam.h @@ -62,7 +62,7 @@ namespace upm { * @connection uart * @web http://www.seeedstudio.com/wiki/Grove_-_Serial_Camera_Kit * - * @brief C++ API for the Grove Serial Camera + * @brief API for the Grove Serial Camera * * The driver was tested with the Grove Serial Camera. There is * no protocol documentation currently available, so this module diff --git a/src/grovespeaker/grovespeaker.h b/src/grovespeaker/grovespeaker.h index b221dfbb..a8b9d3b7 100644 --- a/src/grovespeaker/grovespeaker.h +++ b/src/grovespeaker/grovespeaker.h @@ -54,7 +54,7 @@ typedef struct * @man seeed * @con gpio * - * @brief C++ API for the GroveSpeaker speaker + * @brief API for the GroveSpeaker speaker * * UPM module for the GroveSpeaker. * This sensor can generate different tones and sounds depending on the diff --git a/src/grovevdiv/grovevdiv.h b/src/grovevdiv/grovevdiv.h index 4c989d30..6e2cf735 100644 --- a/src/grovevdiv/grovevdiv.h +++ b/src/grovevdiv/grovevdiv.h @@ -49,7 +49,7 @@ namespace upm { * @man seeed * @con analog * - * @brief C++ API for the Grove Voltage Divider Sensor + * @brief API for the Grove Voltage Divider Sensor * * UPM module for the Grove Voltage Divider Sensor * diff --git a/src/grovewater/grovewater.h b/src/grovewater/grovewater.h index 2f63ac4b..dcd5eea8 100644 --- a/src/grovewater/grovewater.h +++ b/src/grovewater/grovewater.h @@ -41,7 +41,7 @@ namespace upm { * @man seeed * @con gpio * - * @brief C++ API for the Grove Water Sensor + * @brief API for the Grove Water Sensor * * UPM module for the Grove Water Sensor * diff --git a/src/grovewfs/grovewfs.h b/src/grovewfs/grovewfs.h index 79f45319..a4832ca1 100644 --- a/src/grovewfs/grovewfs.h +++ b/src/grovewfs/grovewfs.h @@ -45,7 +45,7 @@ namespace upm { * @web http://www.seeedstudio.com/wiki/index.php?title=G1/2_Water_Flow_sensor * @con gpio - * @brief C++ API for the Grove Water Flow Sensor + * @brief API for the Grove Water Flow Sensor * * This sensor is used to measure water flow, in LPM (Liters Per * Minute). It incorporates a Hall Effect Sensor. The UPM module diff --git a/src/guvas12d/guvas12d.h b/src/guvas12d/guvas12d.h index ee661c17..db3ae2fb 100644 --- a/src/guvas12d/guvas12d.h +++ b/src/guvas12d/guvas12d.h @@ -42,7 +42,7 @@ namespace upm { * @man seeed * @con analog * - * @brief C++ API for the GUVAS12D UV sensor module + * @brief API for the GUVAS12D UV sensor module * * UPM module for the GUVAS12D UV Sensor * diff --git a/src/h3lis331dl/h3lis331dl.h b/src/h3lis331dl/h3lis331dl.h index a0ed7415..4b9adc6e 100644 --- a/src/h3lis331dl/h3lis331dl.h +++ b/src/h3lis331dl/h3lis331dl.h @@ -46,7 +46,7 @@ namespace upm { * @web http://www.seeedstudio.com/depot/Grove-3Axis-Digital-Accelerometer400g-p-1897.html * @con i2c * - * @brief C++ API for the H3LIS331DL based Grove 3-axis I2C Accelerometer + * @brief API for the H3LIS331DL based Grove 3-axis I2C Accelerometer * (400G) * * @image html h3lis331dl.jpg diff --git a/src/hcsr04/hcsr04.h b/src/hcsr04/hcsr04.h index a0a62c16..d985b08a 100644 --- a/src/hcsr04/hcsr04.h +++ b/src/hcsr04/hcsr04.h @@ -50,9 +50,9 @@ namespace upm { * @man generic * @con gpio * - * @brief C++ API for HCSR04 (ultrasonic ranging module) component + * @brief API for HCSR04 (ultrasonic ranging module) component * - * This file defines the HCSR04 C++ interface for libhcsr04 + * This file defines the HCSR04 interface for libhcsr04 * * @snippet hcsr04.cxx Interesting */ diff --git a/src/hm11/hm11.h b/src/hm11/hm11.h index 1709a723..467f892e 100644 --- a/src/hm11/hm11.h +++ b/src/hm11/hm11.h @@ -62,7 +62,7 @@ namespace upm { * @connection uart * @web http://www.seeedstudio.com/wiki/images/c/cd/Bluetooth4_en.pdf * - * @brief C++ API HM-11 4.0 Bluetooth Low Energy Module + * @brief API HM-11 4.0 Bluetooth Low Energy Module * * The driver was tested with the Grove BLE module. Its an HM-11 * BLE 4.0 module based on a TI CC2541 chip. It operates using a diff --git a/src/hmc5883l/hmc5883l.h b/src/hmc5883l/hmc5883l.h index bfd69459..7fc4b432 100644 --- a/src/hmc5883l/hmc5883l.h +++ b/src/hmc5883l/hmc5883l.h @@ -44,7 +44,7 @@ namespace upm { * @man seeed * @con i2c * - * @brief C++ API for Hmc5883l (3-axis digital compass) + * @brief API for Hmc5883l (3-axis digital compass) * * The Honeywell [HMC5883L] * (http://www.adafruit.com/datasheets/HMC5883L_3-Axis_Digital_Compass_IC.pdf) diff --git a/src/hmtrp/hmtrp.h b/src/hmtrp/hmtrp.h index d091cd80..611b379a 100644 --- a/src/hmtrp/hmtrp.h +++ b/src/hmtrp/hmtrp.h @@ -58,7 +58,7 @@ namespace upm { * @man seeed * @con uart * - * @brief C++ API for the HMTRP Serial RF Pro + * @brief API for the HMTRP Serial RF Pro * * UPM support for the HMTRP Serial RF Pro. This was tested * specifically with the Grove Serial RF Pro module. In theory, diff --git a/src/ht9170/ht9170.h b/src/ht9170/ht9170.h index a25cee72..8638404f 100644 --- a/src/ht9170/ht9170.h +++ b/src/ht9170/ht9170.h @@ -44,7 +44,7 @@ namespace upm { * @web http://www.seeedstudio.com/depot/DTMFDual-Tone-Multi-Frequency-Shield-p-1839.html * @con gpio * - * @brief C++ API for the HT9170 DTMF Decoder + * @brief API for the HT9170 DTMF Decoder * * This driver was developed using the Seeed DTMF (Dual Tone * Multi-Frequency) Shield. It can decode DTMF signals presented at diff --git a/src/htu21d/htu21d.h b/src/htu21d/htu21d.h index 6712e672..6279d7fb 100644 --- a/src/htu21d/htu21d.h +++ b/src/htu21d/htu21d.h @@ -63,7 +63,7 @@ namespace upm { * @web http://www.meas-spec.com/downloads/HTU21D.pdf * @con i2c * - * @brief C++ API for HTU21D chip (Atmospheric Pressure Sensor) + * @brief API for HTU21D chip (Atmospheric Pressure Sensor) * * Measurement Specialties [HTU21D] is a digital humidity sensor with * temperature output. diff --git a/src/hx711/hx711.h b/src/hx711/hx711.h index a102afa7..7e5692a5 100644 --- a/src/hx711/hx711.h +++ b/src/hx711/hx711.h @@ -43,7 +43,7 @@ namespace upm { * @web http://www.dfrobot.com/image/data/SEN0160/hx711_english.pdf * @con gpio * - * @brief C++ API for HX711 + * @brief API for HX711 * * The HX711 is a precision 24-bit analog-to-digital converter (ADC) * designed for weigh scales and industrial control applications to diff --git a/src/ina132/ina132.h b/src/ina132/ina132.h index ea1f441d..14b1515a 100644 --- a/src/ina132/ina132.h +++ b/src/ina132/ina132.h @@ -41,7 +41,7 @@ namespace upm { * @man seeed * @con analog * - * @brief C++ API for the INA132 Differential Amplifier Sensor + * @brief API for the INA132 Differential Amplifier Sensor * * The INA132 Differential Amplifier Sensor is designed * for precise differential-input amplification. diff --git a/src/isd1820/isd1820.h b/src/isd1820/isd1820.h index c61e4f43..24e8f009 100644 --- a/src/isd1820/isd1820.h +++ b/src/isd1820/isd1820.h @@ -42,7 +42,7 @@ namespace upm { * @man seeed * @con gpio * - * @brief C++ API support for the ISD1820 based Grove Recorder + * @brief API support for the ISD1820 based Grove Recorder * * This class implements support for the Grove Recorder. There * are two digital pins, one that enables recording, and the other diff --git a/src/itg3200/itg3200.h b/src/itg3200/itg3200.h index 6a31960a..c5fef329 100644 --- a/src/itg3200/itg3200.h +++ b/src/itg3200/itg3200.h @@ -43,7 +43,7 @@ namespace upm { * @man seeed * @con i2c * - * @brief C++ 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 6fcec6b3..7fe32017 100644 --- a/src/joystick12/joystick12.h +++ b/src/joystick12/joystick12.h @@ -43,7 +43,7 @@ namespace upm { * @man generic * @con analog * - * @brief C++ API for Elecfreaks Joystick v 1.2-1.4 breakout + * @brief API for Elecfreaks Joystick v 1.2-1.4 breakout * * This file defines the Joystick API and implemntation for X, Y * button could be treated as normal GPIO, this enables easier diff --git a/src/l298/l298.h b/src/l298/l298.h index a9b38d8e..0ad654e1 100644 --- a/src/l298/l298.h +++ b/src/l298/l298.h @@ -47,7 +47,7 @@ namespace upm { * @man seeed sparkfun * @con gpio pwm * - * @brief C++ API for the L298 Dual H-Bridge module + * @brief API for the L298 Dual H-Bridge module * * It was developed using the RobotBase Dual H-Bridge module. * diff --git a/src/lcd/jhd1313m1.h b/src/lcd/jhd1313m1.h index 7e86188f..77c4165e 100644 --- a/src/lcd/jhd1313m1.h +++ b/src/lcd/jhd1313m1.h @@ -39,7 +39,7 @@ namespace upm * @con i2c * @kit gsk * - * @brief C++ API for Jhd1313m1 i2c controller for HD44780 based displays with + * @brief API for Jhd1313m1 i2c controller for HD44780 based displays with * an RGB backlight such as the Grove RGB i2c LCD display * * The Jhd1313m1 has two i2c addreses, one belongs to a controller very similar diff --git a/src/lcd/lcm1602.h b/src/lcd/lcm1602.h index f35de165..691ad6b7 100644 --- a/src/lcd/lcm1602.h +++ b/src/lcd/lcm1602.h @@ -41,7 +41,7 @@ namespace upm * @web https://www.adafruit.com/datasheets/TC1602A-01T.pdf * @con i2c * - * @brief C++ API for LCM1602 i2c controller for HD44780 based displays + * @brief API for LCM1602 i2c controller for HD44780 based displays * * This supports all sizes of HD44780 displays from 16x2 to 4x20, the * controller has no idea of the actual display hardware so will let you write diff --git a/src/lcd/ssd1308.h b/src/lcd/ssd1308.h index b8c2569a..b4514680 100644 --- a/src/lcd/ssd1308.h +++ b/src/lcd/ssd1308.h @@ -43,7 +43,7 @@ const uint8_t DISPLAY_CMD_SET_NORMAL_1308 = 0xA6; * @web http://www.seeedstudio.com/wiki/Grove_-_OLED_Display_0.96%22 * @con i2c * - * @brief C++ API for SSD1308 i2c controlled OLED displays + * @brief API for SSD1308 i2c controlled OLED displays * * The SSD1308 is a 128x64 Dot matrix OLED/PLED segment driver with * controller. This implementation was tested using the Grove LED 128×64 diff --git a/src/lcd/ssd1327.h b/src/lcd/ssd1327.h index 17216fc0..20125eb6 100644 --- a/src/lcd/ssd1327.h +++ b/src/lcd/ssd1327.h @@ -43,7 +43,7 @@ const uint8_t DISPLAY_CMD_SET_NORMAL = 0xA4; * @web http://www.seeedstudio.com/wiki/Grove_-_OLED_Display_1.12%22 * @con i2c * - * @brief C++ API for SSD1327 i2c controlled OLED displays + * @brief API for SSD1327 i2c controlled OLED displays * * The SSD1327 is a 96x96 Dot matrix OLED/PLED segment driver with controller. * This implementation was tested using the Grove LED 96×96 Display module diff --git a/src/ldt0028/ldt0028.h b/src/ldt0028/ldt0028.h index 0c430c12..be9664e4 100644 --- a/src/ldt0028/ldt0028.h +++ b/src/ldt0028/ldt0028.h @@ -43,10 +43,10 @@ namespace upm { * @man seeed * @con analog * - * @brief C++ API for LDT0-028 PZT film-based sensors, + * @brief API for LDT0-028 PZT film-based sensors, * such as the Grove Piezo Vibration sensor * - * This file defines the LDT0028 C++ interface for libupm-ldt0028 + * This file defines the LDT0028 interface for libupm-ldt0028 * * @image html ldt0028.jpg * @snippet ldt0028.cxx Interesting diff --git a/src/lol/lol.h b/src/lol/lol.h index 888dd951..a2ac5bcd 100644 --- a/src/lol/lol.h +++ b/src/lol/lol.h @@ -47,7 +47,7 @@ namespace upm { * @man adafruit * @con gpio * - * @brief C++ API for Olimex LoL array + * @brief API for Olimex LoL array * * This file defines the LoL API and implemntation for a simple framebuffer * diff --git a/src/lpd8806/lpd8806.h b/src/lpd8806/lpd8806.h index b7b88f40..80250e52 100644 --- a/src/lpd8806/lpd8806.h +++ b/src/lpd8806/lpd8806.h @@ -47,7 +47,7 @@ namespace upm { * @man adafruit * @con spi * - * @brief C++ API for LPD8806 + * @brief API for LPD8806 * * The FastPixel lpd8806 is an RGB led strip controller. * diff --git a/src/lsm303/lsm303.h b/src/lsm303/lsm303.h index 171a498d..5e1fc3e3 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 C++ API for LSM303 + * @brief API for LSM303 * * 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 a31b64a7..4063081a 100644 --- a/src/max31723/max31723.h +++ b/src/max31723/max31723.h @@ -46,7 +46,7 @@ namespace upm { * @man maxim * @con spi * - * @brief C++ 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 21b930b2..9dc7559b 100644 --- a/src/max31855/max31855.h +++ b/src/max31855/max31855.h @@ -42,7 +42,7 @@ namespace upm { * @man maxim * @con spi * - * @brief C++ API for MAX31855 + * @brief API for MAX31855 * * 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 9ccc8a60..e63ec46a 100644 --- a/src/max44000/max44000.h +++ b/src/max44000/max44000.h @@ -65,7 +65,7 @@ namespace upm { * @man maxim * @con i2c * - * @brief C++ API for MAX44000 chip (Ambient and Infrared Proximity Sensor) + * @brief API for MAX44000 chip (Ambient and Infrared Proximity Sensor) * * The Maxim Integrated * [MAX44000](http://datasheets.maximintegrated.com/en/ds/MAX44000.pdf) diff --git a/src/max5487/max5487.h b/src/max5487/max5487.h index 521892b1..4ae29f1a 100644 --- a/src/max5487/max5487.h +++ b/src/max5487/max5487.h @@ -46,7 +46,7 @@ namespace upm { * @man maxim * @con spi * - * @brief C++ API for MAX5487 chip (SPI digital potentionmeter) + * @brief API for MAX5487 chip (SPI digital potentionmeter) * * The Maxim Integrated * [MAX5487](http://datasheets.maximintegrated.com/en/ds/MAX5487-MAX5489.pdf) diff --git a/src/maxds3231m/maxds3231m.h b/src/maxds3231m/maxds3231m.h index 1267ab99..51c4cb1e 100644 --- a/src/maxds3231m/maxds3231m.h +++ b/src/maxds3231m/maxds3231m.h @@ -75,9 +75,9 @@ struct Time3231 { * @man maxim * @con i2c * - * @brief C++ API for MAXDS3231M chip (Ambient and Infrared Proximity Sensor) + * @brief API for MAXDS3231M chip (Ambient and Infrared Proximity Sensor) * - * This file defines the maxds3231m C++ interface for maxds3231m + * This file defines the maxds3231m interface for maxds3231m * * @snippet maxds3231m.cxx Interesting */ diff --git a/src/maxsonarez/maxsonarez.h b/src/maxsonarez/maxsonarez.h index 494a6465..eba36e22 100644 --- a/src/maxsonarez/maxsonarez.h +++ b/src/maxsonarez/maxsonarez.h @@ -46,7 +46,7 @@ namespace upm { * @man sparkfun * @con analog * - * @brief C++ API for the LV-MaxSonar-EZ family of ultrasonic rangers + * @brief API for the LV-MaxSonar-EZ family of ultrasonic rangers * * This sensor family returns an analog voltage corresponding to the * distance of an object from the sensor in inches. It has a diff --git a/src/mhz16/mhz16.h b/src/mhz16/mhz16.h index fce58fdd..a17e0515 100644 --- a/src/mhz16/mhz16.h +++ b/src/mhz16/mhz16.h @@ -61,7 +61,7 @@ namespace upm { * @man seeed * @con uart * - * @brief C++ API support for the Grove CO2 sensor + * @brief API support for the Grove CO2 sensor * * This class implements support for the Grove CO2 sensor. * diff --git a/src/mic/mic.h b/src/mic/mic.h index 44be2727..1466255d 100644 --- a/src/mic/mic.h +++ b/src/mic/mic.h @@ -50,7 +50,7 @@ namespace upm { * @con pwm * @kit gsk * - * @brief C++ API for Microphone + * @brief API for Microphone * * This file defines the Microphone Analog sensor * diff --git a/src/mlx90614/mlx90614.h b/src/mlx90614/mlx90614.h index b139406a..309952c9 100644 --- a/src/mlx90614/mlx90614.h +++ b/src/mlx90614/mlx90614.h @@ -65,9 +65,9 @@ namespace upm { * @man generic * @con i2c * - * @brief C++ API for MLX90614 + * @brief API for MLX90614 * - * This file defines the MLX90614 C++ interface for libmlx90614 + * This file defines the MLX90614 interface for libmlx90614 * * @image html mlx90614.jpg * @snippet mlx90614.cxx Interesting diff --git a/src/mma7455/mma7455.h b/src/mma7455/mma7455.h index 70cc23eb..02ec36d1 100644 --- a/src/mma7455/mma7455.h +++ b/src/mma7455/mma7455.h @@ -162,9 +162,9 @@ union accelData { * @man generic * @con i2c * - * @brief C++ API for MMA7455 chip (accelerometer) + * @brief API for MMA7455 chip (accelerometer) * - * This file defines the MMA7455 C++ interface for libmma7455 + * This file defines the MMA7455 interface for libmma7455 * * @image html mma7455.jpg * @snippet mma7455.cxx Interesting diff --git a/src/mma7660/mma7660.h b/src/mma7660/mma7660.h index b15935de..fb13a05f 100644 --- a/src/mma7660/mma7660.h +++ b/src/mma7660/mma7660.h @@ -45,7 +45,7 @@ namespace upm { * @man generic * @con i2c gpio * - * @brief C++ API for the MMA7660 I2C 3-axis digital accelerometer + * @brief API for the MMA7660 I2C 3-axis digital accelerometer * * UPM module for the MMA7660 I2C 3-axis digital accelerometer. * This device supports a variety of capabilities, including the diff --git a/src/mpl3115a2/mpl3115a2.h b/src/mpl3115a2/mpl3115a2.h index 59fba362..8f02acf5 100644 --- a/src/mpl3115a2/mpl3115a2.h +++ b/src/mpl3115a2/mpl3115a2.h @@ -69,7 +69,7 @@ namespace upm { * @web http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2 * @con i2c * - * @brief C++ API for MPL3115A2 chip (Atmospheric Pressure Sensor) + * @brief API for MPL3115A2 chip (Atmospheric Pressure Sensor) * * Freescale [MPL3115A2] * (http://cache.freescale.com/files/sensors/doc/data_sheet/MPL3115A2.pdf) diff --git a/src/mpr121/mpr121.h b/src/mpr121/mpr121.h index 2f280f14..0001ae60 100644 --- a/src/mpr121/mpr121.h +++ b/src/mpr121/mpr121.h @@ -32,7 +32,7 @@ namespace upm { /** - * @brief C++ API for the MPR121 I2C touch sensor + * @brief API for the MPR121 I2C touch sensor * * UPM module for the MPR121 touch sensor * @@ -54,7 +54,7 @@ namespace upm { * @web http://www.seeedstudio.com/wiki/Grove_-_I2C_Touch_Sensor * @con i2c * - * @brief C++ API for the MPR121 I2C touch sensor + * @brief API for the MPR121 I2C touch sensor * * UPM module for the MPR121 touch sensor * diff --git a/src/mpu9150/mpu9150.h b/src/mpu9150/mpu9150.h index d43e3178..9e3041a6 100644 --- a/src/mpu9150/mpu9150.h +++ b/src/mpu9150/mpu9150.h @@ -122,9 +122,9 @@ struct AxisData { * @web http://www.seeedstudio.com/wiki/Grove_-_IMU_9DOF_v1.0 * @con i2c * - * @brief C++ API for MPU9150 chip (Accelerometer, Gyro and Magnometer Sensor) + * @brief API for MPU9150 chip (Accelerometer, Gyro and Magnometer Sensor) * - * This file defines the MPU9150 C++ interface for libmpu9150 + * This file defines the MPU9150 interface for libmpu9150 * * @image html mpu9150.jpg * @snippet mpu9150.cxx Interesting diff --git a/src/mq303a/mq303a.h b/src/mq303a/mq303a.h index 13d9326f..26384a4b 100644 --- a/src/mq303a/mq303a.h +++ b/src/mq303a/mq303a.h @@ -42,7 +42,7 @@ namespace upm { * @web http://www.seeedstudio.com/wiki/Grove_-_Alcohol_Sensor * @con analog gpio * - * @brief C++ API for the MQ303A Alcohol Sensor + * @brief API for the MQ303A Alcohol Sensor * * UPM module for the MQ303A Alcohol Sensor. * This sensor needs to be warmed up before stable results are diff --git a/src/my9221/my9221.h b/src/my9221/my9221.h index 935d3d5e..7a241fdd 100644 --- a/src/my9221/my9221.h +++ b/src/my9221/my9221.h @@ -51,9 +51,9 @@ namespace upm { * @web http://www.seeedstudio.com/wiki/Grove_-_LED_Bar * @con gpio * - * @brief C++ API for MY9221 led bar module + * @brief API for MY9221 led bar module * - * This file defines the MY9221 C++ interface for libmy9221 + * This file defines the MY9221 interface for libmy9221 * * @image html my9221.jpg * @snippet my9221-ledbar.cxx Interesting diff --git a/src/nrf24l01/nrf24l01.h b/src/nrf24l01/nrf24l01.h index b3e1da14..aa57840d 100644 --- a/src/nrf24l01/nrf24l01.h +++ b/src/nrf24l01/nrf24l01.h @@ -164,9 +164,9 @@ typedef enum { * @web http://www.seeedstudio.com/depot/nRF24L01Module-p-1394.html * @con spi * - * @brief C++ API for NRF24l01 transceiver module + * @brief API for NRF24l01 transceiver module * - * This file defines the NRF24l01 C++ interface for libnrf24l01 + * This file defines the NRF24l01 interface for libnrf24l01 * * @image html nrf24l01.jpg * @snippet nrf24l01-receiver.cxx Interesting diff --git a/src/nrf8001/nrf8001.h b/src/nrf8001/nrf8001.h index 3122b5bf..e20b2aae 100644 --- a/src/nrf8001/nrf8001.h +++ b/src/nrf8001/nrf8001.h @@ -38,7 +38,7 @@ * * @brief nrf8001 Bluetooth Low Energy library * - * These files define the NRF8001 C++ interface for lib-nrf8001. Interaction + * These files define the NRF8001 interface for lib-nrf8001. Interaction * with this device is done through the ACI routines included with the library. * You can use the nRF UART app in the Apple iOS app store and Google Play for * Android 4.3 for Samsung Galaxy S4 to interact with a microcontroller running diff --git a/src/nunchuck/nunchuck.h b/src/nunchuck/nunchuck.h index 660e7005..23a3b1b8 100644 --- a/src/nunchuck/nunchuck.h +++ b/src/nunchuck/nunchuck.h @@ -44,7 +44,7 @@ namespace upm { * @web http://wiibrew.org/wiki/Wiimote/Extension_Controllers * @con i2c * - * @brief C++ API for the Wii Nunchuck + * @brief API for the Wii Nunchuck * * UPM module for the Wii Nunchuck. This module was tested with the * Wii Nunchuck connected to I2C via a Grove Wii Nunchuck adapter. diff --git a/src/otp538u/otp538u.h b/src/otp538u/otp538u.h index 0b0eac11..23a6cccf 100644 --- a/src/otp538u/otp538u.h +++ b/src/otp538u/otp538u.h @@ -41,7 +41,7 @@ namespace upm { * @man generic * @con analog * - * @brief C++ API for the OTP538U IR Temperature Sensor + * @brief API for the OTP538U IR Temperature Sensor * * UPM module for the OTP538U IR Temperature Sensor * diff --git a/src/pca9685/pca9685.h b/src/pca9685/pca9685.h index c9ab5a72..70e17dda 100644 --- a/src/pca9685/pca9685.h +++ b/src/pca9685/pca9685.h @@ -52,7 +52,7 @@ namespace upm { * @web http://www.adafruit.com/products/815 * @con i2c * - * @brief C++ API for the PCA9685 16 channel, 12 bit pwm LED controller + * @brief API for the PCA9685 16 channel, 12 bit pwm LED controller * * This controller is also used on the Adafruit Motor Shield v2.3 * board to control up to 4 DC motors, 2 step motors and 2 servo diff --git a/src/ppd42ns/ppd42ns.h b/src/ppd42ns/ppd42ns.h index 69062276..46c89c69 100644 --- a/src/ppd42ns/ppd42ns.h +++ b/src/ppd42ns/ppd42ns.h @@ -50,7 +50,7 @@ typedef struct * @web http://www.seeedstudio.com/wiki/Grove_-_Dust_Sensor * @con gpio * - * @brief C++ API for the Dust Sensor + * @brief API for the Dust Sensor * * UPM module for the Dust Sensor * diff --git a/src/rfr359f/rfr359f.h b/src/rfr359f/rfr359f.h index a2456ad5..3d97bab6 100644 --- a/src/rfr359f/rfr359f.h +++ b/src/rfr359f/rfr359f.h @@ -42,7 +42,7 @@ namespace upm { * @web http://www.seeedstudio.com/wiki/Grove_-_IR_Distance_Interrupt * @con gpio * - * @brief C++ API for the RFR359F based Grove Distance Interrupter. + * @brief API for the RFR359F based Grove Distance Interrupter. * * UPM module for the Grove Distance Interrupter. The sensitivity * can be adjusted with the potentiometer on the sensor module. It diff --git a/src/rotaryencoder/rotaryencoder.h b/src/rotaryencoder/rotaryencoder.h index 2c7d987f..da77b5bd 100644 --- a/src/rotaryencoder/rotaryencoder.h +++ b/src/rotaryencoder/rotaryencoder.h @@ -45,7 +45,7 @@ namespace upm { * @con gpio * @kit gsk * - * @brief C++ API for the Grove Rotary Encoder + * @brief API for the Grove Rotary Encoder * * UPM module for the Grove Rotary Encoder. A Rotary Encoder * encodes a rotation signal into electronic pulses that can be used diff --git a/src/rpr220/rpr220.h b/src/rpr220/rpr220.h index b9c39cf1..669ef442 100644 --- a/src/rpr220/rpr220.h +++ b/src/rpr220/rpr220.h @@ -42,7 +42,7 @@ namespace upm { * @web http://www.seeedstudio.com/wiki/Grove_-_Infrared_Reflective_Sensor * @con gpio * - * @brief C++ API for the RPR220 based Grove IR Reflective Sensor + * @brief API for the RPR220 based Grove IR Reflective Sensor * * UPM module for the Grove IR Reflective Sensor. The sensitivity * can be adjusted with the potentiometer on the sensor module. It diff --git a/src/servo/es08a.h b/src/servo/es08a.h index 3137279a..9a1ee5e8 100644 --- a/src/servo/es08a.h +++ b/src/servo/es08a.h @@ -38,9 +38,9 @@ namespace upm { * @con pwm * @kit gsk * - * @brief C++ API for ES08A servo component + * @brief API for ES08A servo component * - * This file defines the ES08A C++ interface for ES08A servos. + * This file defines the ES08A interface for ES08A servos. * Like other servos, the ES08A servo has a shaft that can be controlled * by setting the desired angle. There are also routines for setting * and getting the minimum and maximum pulse width as well as the diff --git a/src/si114x/si114x.h b/src/si114x/si114x.h index 3fc6fa4e..08e7dc2a 100644 --- a/src/si114x/si114x.h +++ b/src/si114x/si114x.h @@ -52,7 +52,7 @@ namespace upm { * @web https://www.adafruit.com/products/1777 * @con i2c * - * @brief C++ API for the SI1145 UV light sensor + * @brief API for the SI1145 UV light sensor * * This module was tested with the Adafruit UV Sensor * diff --git a/src/sm130/sm130.h b/src/sm130/sm130.h index 85e1a8ae..7a20c259 100644 --- a/src/sm130/sm130.h +++ b/src/sm130/sm130.h @@ -54,9 +54,9 @@ namespace upm { * @web https://www.sparkfun.com/products/10126 * @con gpio * - * @brief C++ API for SM130 RFID reader module + * @brief API for SM130 RFID reader module * - * This file defines the C++ interface for sm130 RFID library + * This file defines the interface for sm130 RFID library * * @snippet sm130.cxx Interesting */ diff --git a/src/st7735/st7735.h b/src/st7735/st7735.h index 04be30ce..6d087585 100644 --- a/src/st7735/st7735.h +++ b/src/st7735/st7735.h @@ -494,9 +494,9 @@ const unsigned char font[] = { }; /** - * @brief C++ API for the st7735 lcd display library + * @brief API for the st7735 lcd display library * - * This file defines the C++ interface for ST7735 display library + * This file defines the interface for ST7735 display library * * @defgroup st7735 libupm-st7735 * @ingroup adafruit spi display @@ -510,9 +510,9 @@ const unsigned char font[] = { * @web http://www.adafruit.com/product/358 * @con spi * - * @brief C++ API for the st7735 lcd display library + * @brief API for the st7735 lcd display library * - * This file defines the C++ interface for ST7735 display library + * This file defines the interface for ST7735 display library * * @image html st7735.jpg * @snippet st7735.cxx Interesting diff --git a/src/stepmotor/stepmotor.h b/src/stepmotor/stepmotor.h index abb9a479..4510e33f 100644 --- a/src/stepmotor/stepmotor.h +++ b/src/stepmotor/stepmotor.h @@ -41,9 +41,9 @@ namespace upm { /** - * @brief C++ API for the Stepper motor library + * @brief API for the Stepper motor library * - * This file defines the stepmotor C++ interface + * This file defines the stepmotor interface * * @defgroup stepper libupm-stepper * @ingroup seeed pwm gpio motor @@ -57,9 +57,9 @@ namespace upm { * @web http://www.seeedstudio.com/wiki/Grove_-_I2C_Motor_Driver_V1.3 * @con pwm gpio * - * @brief C++ API for the Stepper motor library + * @brief API for the Stepper motor library * - * This file defines the stepmotor C++ interface + * This file defines the stepmotor interface * * @image html stepmotor.jpg * @snippet stepmotor.cxx Interesting diff --git a/src/sx6119/sx6119.h b/src/sx6119/sx6119.h index 6d48824d..510ed8ea 100644 --- a/src/sx6119/sx6119.h +++ b/src/sx6119/sx6119.h @@ -42,7 +42,7 @@ namespace upm { * @man seeed * @con gpio * - * @brief C++ API support for the SX6119 based Grove FM Receiver + * @brief API support for the SX6119 based Grove FM Receiver * * This class implements support for the FM Receiver. There are * two digital pins, one that toggles power on/off, and one that diff --git a/src/ta12200/ta12200.h b/src/ta12200/ta12200.h index 515301f6..26a4605e 100644 --- a/src/ta12200/ta12200.h +++ b/src/ta12200/ta12200.h @@ -34,7 +34,7 @@ namespace upm { /** - * @brief C++ API for the TA12-200 current transformer + * @brief API for the TA12-200 current transformer * * UPM module for the TA12-200 current transformer, which is found, * for instance, in the Grove Electricity Sensor. @@ -53,7 +53,7 @@ namespace upm { * @web http://www.seeedstudio.com/wiki/Grove_-_Electricity_Sensor * @con analog * - * @brief C++ API for the TA12-200 current transformer + * @brief API for the TA12-200 current transformer * * UPM module for the TA12-200 current transformer, which is found, * for instance, in the Grove Electricity Sensor. diff --git a/src/tcs3414cs/tcs3414cs.h b/src/tcs3414cs/tcs3414cs.h index f9910d27..1ad39877 100644 --- a/src/tcs3414cs/tcs3414cs.h +++ b/src/tcs3414cs/tcs3414cs.h @@ -105,9 +105,9 @@ typedef struct { } tcs3414sc_rgb_t; /** - * @brief C++ API for TCS3414CS chip (Color sensor) + * @brief API for TCS3414CS chip (Color sensor) * - * his file defines the TCS3414CS C++ interface for the color sensor + * his file defines the TCS3414CS interface for the color sensor * * @defgroup tcs3414cs libupm-tcs3414cs * @ingroup seeed i2c color @@ -121,9 +121,9 @@ typedef struct { * @web http://www.seeedstudio.com/wiki/Grove_-_I2C_Color_Sensor * @con i2c * - * @brief C++ API for TCS3414CS chip (Color sensor) + * @brief API for TCS3414CS chip (Color sensor) * - * This file defines the TCS3414CS C++ interface for the color sensor + * This file defines the TCS3414CS interface for the color sensor * * @image html tcs3414cs.jpg * @snippet tcs3414cs.cxx Interesting diff --git a/src/th02/th02.h b/src/th02/th02.h index d329acbb..47712884 100644 --- a/src/th02/th02.h +++ b/src/th02/th02.h @@ -45,9 +45,9 @@ namespace upm { /** - * @brief C++ API for th02 temperature & humidity sensor library + * @brief API for th02 temperature & humidity sensor library * - * This file defines the TH02 C++ interface for libth02 + * This file defines the TH02 interface for libth02 * * @defgroup th02 libupm-th02 * @ingroup seeed i2c temp @@ -61,9 +61,9 @@ namespace upm { * @web http://www.seeedstudio.com/wiki/Grove_-_Tempture%26Humidity_Sensor_(High-Accuracy_%26Mini)_v1.0 * @con i2c * - * @brief C++ API for th02 temperature & humidity sensor library + * @brief API for th02 temperature & humidity sensor library * - * This file defines the TH02 C++ interface for libth02 + * This file defines the TH02 interface for libth02 * * NOTE: For use on the Edison with the arduino breakout board, the * Edison must be set to 3v rather than 5v. diff --git a/src/tm1637/tm1637.h b/src/tm1637/tm1637.h index 97687ef6..af6638f0 100644 --- a/src/tm1637/tm1637.h +++ b/src/tm1637/tm1637.h @@ -57,7 +57,7 @@ namespace upm * @man seeed * @con gpio * - * @brief C++ API for TM1637 (7-segment display) + * @brief API for TM1637 (7-segment display) * * The TM1637 is a display controller for LED based 7-segment displays. * It can be used to address and write data to multiple display digits. This diff --git a/src/ublox6/ublox6.h b/src/ublox6/ublox6.h index bbb0ad6a..e6de4c77 100644 --- a/src/ublox6/ublox6.h +++ b/src/ublox6/ublox6.h @@ -44,7 +44,7 @@ const int UBLOX6_DEFAULT_UART = 0; namespace upm { /** - * @brief C++ API for the U-BLOX 6 GPS module + * @brief API for the U-BLOX 6 GPS module * * UPM support for the U-BLOX 6 GPS Module * @@ -60,7 +60,7 @@ namespace upm { * @web http://www.seeedstudio.com/depot/Grove-GPS-p-959.html * @con uart * - * @brief C++ API for the U-BLOX 6 GPS module + * @brief API for the U-BLOX 6 GPS module * * UPM support for the U-BLOX 6 GPS Module * diff --git a/src/waterlevel/waterlevel.h b/src/waterlevel/waterlevel.h index ea144e0f..5e30dab1 100644 --- a/src/waterlevel/waterlevel.h +++ b/src/waterlevel/waterlevel.h @@ -27,7 +27,7 @@ namespace upm { /** - * @brief C++ API for the Water Level Sensor + * @brief API for the Water Level Sensor * * The Water Level Sensor senses the water level. * When the level rises, a ball with a magnet floats up and causes a switch to open. diff --git a/src/wt5001/wt5001.h b/src/wt5001/wt5001.h index a7470662..e72308cc 100644 --- a/src/wt5001/wt5001.h +++ b/src/wt5001/wt5001.h @@ -49,7 +49,7 @@ const uint8_t WT5001_END = 0x7e; namespace upm { /** - * @brief C++ API for the WT5001 Serial MP3 module + * @brief API for the WT5001 Serial MP3 module * * UPM support for the WT5001 Serial MP3 Module. This was tested * specifically with the Grove Serial MP3 module. @@ -66,7 +66,7 @@ namespace upm { * @web http://www.seeedstudio.com/wiki/Grove_%E2%80%93_Serial_MP3_Player * @con uart * - * @brief C++ API for the WT5001 Serial MP3 module + * @brief API for the WT5001 Serial MP3 module * * UPM support for the WT5001 Serial MP3 Module. This was tested * specifically with the Grove Serial MP3 module. diff --git a/src/yg1006/yg1006.h b/src/yg1006/yg1006.h index 47707a37..eccef1c8 100644 --- a/src/yg1006/yg1006.h +++ b/src/yg1006/yg1006.h @@ -45,7 +45,7 @@ namespace upm { * @web http://www.seeedstudio.com/wiki/Grove_-_Flame_Sensor * @con gpio * - * @brief C++ API for the YG1006 flame sensor + * @brief API for the YG1006 flame sensor * * UPM module for the YG1006 flame sensor. It detects flame or any * other light in the 760nm - 1100nm wavelength range. diff --git a/src/zfm20/zfm20.h b/src/zfm20/zfm20.h index 82258065..b5b5bdc0 100644 --- a/src/zfm20/zfm20.h +++ b/src/zfm20/zfm20.h @@ -73,7 +73,7 @@ namespace upm { * @man seeed * @con uart * - * @brief C++ API for the ZFM-20 fingerprint sensor module + * @brief API for the ZFM-20 fingerprint sensor module * * This class was tested on the Grove Fingerprint Sensor * Module. It can store up to 163 fingerprints.