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 "bmpx8x")
set (libdescription "Bosch BMP & GY65 atmospheric pressure sensor library")
set (libdescription "Bosch BMP & GY65 Atmospheric Pressure Sensor Library")
set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp)
upm_module_init(mraa interfaces)

View File

@ -77,6 +77,9 @@ namespace upm {
* @type pressure
* @man seeed adafruit sparkfun
* @con i2c
* @web https://www.sparkfun.com/datasheets/Components/General/BST-BMP085-DS000-05.pdf
* @web https://www.bosch-sensortec.com/bst/products/all_products/bmp180
* @web https://cdn-shop.adafruit.com/datasheets/1900_BMP183.pdf
*
* @brief API for the GY65/BMP085 and BMP180 Atmospheric Pressure Sensors
*