doc: Scrubbed ALL sensor library descriptions

In an effort to clean-up and standardize UPM library
documentation, this commit updates (and in most cases,
unifies) the CMake description string AND CXX header
@comname string.

Strings were taken from datasheets when possible, spelling
mistakes were addressed, copy/paste errors where fixed,
Title Case was used, etc.

    * Tested/updated/added @web tags
    * Added/updated invalid sensor images
    * Added/updated @man tags, added missing manufacturers

Signed-off-by: Noel Eck <noel.eck@intel.com>
This commit is contained in:
Noel Eck
2016-12-15 15:15:21 -08:00
parent 7a5c8a6cb3
commit 283fce619e
416 changed files with 793 additions and 675 deletions

View File

@ -1,6 +1,6 @@
if (OPENZWAVE_FOUND)
set (libname "ozw")
set (libdescription "Module for the OpenZWave library interface")
set (libdescription "Module for the OpenZWave Library Interface")
set (module_src ${libname}.cxx zwNode.cxx ozwinterface.cxx ozwdump.cxx aeotecss6.cxx aeotecsdg2.cxx aeotecdw2e.cxx aeotecdsb09104.cxx tzemt400.cxx)
set (module_hpp ${libname}.hpp ozwinterface.hpp ozwdump.hpp aeotecss6.hpp aeotecsdg2.hpp aeotecdw2e.hpp aeotecdsb09104.hpp tzemt400.hpp)

View File

@ -32,7 +32,11 @@ namespace upm {
/**
* @library ozw
* @comname Aeotec Home Energy Meter Gen 1
* @sensor dsb09104
* @type wifi
* @con uart
* @man aeon
* @web http://aeotec.com/z-wave-home-energy-measure/918-home-energy-meter-instructions.html
*
* @brief UPM API for Aeotec Home Energy Meter Gen 1
*

View File

@ -31,9 +31,13 @@ namespace upm {
/**
* @library ozw
* @sensor DSB29
* @comname Aeotec Door/Window Sensor 2nd Edition
* @altname DSB29
* @type wifi
* @con uart
* @man aeon
* @web http://aeotec.com/z-wave-door-window-sensor
*
* @brief UPM API for Aeotec Door/Window Sensor 2nd Edition
*

View File

@ -31,8 +31,12 @@ namespace upm {
/**
* @library ozw
* @sensor dg2
* @comname Aeotec Smart Dimmer Gen 2
* @con uart
* @type wifi
* @man aeon
* @web http://aeotec.com/z-wave-in-wall-switches/877-micro-sei-2e-manual-instructions.html
*
* @brief UPM API for Aeotec Smart Dimmer Gen 2
*

View File

@ -31,8 +31,12 @@ namespace upm {
/**
* @library ozw
* @sensor ss6
* @comname Aeotec Smart Switch 6
* @con uart
* @type wifi
* @man aeon
* @web http://aeotec.com/z-wave-plug-in-switch
*
* @brief UPM API for Aeotec Smart Switch 6
*

View File

@ -45,7 +45,7 @@ namespace upm {
/**
* @library ozw
* @sensor ozw
* @comname UPM wrapper for the OpenZWave library
* @comname Wrapper for the OpenZWave Library
* @type wifi
* @man other
* @con uart

View File

@ -31,7 +31,7 @@ namespace upm {
/**
* @library ozw
* @comname UPM Interface API for ozwdump
* @comname Interface API for Ozwdump
* @con uart
*
* @brief UPM Utility driver for OZW.

View File

@ -31,8 +31,10 @@ namespace upm {
/**
* @library ozw
* @sensor tzemt400
* @comname Trane TZEMT400 Z-Wave Thermostat.
* @con uart
* @man trane
*
* @brief UPM API for Trane TZEMT400 Z-Wave Thermostat
*