alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-13 15:21:22 +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/ldt0028/CMakeLists.txt
View File

@ -1,5 +1,5 @@
upm_mixed_module_init (NAME ldt0028
DESCRIPTION "Piezo vibration sensor"
DESCRIPTION "Piezo Vibration Sensor"
C_HDR ldt0028.h
C_SRC ldt0028.c
CPP_HDR ldt0028.hpp

3
src/ldt0028/ldt0028.hpp
View File

@ -37,11 +37,12 @@ namespace upm {
/**
* @library ldt0028
* @sensor ldt0028
* @comname LDT0-028 Piezo Vibration Sensor
* @comname Piezo Vibration Sensor
* @altname Grove Piezo Vibration Sensor
* @type flexfor
* @man seeed
* @con analog
* @web http://wiki.seeed.cc/Grove-Piezo_Vibration_Sensor/
*
* @brief API for LDT0-028 PZT film-based sensors,
* such as a Grove Piezo Vibration sensor