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 "rfr359f")
set (libdescription "Rfr359f grove distance interrupter")
set (libdescription "Infrared Distance Interrupter")
set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp)
upm_module_init(mraa)

View File

@ -36,11 +36,11 @@ namespace upm {
/**
* @library rfr359f
* @sensor rfr359f
* @comname RFR359F Distance Interrupter
* @comname Infrared Distance Interrupter
* @altname Grove Distance Interrupter
* @type light
* @man seeed
* @web http://www.seeedstudio.com/wiki/Grove_-_IR_Distance_Interrupt
* @web https://www.seeedstudio.com/Grove-IR-Distance-Interrupter-p-1278.html
* @con gpio
* @kit robok tsk
*