doxygen: updated descriptions to clean up @con tags for xml generation

This ensures the generated xml paragraphs for the connection field won't have nested children and hence should be readable by the ISS parser properly Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
2025-03-14 20:47:30 +03:00 · 2018-02-13 10:19:14 -08:00 · 2018-02-13 10:19:14 -08:00 · a12baf379f
commit a12baf379f
parent 38817b72dc
37 changed files with 82 additions and 76 deletions
--- a/src/ds1808lc/ds1808lc.hpp
+++ b/src/ds1808lc/ds1808lc.hpp
@ -34,13 +34,6 @@ namespace upm
 */

 /**
- * @brief API for DS1808 Dual Log Digital Potentiometer as a Light Controller
- *
- * The Maxim Integrated
- * [DS1808](http://www.maximintegrated.com/en/products/analog/data-converters/digital-potentiometers/DS1808.html)
- * Dual Log Digital Potentiometer
- *
- *
 * @library ds1808lc
 * @sensor ds1808lc
 * @comname Lighting Controller
@ -48,8 +41,15 @@ namespace upm
 * @type light
 * @man maxim
 * @con i2c
+ * @web http://www.maximintegrated.com/en/products/analog/data-converters/digital-potentiometers/DS1808.html
+ *
+ * @brief API for DS1808 Dual Log Digital Potentiometer as a Light Controller
+ *
+ * The Maxim Integrated
+ * [DS1808](http://www.maximintegrated.com/en/products/analog/data-converters/digital-potentiometers/DS1808.html)
+ * Dual Log Digital Potentiometer
+ *
 * @snippet ds1808lc.cxx Interesting
- * @if ilightcontroller
 */
 class DS1808LC : public upm::ILightController
 {
--- a/src/grove/grovebutton.hpp
+++ b/src/grove/grovebutton.hpp
@ -33,6 +33,8 @@
 namespace upm {

 /**
+ * @deprecated This class is being replaced by the upm-button library and the
+ * Button class.
 * @library grove
 * @sensor grovebutton
 * @comname Button
@ -41,8 +43,6 @@ namespace upm {
 * @man seeed
 * @con gpio
 * @kit gsk
- * @deprecated This class is being replaced by the upm-button library and the
- * Button class.
 *
 * @brief API for the Grove Button
 *
--- a/src/grove/groveled.hpp
+++ b/src/grove/groveled.hpp
@ -33,6 +33,8 @@
 namespace upm {

 /**
+ * @deprecated This class is being replaced by the upm-led library and the
+ * Led class.
 * @library grove
 * @sensor groveled
 * @comname LED
@ -40,8 +42,6 @@ namespace upm {
 * @man seeed
 * @con gpio
 * @kit gsk
- * @deprecated This class is being replaced by the upm-led library and the
- * Led class.
 *
 * @brief API for the Grove LED
 *
--- a/src/grove/grovelight.hpp
+++ b/src/grove/grovelight.hpp
@ -33,6 +33,8 @@
 namespace upm {

 /**
+ * @deprecated This class is being replaced by the upm-light library and the
+ * Light class.
 * @library grove
 * @sensor grovelight
 * @comname Light Sensor
@ -40,8 +42,6 @@ namespace upm {
 * @man seeed
 * @con analog
 * @kit gsk
- * @deprecated This class is being replaced by the upm-light library and the
- * Light class.
 *
 * @brief API for the Grove Light Sensor
 *
--- a/src/grove/groverelay.hpp
+++ b/src/grove/groverelay.hpp
@ -33,6 +33,8 @@
 namespace upm {

 /**
+ * @deprecated This class is being replaced by the upm-relay library and the
+ * Relay class.
 * @library grove
 * @sensor groverelay
 * @comname Relay
@ -40,8 +42,6 @@ namespace upm {
 * @man seeed
 * @con gpio
 * @kit gsk eak hak
- * @deprecated This class is being replaced by the upm-relay library and the
- * Relay class.
 *
 * @brief API for the Grove Relay
 * 
--- a/src/grove/groverotary.hpp
+++ b/src/grove/groverotary.hpp
@ -33,6 +33,8 @@
 namespace upm {

 /**
+ * @deprecated This class is being replaced by the upm-rotary library and the
+ * Rotary class.
 * @library grove
 * @sensor groverotary
 * @comname Rotary Angle Sensor
@ -41,8 +43,6 @@ namespace upm {
 * @man seeed
 * @con analog
 * @kit gsk
- * @deprecated This class is being replaced by the upm-rotary library and the
- * Rotary class.
 *
 * @brief API for the Grove Rotary Angle Sensor (Knob)
 *
--- a/src/grove/groveslide.hpp
+++ b/src/grove/groveslide.hpp
@ -33,14 +33,14 @@
 namespace upm {

 /**
+ * @deprecated This class is being replaced by the upm-slide library and the
+ * Slide class.
 * @library grove
 * @sensor groveslide
 * @comname Slide Potentiometer
 * @type ainput
 * @man seeed
 * @con analog
- * @deprecated This class is being replaced by the upm-slide library and the
- * Slide class.
 *
 * @brief API for the Grove Slide Potentiometer
 *
--- a/src/grove/grovetemp.hpp
+++ b/src/grove/grovetemp.hpp
@ -33,6 +33,8 @@
 namespace upm {

 /**
+ * @deprecated This class is being replaced by the upm-temperature library and
+ * the Temperature class.
 * @library grove
 * @sensor grovetemp
 * @comname Temperature Sensor
@ -40,8 +42,6 @@ namespace upm {
 * @man seeed
 * @con analog
 * @kit gsk
- * @deprecated This class is being replaced by the upm-temperature library and
- * the Temperature class.
 *
 * @brief API for the Grove Temperature Sensor
 *
--- a/src/grovecollision/grovecollision.hpp
+++ b/src/grovecollision/grovecollision.hpp
@ -34,13 +34,13 @@ namespace upm {
   */

  /**
+   * @deprecated This class is being replaced by Collision
   * @library grovecollision
   * @sensor grovecollision
   * @comname Collision Sensor
   * @type accelerometer
   * @man seeed
   * @con gpio
-   * @deprecated This class is being replaced by Collision
   *
   * @brief API for the Grove Collision Sensor
   * 
--- a/src/groveehr/groveehr.hpp
+++ b/src/groveehr/groveehr.hpp
@ -37,13 +37,13 @@ namespace upm {
   */

  /**
+   * @deprecated This class is being replaced by EHR
   * @library groveehr
   * @sensor groveehr
   * @comname Ear-clip Heart Rate Sensor
   * @type medical
   * @man seeed
   * @con gpio
-   * @deprecated This class is being replaced by EHR
   *
   * @brief API for the Grove Ear-clip Heart Rate Sensor
   *
--- a/src/groveeldriver/groveeldriver.hpp
+++ b/src/groveeldriver/groveeldriver.hpp
@ -37,13 +37,13 @@ namespace upm {
   */

  /**
+   * @deprecated This class is being replaced by ElDriver
   * @library groveeldriver
   * @sensor groveeldriver
   * @comname Electroluminescent (EL) Driver
   * @type electric
   * @man seeed
   * @con gpio
-   * @deprecated This class is being replaced by ElDriver
   *
   * @brief API for the Grove EL Driver Module
   * 
--- a/src/groveelectromagnet/groveelectromagnet.hpp
+++ b/src/groveelectromagnet/groveelectromagnet.hpp
@ -37,13 +37,13 @@ namespace upm {
   */

  /**
+   * @deprecated This class is being replaced by Electromagnet
   * @library groveelectromagnet
   * @sensor groveelectromagnet
   * @comname Electromagnet
   * @type electric
   * @man seeed
   * @con gpio
-   * @deprecated This class is being replaced by Electromagnet
   *
   * @brief API for the Grove Electromagnet
   * 
--- a/src/groveemg/groveemg.hpp
+++ b/src/groveemg/groveemg.hpp
@ -35,13 +35,13 @@ namespace upm {
   */

  /**
+   * @deprecated This class is being replaced by EMG
   * @library groveemg
   * @sensor groveemg
   * @comname Electromyography (EMG) Sensor
   * @type electric
   * @man seeed
   * @con analog
-   * @deprecated This class is being replaced by EMG
   *
   * @brief API for the Grove EMG Muscle Signal Reader
   *
--- a/src/grovegprs/grovegprs.hpp
+++ b/src/grovegprs/grovegprs.hpp
@ -47,6 +47,7 @@ namespace upm {
     */

    /**
+     * @deprecated This class is being replaced by GPRS
     * @library grovegprs
     * @sensor grovegprs
     * @comname GPRS Module
@ -54,7 +55,6 @@ namespace upm {
     * @man seeed
     * @con uart
     * @web http://www.seeedstudio.com/wiki/GPRS_Shield_V2.0
-     * @deprecated This class is being replaced by GPRS
     *
     * @brief API for the Grove GPRS Module
     *
--- a/src/grovegsr/grovegsr.hpp
+++ b/src/grovegsr/grovegsr.hpp
@ -35,13 +35,13 @@ namespace upm {
   */

  /**
+   * @deprecated This class is being replaced by GSR
   * @library grovegsr
   * @sensor grovegsr
   * @comname Galvanic Skin Response (GSR) Sensor
   * @type electric
   * @man seeed
   * @con analog
-   * @deprecated This class is being replaced by GSR
   *
   * @brief API for the Grove GSR Galvanic Skin Response Sensor
   * 
--- a/src/grovelinefinder/grovelinefinder.hpp
+++ b/src/grovelinefinder/grovelinefinder.hpp
@ -35,6 +35,7 @@ namespace upm {
   */

  /**
+   * @deprecated This class is being replaced by LineFinder
   * @library grovelinefinder
   * @sensor grovelinefinder
   * @comname Line Finder
@ -42,7 +43,6 @@ namespace upm {
   * @man seeed
   * @con gpio
   * @kit robok
-   * @deprecated This class is being replaced by LineFinder
   *
   * @brief API for the Grove Line Finder Sensor
   *
--- a/src/grovemd/grovemd.hpp
+++ b/src/grovemd/grovemd.hpp
@ -41,6 +41,7 @@ namespace upm {
   */

  /**
+   * @deprecated This class is being replaced by MD
   * @library grovemd
   * @sensor grovemd
   * @comname I2C Motor Driver
@ -48,7 +49,6 @@ namespace upm {
   * @man seeed
   * @con i2c
   * @kit robok
-   * @deprecated This class is being replaced by MD
   *
   * @brief API for the Grove I2C Motor Driver 
   *
--- a/src/grovemoisture/grovemoisture.hpp
+++ b/src/grovemoisture/grovemoisture.hpp
@ -35,6 +35,7 @@ namespace upm {
   */

  /**
+   * @deprecated This class is being replaced by Moisture
   * @library grovemoisture
   * @sensor grovemoisture
   * @comname Moisture Sensor
@ -42,7 +43,6 @@ namespace upm {
   * @man seeed
   * @con analog
   * @kit eak hak
-   * @deprecated This class is being replaced by Moisture
   *
   * @brief API for the Grove Moisture Sensor
   *
--- a/src/groveo2/groveo2.hpp
+++ b/src/groveo2/groveo2.hpp
@ -35,13 +35,13 @@ namespace upm {
   */

  /**
+   * @deprecated This class is being replaced by O2
   * @library groveo2
   * @sensor groveo2
   * @comname Oxygen (O2) Concentration Sensor
   * @type gaseous
   * @man seeed
   * @con analog
-   * @deprecated This class is being replaced by O2
   *
   * @brief API for the Grove O2 Oxygen Gas Sensor
   *
--- a/src/grovescam/grovescam.hpp
+++ b/src/grovescam/grovescam.hpp
@ -55,6 +55,7 @@ namespace upm {
     */

    /**
+     * @deprecated This class is being replaced by SCAM
     * @library grovescam
     * @sensor grovescam
     * @comname Serial Camera Module
@ -62,7 +63,6 @@ namespace upm {
     * @man seeed
     * @con uart
     * @web http://www.seeedstudio.com/wiki/Grove_-_Serial_Camera_Kit
-     * @deprecated This class is being replaced by SCAM
     *
     * @brief API for the Grove Serial Camera
     *
--- a/src/grovespeaker/grovespeaker.hpp
+++ b/src/grovespeaker/grovespeaker.hpp
@ -48,6 +48,7 @@ typedef struct
    int delayTimeHighSharp;
 } NoteData;
  /**
+   * @deprecated This class is being replaced by Speaker
   * @library grovespeaker
   * @sensor grovespeaker
   * @comname Speaker Module
@ -55,7 +56,6 @@ typedef struct
   * @man seeed
   * @con gpio
   * @kit hak
-   * @deprecated This class is being replaced by Speaker
   *
   * @brief API for the Grove Speaker
   *
--- a/src/groveultrasonic/groveultrasonic.hpp
+++ b/src/groveultrasonic/groveultrasonic.hpp
@ -43,13 +43,13 @@ namespace upm {
 */

 /**
+ * @deprecated This class is being replaced by UltraSonic
 * @library groveultrasonic
 * @sensor groveultrasonic
 * @comname Ultrasonic Proximity Sensor
 * @type sound
 * @man seeed
 * @con gpio
- * @deprecated This class is being replaced by UltraSonic
 *
 * @brief API for Grove Ultrasonic Ranger
 *
--- a/src/grovevdiv/grovevdiv.hpp
+++ b/src/grovevdiv/grovevdiv.hpp
@ -43,6 +43,7 @@ namespace upm {
   */

  /**
+   * @deprecated This class is being replaced by VDiv
   * @library grovevdiv
   * @sensor grovevdiv
   * @comname Voltage Divider
@ -50,7 +51,6 @@ namespace upm {
   * @man seeed
   * @con analog
   * @kit robok
-   * @deprecated This class is being replaced by VDiv
   *
   * @brief API for the Grove Voltage Divider Sensor
   *
--- a/src/grovewater/grovewater.hpp
+++ b/src/grovewater/grovewater.hpp
@ -35,6 +35,7 @@ namespace upm {
   */

  /**
+   * @deprecated This class is being replaced by Water
   * @library grovewater
   * @sensor grovewater
   * @comname Water Sensor
@ -42,7 +43,6 @@ namespace upm {
   * @man seeed
   * @con gpio
   * @kit eak
-   * @deprecated This class is being replaced by Water
   *
   * @brief API for the Grove Water Sensor
   *
--- a/src/grovewfs/grovewfs.hpp
+++ b/src/grovewfs/grovewfs.hpp
@ -38,6 +38,7 @@ namespace upm {
   */

  /**
+   * @deprecated This class is being replaced by WFS
   * @library grovewfs
   * @sensor grovewfs
   * @comname Water Flow Sensor
@ -46,7 +47,6 @@ namespace upm {
   * @web http://wiki.seeedstudio.com/wiki/G1/2_Water_Flow_sensor
   * @con gpio
   * @kit eak
-   * @deprecated This class is being replaced by WFS
   *
   * @brief API for the Grove Water Flow Sensor
   *
--- a/src/hlg150h/hlg150h.hpp
+++ b/src/hlg150h/hlg150h.hpp
@ -36,21 +36,21 @@ namespace upm
 */

 /**
- * @brief API for HLG-150H Lighting Power Supply Controller
- *
- * The Mean Well
- * [HLG-150H](http://www.meanwell.com/webapp/product/search.aspx?prod=HLG-150H)
- * 150W Single Output Switching Power Supply
- *
 * @library hlg150h
 * @sensor hlg150h
 * @comname 150W Constant Voltage/current LED Driver
 * @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
+ *
+ * @brief API for HLG-150H Lighting Power Supply Controller
+ *
+ * The Mean Well
+ * [HLG-150H](http://www.meanwell.com/webapp/product/search.aspx?prod=HLG-150H)
+ * 150W Single Output Switching Power Supply
+ *
+ * @snippet hlg150h.cxx Interesting
 */

 class HLG150H : public upm::ILightController
--- a/src/lp8860/lp8860.hpp
+++ b/src/lp8860/lp8860.hpp
@ -34,12 +34,6 @@ namespace upm
 */

 /**
- * @brief API for LP8860 LED Lighting Controller
- *
- * The Texas Instrumements
- * [LP8860-Q1](http://www.ti.com/product/lp8860-q1)
- * Automotive Catalog Low-EMI, High-Performance 4-Channel LED Driver
- *
 * @library lp8860
 * @sensor lp8860
 * @comname LED Lighting Controller
@ -47,10 +41,15 @@ namespace upm
 * @type light
 * @man ti
 * @con i2c
- * @snippet lp8860.cxx Interesting
 * @web http://www.ti.com/product/LP8860-Q1
- * @if ilightcontroller
 *
+ * @brief API for LP8860 LED Lighting Controller
+ *
+ * The Texas Instrumements
+ * [LP8860-Q1](http://www.ti.com/product/lp8860-q1)
+ * Automotive Catalog Low-EMI, High-Performance 4-Channel LED Driver
+ *
+ * @snippet lp8860.cxx Interesting
 */
 class LP8860 : public upm::ILightController
 {
--- a/src/ozw/aeotecdsb09104.hpp
+++ b/src/ozw/aeotecdsb09104.hpp
@ -35,7 +35,6 @@ 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
   *
@ -43,6 +42,8 @@ namespace upm {
   *
   * This module allows for monitoring certain elements of an Aeotec
   * Home Energy Meter Gen 1.
+   *
+   * @snippet ozw-aeotecdsb09104.cxx Interesting
   */

  class AeotecDSB09104 : public ozwInterface {
--- a/src/ozw/aeotecdw2e.hpp
+++ b/src/ozw/aeotecdw2e.hpp
@ -36,7 +36,6 @@ namespace upm {
   * @altname DSB29
   * @type wifi
   * @con uart
-   * @snippet ozw-aeotecdw2e.cxx Interesting
   * @man aeon
   * @web http://aeotec.com/z-wave-door-window-sensor
   *
@ -57,6 +56,8 @@ namespace upm {
   * include button on the device.  By default the device will never
   * wake on it's own, so you should use the openzwave control panel
   * or similar software to configure a periodic wakeup time.
+   *
+   * @snippet ozw-aeotecdw2e.cxx Interesting
   */

  class AeotecDW2E : public ozwInterface {
--- a/src/ozw/aeotecsdg2.hpp
+++ b/src/ozw/aeotecsdg2.hpp
@ -34,7 +34,6 @@ 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
@ -43,6 +42,8 @@ namespace upm {
   *
   * This module allows for controlling and monitoring certain
   * elements of an Aeotec Smart Dimmer Gen 2.
+   *
+   * @snippet ozw-aeotecsdg2.cxx Interesting
   */

  class AeotecSDG2 : public ozwInterface {
--- a/src/ozw/aeotecss6.hpp
+++ b/src/ozw/aeotecss6.hpp
@ -34,7 +34,6 @@ 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
@ -43,6 +42,8 @@ namespace upm {
   *
   * This module allows for controlling and monitoring certain
   * elements of an Aeotec Smart Switch 6.
+   *
+   * @snippet ozw-aeotecss6.cxx Interesting
   */

  class AeotecSS6 : public ozwInterface {
--- a/src/ozw/tzemt400.hpp
+++ b/src/ozw/tzemt400.hpp
@ -34,7 +34,6 @@ 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
@ -42,6 +41,8 @@ namespace upm {
   * This module allows for monitoring certain elements of a Trane
   * TZEMT400 Z-Wave Thermostat.  It was tested with a Trane
   * TZEMT400BB32MAA variant.
+   *
+   * @snippet ozw-tzemt400.cxx Interesting
   */

  class TZEMT400 : public ozwInterface {
--- a/src/ozw/zwNode.hpp
+++ b/src/ozw/zwNode.hpp
@ -36,7 +36,7 @@ namespace upm {
   * @brief Node management for ozw
   *
   * This class is used by ozw to manage valueids for a node (device).
-   * No user-servicable parts inside.  It is not exposed to the end
+   * No user-serviceable parts inside.  It is not exposed to the end
   * user.
   */

--- a/src/rn2903/rn2903.hpp
+++ b/src/rn2903/rn2903.hpp
@ -41,9 +41,6 @@ namespace upm {
     * @comname Microchip RN2903 LoRa radio
     * @type wifi
     * @con uart
-     * @snippet rn2903.cxx Interesting
-     * @snippet rn2903-p2p-tx.cxx Interesting
-     * @snippet rn2903-p2p-rx.cxx Interesting
     *
     * @brief API for the Microchip RN2903 LoRa radio
     *
@ -61,6 +58,10 @@ namespace upm {
     * operation within a LoRaWAN network, however methods are
     * provided to allow you to control the device directly so that
     * you can implement whatever solution you require.
+     *
+     * @snippet rn2903.cxx Interesting
+     * @snippet rn2903-p2p-tx.cxx Interesting
+     * @snippet rn2903-p2p-rx.cxx Interesting
     */

    class RN2903 {
--- a/src/rsc/rsc.hpp
+++ b/src/rsc/rsc.hpp
@ -42,7 +42,6 @@ namespace upm {
     * @type pressure temp
     * @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
@ -73,6 +72,7 @@ namespace upm {
     * More info about this has been provided in the datasheet with a table and
     * a diagram.
     *
+     * @snippet rsc.cxx Interesting
     */
    class RSC {

--- a/src/si1132/si1132.hpp
+++ b/src/si1132/si1132.hpp
@ -37,6 +37,16 @@ namespace upm {
 */

 /**
+ * @library si1132
+ * @sensor si1132
+ * @comname UV and Ambient Light Sensor
+ * @altname Si1132
+ * @type light
+ * @man silabs
+ * @con i2c
+ * @web http://www.silabs.com/products/sensors/infraredsensors/Pages/si1132.aspx
+ * @web https://www.silabs.com/Support%20Documents/TechnicalDocs/Si1132.pdf
+ *
 * @brief API for Si1132 UV and Visible Light Sensor
 *
 * The Silicon Labs
@ -44,17 +54,7 @@ namespace upm {
 * is a low-power, ultraviolet (UV) index, and ambient light sensor with I2C
 * digital interface and programmable-event interrupt output.
 *
- * @library si1132
- * @sensor si1132
- * @comname UV and Ambient Light Sensor
- * @altname Si1132
- * @type light
- * @man silabs
- * @web http://www.silabs.com/products/sensors/infraredsensors/Pages/si1132.aspx
- * @con i2c
 * @snippet si1132.cxx Interesting
- * @if ilightsensor
-
 */
 class SI1132 : public ILightSensor {
    public:
--- a/src/uartat/uartat.hpp
+++ b/src/uartat/uartat.hpp
@ -41,7 +41,6 @@ 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
     *
@ -49,6 +48,8 @@ namespace upm {
     * devices that utilize an "AT" command set.  Typically these
     * devices are Radios, Modems, and similar devices that are
     * configured and controlled by emitting "AT" commands.
+     *
+     * @snippet uartat-le910.cxx Interesting
     */

    class UARTAT {