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

@ -4,7 +4,7 @@ include (CheckIncludeFiles)
check_library_exists (${MRAA_LIBRARIES} mraa_firmata_init "" HAVE_FIRMATA)
if (HAVE_FIRMATA)
set (libname "curieimu")
set (libdescription "Curie IMU via Firmata")
set (libdescription "Curie IMU Sensor using Firmata")
set (module_src ${libname}.cpp)
set (module_hpp ${libname}.hpp)
upm_module_init (mraa)

View File

@ -58,7 +58,7 @@ struct IMUDataItem {
/**
* @library curieimu
* @sensor curieimu
* @comname Curie IMU Sensor with Firmata
* @comname Curie IMU Sensor using Firmata
* @altname Curie IMU Sensor for Arduino/Genuino 101 running Firmata
* @type accelerometer compass
* @man bosch