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,5 +1,5 @@
set (libname "hmtrp")
set (libdescription "Grove serial rf pro (hmtrp) module")
set (libdescription "Serial RF Pro Module")
set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp)
upm_module_init(mraa)

View File

@ -52,11 +52,12 @@ namespace upm {
/**
* @library hmtrp
* @sensor hmtrp
* @comname Grove Serial RF Pro
* @comname Serial RF Pro Module
* @altname HMTRP-433 HMTRP-470 HMTRP-868 HMTRP-915
* @type wifi
* @man seeed
* @con uart
* @web http://wiki.seeed.cc/Grove-Serial_RF_Pro/
*
* @brief API for the HM-TRP Serial RF Pro transceiver
*