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 "grove")
set (libdescription "Grove module")
set (libdescription "Grove Starter Kit Sensor Library")
set (module_src grovebutton.cxx groveled.cxx grovelight.cxx groverelay.cxx groverotary.cxx groveslide.cxx grovetemp.cxx)
set (module_hpp grovebutton.hpp groveled.hpp grovelight.hpp groverelay.hpp groverotary.hpp groveslide.hpp grovetemp.hpp grovebase.hpp grove.hpp)
upm_module_init(mraa)

View File

@ -35,7 +35,7 @@ namespace upm {
/**
* @library grove
* @sensor grovebutton
* @comname Grove Button
* @comname Button
* @altname Grove Touch Sensor
* @type button touch
* @man seeed

View File

@ -35,7 +35,7 @@ namespace upm {
/**
* @library grove
* @sensor groveled
* @comname Grove LED
* @comname LED
* @type led
* @man seeed
* @con gpio

View File

@ -35,7 +35,7 @@ namespace upm {
/**
* @library grove
* @sensor grovelight
* @comname Grove Light Sensor
* @comname Light Sensor
* @type light
* @man seeed
* @con analog

View File

@ -35,7 +35,7 @@ namespace upm {
/**
* @library grove
* @sensor groverelay
* @comname Grove Relay
* @comname Relay
* @type relay
* @man seeed
* @con gpio

View File

@ -35,7 +35,7 @@ namespace upm {
/**
* @library grove
* @sensor groverotary
* @comname Grove Rotary Angle Sensor
* @comname Rotary Angle Sensor
* @altname Rotary Potentiometer
* @type ainput
* @man seeed
@ -50,7 +50,7 @@ namespace upm {
* a set of functions to read the absolute pin value, degrees or radians, and another set
* to do the same relative to the center of the knob's range.
*
* @image html groverotary.jpeg
* @image html rotaryencoder.jpg
* @snippet groverotary.cxx Interesting
*/
class GroveRotary: public Grove {

View File

@ -35,7 +35,7 @@ namespace upm {
/**
* @library grove
* @sensor groveslide
* @comname Grove Slide Potentiometer
* @comname Slide Potentiometer
* @type ainput
* @man seeed
* @con analog
@ -47,7 +47,7 @@ namespace upm {
* Basic UPM module for the Grove slide potentiometer on analog that
* returns either a raw value or a scaled voltage value.
*
* @image html groveslide.jpeg
* @image html slide.jpg
* @snippet groveslide.cxx Interesting
*/
class GroveSlide: public Grove {

View File

@ -35,7 +35,7 @@ namespace upm {
/**
* @library grove
* @sensor grovetemp
* @comname Grove Temperature Sensor
* @comname Temperature Sensor
* @type temp
* @man seeed
* @con analog