alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-01 01:11:10 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: Scrubbed ALL sensor library descriptions

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

2
src/adxl345/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "adxl345")
set (libdescription "Digital Accelerometer")
set (libdescription "3-axis, +/- 2/4/8/16 g Digital Accelerometer")
set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp)
upm_module_init(mraa)

3
src/adxl345/adxl345.hpp
View File

@ -38,11 +38,12 @@ namespace upm {
/**
* @library adxl345
* @sensor adxl345
* @comname ADXL345 3-Axis Digital Accelerometer
* @comname 3-axis, +/- 2/4/8/16 g Digital Accelerometer
* @altname Grove 3-Axis Digital Accelerometer (16g)
* @type accelerometer
* @man seeed
* @con i2c
* @web http://www.analog.com/media/en/technical-documentation/data-sheets/ADXL345.pdf
*
* @brief API for the ADXL345 3-Axis Digital Accelerometer
*