mirror of
https://github.com/eclipse/upm.git
synced 2025-03-14 20:47:30 +03:00
snippet: Updated all snippet tags
Ensure all src C++ headers which have corresponding C++ examples have doxygen tags which point to those examples. Some were missing, some were invalid, some needed to be updated to match the new example names. Signed-off-by: Noel Eck <noel.eck@intel.com>
This commit is contained in:
parent
96b219d2fb
commit
a655235c70
@ -82,6 +82,8 @@ namespace upm {
|
||||
*
|
||||
* @image html ads1015.jpg
|
||||
* @snippet ads1x15.cxx Interesting
|
||||
* @snippet ads1x15-ads1015.cxx Interesting
|
||||
* @snippet ads1x15-adc-sensor.cxx Interesting
|
||||
*/
|
||||
class ADS1015 : public ADS1X15, public IADC {
|
||||
|
||||
|
@ -81,6 +81,7 @@ namespace upm {
|
||||
*
|
||||
* @image html ads1115.jpg
|
||||
* @snippet ads1x15.cxx Interesting
|
||||
* @snippet ads1x15-ads1115.cxx Interesting
|
||||
*/
|
||||
class ADS1115 : public ADS1X15 {
|
||||
|
||||
|
@ -54,7 +54,7 @@ namespace upm {
|
||||
* performance compatible to the Bosch Sensortec BMP280 digital
|
||||
* pressure sensor.
|
||||
*
|
||||
* @snippet bme280.cxx Interesting
|
||||
* @snippet bmp280-bme280.cxx Interesting
|
||||
*/
|
||||
|
||||
class BME280 : public BMP280, public IHumiditySensor {
|
||||
|
@ -67,7 +67,7 @@ namespace upm {
|
||||
* initializes both devices, and provides a mechanism to read
|
||||
* accelerometer and magnetometer data from them.
|
||||
*
|
||||
* @snippet bmc150.cxx Interesting
|
||||
* @snippet bmx055-bmc150.cxx Interesting
|
||||
*/
|
||||
|
||||
class BMC150 {
|
||||
|
@ -61,7 +61,7 @@ namespace upm {
|
||||
* simply initializes both devices, and provides a mechanism to
|
||||
* read accelerometer and gyroscope data from them.
|
||||
*
|
||||
* @snippet bmi055.cxx Interesting
|
||||
* @snippet bmx055-bmi055.cxx Interesting
|
||||
*/
|
||||
|
||||
class BMI055 {
|
||||
|
@ -56,7 +56,7 @@ namespace upm {
|
||||
* frequencies based on the input voltage.
|
||||
*
|
||||
* @image html buzzer.jpg
|
||||
* @snippet buzzer-sound.cxx Interesting
|
||||
* @snippet buzzer.cxx Interesting
|
||||
*/
|
||||
|
||||
class Buzzer {
|
||||
|
@ -48,6 +48,7 @@ namespace upm
|
||||
* @type light
|
||||
* @man maxim
|
||||
* @con i2c
|
||||
* @snippet ds1808lc.cxx Interesting
|
||||
* @if ilightcontroller
|
||||
*/
|
||||
class DS1808LC : public upm::ILightController
|
||||
|
@ -46,7 +46,7 @@ namespace upm {
|
||||
* sensor with a detection range of 300-10,000 ppm.
|
||||
*
|
||||
* @image html mq2-5.jpeg
|
||||
* @snippet mq2.cxx Interesting
|
||||
* @snippet gas-mq2.cxx Interesting
|
||||
*/
|
||||
class MQ2 : public Gas {
|
||||
public:
|
||||
|
@ -45,7 +45,7 @@ namespace upm {
|
||||
* detection range is 0.04-4 mg/L Alcohol.
|
||||
*
|
||||
* @image html mq3-9.jpeg
|
||||
* @snippet mq3.cxx Interesting
|
||||
* @snippet gas-mq3.cxx Interesting
|
||||
*/
|
||||
class MQ3 : public Gas {
|
||||
public:
|
||||
|
@ -47,7 +47,7 @@ namespace upm {
|
||||
* at least 24 hours. See the datasheet for details.
|
||||
*
|
||||
* @image html mq2-5.jpeg
|
||||
* @snippet mq4.cxx Interesting
|
||||
* @snippet gas-mq4.cxx Interesting
|
||||
*/
|
||||
class MQ4 : public Gas {
|
||||
public:
|
||||
|
@ -46,7 +46,7 @@ namespace upm {
|
||||
* 300-10,000 ppm.
|
||||
*
|
||||
* @image html mq2-5.jpeg
|
||||
* @snippet mq5.cxx Interesting
|
||||
* @snippet gas-mq5.cxx Interesting
|
||||
*/
|
||||
class MQ5 : public Gas {
|
||||
public:
|
||||
|
@ -47,7 +47,7 @@ namespace upm {
|
||||
* at least 24 hours. See the datasheet for details.
|
||||
*
|
||||
* @image html mq2-5.jpeg
|
||||
* @snippet mq6.cxx Interesting
|
||||
* @snippet gas-mq6.cxx Interesting
|
||||
*/
|
||||
class MQ6 : public Gas {
|
||||
public:
|
||||
|
@ -47,7 +47,7 @@ namespace upm {
|
||||
* 48 hours. See the datasheet for details.
|
||||
*
|
||||
* @image html mq3-9.jpeg
|
||||
* @snippet mq7.cxx Interesting
|
||||
* @snippet gas-mq7.cxx Interesting
|
||||
*/
|
||||
class MQ7 : public Gas {
|
||||
public:
|
||||
|
@ -47,7 +47,7 @@ namespace upm {
|
||||
* at least 24 hours. See the datasheet for details.
|
||||
*
|
||||
* @image html mq2-5.jpeg
|
||||
* @snippet mq8.cxx Interesting
|
||||
* @snippet gas-mq8.cxx Interesting
|
||||
*/
|
||||
class MQ8 : public Gas {
|
||||
public:
|
||||
|
@ -44,7 +44,7 @@ namespace upm {
|
||||
* liquefied gas. Its sensitivity is 10-1,000 ppm CO, and 100-10,000 ppm Gas.
|
||||
*
|
||||
* @image html mq3-9.jpeg
|
||||
* @snippet mq9.cxx Interesting
|
||||
* @snippet gas-mq9.cxx Interesting
|
||||
*/
|
||||
class MQ9 : public Gas {
|
||||
public:
|
||||
|
@ -50,7 +50,7 @@ namespace upm {
|
||||
* operation to stabilize completely.
|
||||
*
|
||||
* @image html tp401.jpeg
|
||||
* @snippet tp401.cxx Interesting
|
||||
* @snippet gas-tp401.cxx Interesting
|
||||
*/
|
||||
class TP401 : public Gas {
|
||||
public:
|
||||
|
@ -49,7 +49,7 @@ namespace upm {
|
||||
* Basic UPM module for the Grove button
|
||||
*
|
||||
* @image html grovebutton.jpg
|
||||
* @snippet grovebutton.cxx Interesting
|
||||
* @snippet grove-grovebutton.cxx Interesting
|
||||
*/
|
||||
class GroveButton: public Grove {
|
||||
public:
|
||||
|
@ -53,8 +53,8 @@ namespace upm {
|
||||
* to the cathode, while the rounded side corresponds to the anode.
|
||||
*
|
||||
* @image html groveled.jpg
|
||||
* @snippet groveled.cxx Interesting
|
||||
* @snippet groveled-multi.cxx Interesting
|
||||
* @snippet grove-groveled.cxx Interesting
|
||||
* @snippet grove-groveled-multi.cxx Interesting
|
||||
*/
|
||||
class GroveLed: public Grove {
|
||||
public:
|
||||
|
@ -52,7 +52,7 @@ namespace upm {
|
||||
* An approximate lux value can also be returned.
|
||||
*
|
||||
* @image html grovelight.jpg
|
||||
* @snippet grovelight.cxx Interesting
|
||||
* @snippet grove-grovelight.cxx Interesting
|
||||
*/
|
||||
class GroveLight: public Grove {
|
||||
public:
|
||||
|
@ -51,7 +51,7 @@ namespace upm {
|
||||
* the indicator LED lights up and current is allowed to flow.
|
||||
*
|
||||
* @image html groverelay.jpg
|
||||
* @snippet groverelay.cxx Interesting
|
||||
* @snippet grove-groverelay.cxx Interesting
|
||||
*/
|
||||
class GroveRelay: public Grove {
|
||||
public:
|
||||
|
@ -51,7 +51,7 @@ namespace upm {
|
||||
* to do the same relative to the center of the knob's range.
|
||||
*
|
||||
* @image html rotaryencoder.jpg
|
||||
* @snippet groverotary.cxx Interesting
|
||||
* @snippet grove-groverotary.cxx Interesting
|
||||
*/
|
||||
class GroveRotary: public Grove {
|
||||
public:
|
||||
|
@ -48,7 +48,7 @@ namespace upm {
|
||||
* returns either a raw value or a scaled voltage value.
|
||||
*
|
||||
* @image html slide.jpg
|
||||
* @snippet groveslide.cxx Interesting
|
||||
* @snippet grove-groveslide.cxx Interesting
|
||||
*/
|
||||
class GroveSlide: public Grove {
|
||||
public:
|
||||
|
@ -52,7 +52,7 @@ namespace upm {
|
||||
* device. The range of this sensor is -40 to 125 C and accuracy is +/- 1.5 C.
|
||||
*
|
||||
* @image html grovetemp.jpg
|
||||
* @snippet grovetemp.cxx Interesting
|
||||
* @snippet grove-grovetemp.cxx Interesting
|
||||
*/
|
||||
class GroveTemp: public Grove {
|
||||
public:
|
||||
|
@ -48,6 +48,7 @@ namespace upm
|
||||
* @altname HLG150H
|
||||
* @type light
|
||||
* @con pwm
|
||||
* @snippet hlg150h.cxx Interesting
|
||||
* @web https://www.meanwell-web.com/en/product-info/ac-dc-power-supply/led-driver/101-180-w-led-driver/hlg-150h/product/HLG-150H-24B
|
||||
* @if ilightcontroller
|
||||
*/
|
||||
|
@ -52,7 +52,7 @@ namespace upm {
|
||||
* 2-axis analog joystick.
|
||||
*
|
||||
* @image html joystick12.jpg
|
||||
* @snippet joystick12-example.cxx Interesting
|
||||
* @snippet joystick12.cxx Interesting
|
||||
*/
|
||||
class Joystick12 {
|
||||
public:
|
||||
|
@ -79,7 +79,7 @@ namespace upm
|
||||
* <a href=https://creativecommons.org/licenses/by-nc-sa/3.0/>
|
||||
* CC BY-NC-SA-3.0</a>.</em>
|
||||
*
|
||||
* @snippet eboled.cxx Interesting
|
||||
* @snippet i2clcd-eboled.cxx Interesting
|
||||
*/
|
||||
class EBOLED : public LCD
|
||||
{
|
||||
|
@ -103,7 +103,7 @@ const uint8_t SSD1306_LCDHEIGHT = 64;
|
||||
* SSD1306 device from eBay.
|
||||
*
|
||||
* @image html ssd1306.jpeg
|
||||
* @snippet ssd1306-oled.cxx Interesting
|
||||
* @snippet i2clcd-ssd1306-oled.cxx Interesting
|
||||
*/
|
||||
class SSD1306 : public LCD
|
||||
{
|
||||
|
@ -51,7 +51,7 @@ const uint8_t DISPLAY_CMD_SET_NORMAL_1308 = 0xA6;
|
||||
* Display module, which is an OLED monochrome display.
|
||||
*
|
||||
* @image html ssd1308.jpeg
|
||||
* @snippet ssd1308-oled.cxx Interesting
|
||||
* @snippet i2clcd-ssd1308-oled.cxx Interesting
|
||||
*/
|
||||
class SSD1308 : public LCD
|
||||
{
|
||||
|
@ -50,7 +50,7 @@ const uint8_t DISPLAY_CMD_SET_NORMAL = 0xA4;
|
||||
* which is an OLED monochrome display.
|
||||
*
|
||||
* @image html ssd1327.jpeg
|
||||
* @snippet ssd1327-oled.cxx Interesting
|
||||
* @snippet i2clcd-ssd1327-oled.cxx Interesting
|
||||
*/
|
||||
class SSD1327 : public LCD
|
||||
{
|
||||
|
@ -57,8 +57,7 @@ namespace upm {
|
||||
* to the cathode, while the rounded side corresponds to the anode.
|
||||
*
|
||||
* @image html led.jpg
|
||||
* @snippet groveled.cxx Interesting
|
||||
* @snippet groveled-multi.cxx Interesting
|
||||
* @snippet led.cxx Interesting
|
||||
*/
|
||||
class Led {
|
||||
public:
|
||||
|
@ -52,7 +52,7 @@ namespace upm {
|
||||
* This module defines the LoL API and implementation for a simple framebuffer.
|
||||
*
|
||||
* @image html lolshield.jpg
|
||||
* @snippet lol-example.cxx Interesting
|
||||
* @snippet lol.cxx Interesting
|
||||
*/
|
||||
class LoL {
|
||||
public:
|
||||
|
@ -47,6 +47,7 @@ namespace upm
|
||||
* @type light
|
||||
* @man ti
|
||||
* @con i2c
|
||||
* @snippet lp8860.cxx Interesting
|
||||
* @web http://www.ti.com/product/LP8860-Q1
|
||||
* @if ilightcontroller
|
||||
*
|
||||
|
@ -103,7 +103,7 @@ namespace upm {
|
||||
* @web https://www.maximintegrated.com/en/products/analog/sensors-and-sensor-interface/MAX44009.html
|
||||
* @if ilightsensor
|
||||
*
|
||||
* @snippet iLightSensor.hpp Interesting
|
||||
* @snippet max44009.cxx Interesting
|
||||
*
|
||||
*/
|
||||
class MAX44009 : public ILightSensor {
|
||||
|
@ -48,7 +48,7 @@ namespace upm {
|
||||
* coupled with another device (such as the mcu9150 9-axis motion
|
||||
* sensor).
|
||||
*
|
||||
* @snippet ak8975.cxx Interesting
|
||||
* @snippet mpu9150-ak8975.cxx Interesting
|
||||
*/
|
||||
class AK8975 {
|
||||
public:
|
||||
|
@ -57,7 +57,7 @@ namespace upm {
|
||||
* required.
|
||||
*
|
||||
* @image html mpu60x0.jpg
|
||||
* @snippet mpu60x0.cxx Interesting
|
||||
* @snippet mpu9150-mpu60x0.cxx Interesting
|
||||
*/
|
||||
class MPU60X0 {
|
||||
public:
|
||||
|
@ -47,7 +47,7 @@ namespace upm {
|
||||
* This module defines the MPU9250 interface for libmpu9150
|
||||
*
|
||||
* @image html mpu9250.jpg
|
||||
* @snippet mpu9250.cxx Interesting
|
||||
* @snippet mpu9150-mpu9250.cxx Interesting
|
||||
*/
|
||||
|
||||
class MPU9250: public MPU9150
|
||||
|
@ -56,7 +56,7 @@ namespace upm {
|
||||
* with a rotary encoder and has 24 controllable LEDs.
|
||||
*
|
||||
* @image html grovecircularled.jpg
|
||||
* @snippet grovecircularled.cxx Interesting
|
||||
* @snippet my9221-grovecircularled.cxx Interesting
|
||||
*/
|
||||
|
||||
class GroveCircularLED : public MY9221 {
|
||||
|
@ -60,7 +60,7 @@ namespace upm {
|
||||
* so that this module can control multiple LED bars.
|
||||
*
|
||||
* @image html my9221.jpg
|
||||
* @snippet groveledbar.cxx Interesting
|
||||
* @snippet my9221-groveledbar.cxx Interesting
|
||||
*/
|
||||
|
||||
class GroveLEDBar : public MY9221 {
|
||||
|
@ -61,7 +61,7 @@ namespace upm {
|
||||
* An example using the UART.
|
||||
* @snippet nmea_gps.cxx Interesting
|
||||
* An example using I2C.
|
||||
* @snippet nmea_gps_i2c.cxx Interesting
|
||||
* @snippet nmea_gps-i2c.cxx Interesting
|
||||
*/
|
||||
|
||||
class NMEAGPS {
|
||||
|
@ -35,6 +35,7 @@ namespace upm {
|
||||
* @sensor dsb09104
|
||||
* @type wifi
|
||||
* @con uart
|
||||
* @snippet ozw-aeotecdsb09104.cxx Interesting
|
||||
* @man aeon
|
||||
* @web http://aeotec.com/z-wave-home-energy-measure/918-home-energy-meter-instructions.html
|
||||
*
|
||||
|
@ -36,6 +36,7 @@ namespace upm {
|
||||
* @altname DSB29
|
||||
* @type wifi
|
||||
* @con uart
|
||||
* @snippet ozw-aeotecdw2e.cxx Interesting
|
||||
* @man aeon
|
||||
* @web http://aeotec.com/z-wave-door-window-sensor
|
||||
*
|
||||
|
@ -34,6 +34,7 @@ namespace upm {
|
||||
* @sensor dg2
|
||||
* @comname Aeotec Smart Dimmer Gen 2
|
||||
* @con uart
|
||||
* @snippet ozw-aeotecsdg2.cxx Interesting
|
||||
* @type wifi
|
||||
* @man aeon
|
||||
* @web http://aeotec.com/z-wave-in-wall-switches/877-micro-sei-2e-manual-instructions.html
|
||||
|
@ -34,6 +34,7 @@ namespace upm {
|
||||
* @sensor ss6
|
||||
* @comname Aeotec Smart Switch 6
|
||||
* @con uart
|
||||
* @snippet ozw-aeotecss6.cxx Interesting
|
||||
* @type wifi
|
||||
* @man aeon
|
||||
* @web http://aeotec.com/z-wave-plug-in-switch
|
||||
|
@ -41,7 +41,7 @@ namespace upm {
|
||||
* (ozwdump), which initializes OZW on a Z-Wave network, and then
|
||||
* prints out all Nodes (devices) and their associated valueids.
|
||||
*
|
||||
* @snippet ozwdump.cxx
|
||||
* @snippet ozw-ozwdump.cxx Interesting
|
||||
*/
|
||||
|
||||
class OZWDUMP : public ozwInterface {
|
||||
|
@ -34,6 +34,7 @@ namespace upm {
|
||||
* @sensor tzemt400
|
||||
* @comname Trane TZEMT400 Z-Wave Thermostat.
|
||||
* @con uart
|
||||
* @snippet ozw-tzemt400.cxx Interesting
|
||||
* @man trane
|
||||
*
|
||||
* @brief UPM API for Trane TZEMT400 Z-Wave Thermostat
|
||||
|
@ -41,6 +41,7 @@ namespace upm {
|
||||
* @type pressure temperature
|
||||
* @man honeywell
|
||||
* @con spi
|
||||
* @snippet rsc.cxx Interesting
|
||||
* @web https://sensing.honeywell.com/honeywell-sensing-trustability-rsc-series-data-sheet-32321348-b-en.pdf
|
||||
*
|
||||
* @brief Description for the RSC TruStability line
|
||||
|
@ -59,7 +59,7 @@ namespace upm
|
||||
* board-specifics, testing, etc...
|
||||
*
|
||||
* @image html sensortemplate.png
|
||||
* @snippet <example-name.cxx> Interesting
|
||||
* @snippet sensortemplate.cxx Interesting
|
||||
*/
|
||||
|
||||
class SensorTemplate
|
||||
|
@ -48,7 +48,7 @@ namespace upm {
|
||||
* maximum period.
|
||||
*
|
||||
* @image html es08a.jpg
|
||||
* @snippet es08a.cxx Interesting
|
||||
* @snippet servo-es08a.cxx Interesting
|
||||
*/
|
||||
class ES08A : public Servo {
|
||||
public:
|
||||
|
@ -52,6 +52,7 @@ namespace upm {
|
||||
* @man silabs
|
||||
* @web http://www.silabs.com/products/sensors/infraredsensors/Pages/si1132.aspx
|
||||
* @con i2c
|
||||
* @snippet si1132.cxx Interesting
|
||||
* @if ilightsensor
|
||||
|
||||
*/
|
||||
|
@ -65,6 +65,7 @@ namespace upm {
|
||||
*
|
||||
* @image html speaker.jpg
|
||||
* @snippet speaker.cxx Interesting
|
||||
* @snippet speaker-pwm.cxx Interesting
|
||||
*/
|
||||
class Speaker {
|
||||
public:
|
||||
|
@ -51,7 +51,7 @@ namespace upm {
|
||||
* is a CO2 Module sensor.
|
||||
*
|
||||
* @snippet t6713.cxx Interesting
|
||||
* @snippet co2-sensor.cxx Interesting
|
||||
* @snippet t6713-co2-sensor.cxx Interesting
|
||||
*/
|
||||
|
||||
namespace t6713_co2
|
||||
|
@ -41,6 +41,7 @@ namespace upm {
|
||||
* @comname Generic AT Command Based UART Device
|
||||
* @type other
|
||||
* @con uart
|
||||
* @snippet uartat-le910.cxx Interesting
|
||||
*
|
||||
* @brief API for a Generic AT command based UART device
|
||||
*
|
||||
|
@ -45,7 +45,7 @@ namespace upm {
|
||||
* it may actuate a pump, an indicator, an alarm, or other devices.
|
||||
*
|
||||
* @image html waterlevel.jpg
|
||||
* @snippet apds9002.cxx Interesting
|
||||
* @snippet waterlevel.cxx Interesting
|
||||
*/
|
||||
class WaterLevel {
|
||||
public:
|
||||
|
Loading…
x
Reference in New Issue
Block a user