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>
This commit is contained in:
Mihai Tudor Panu
2018-02-13 10:19:14 -08:00
parent 38817b72dc
commit a12baf379f
37 changed files with 82 additions and 76 deletions

View File

@ -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 {

View File

@ -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 {

View File

@ -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 {

View File

@ -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 {

View File

@ -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 {

View File

@ -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.
*/