alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-11-04 09:05:34 +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/hka5/CMakeLists.txt
View File

@@ -1,5 +1,5 @@
upm_mixed_module_init (NAME hka5
DESCRIPTION "DFRobot laser particulate matter (PM) sensor"
DESCRIPTION "Laser Particulate Matter (PM) Sensor"
C_HDR hka5.h
C_SRC hka5.c
CPP_HDR hka5.hpp

3
src/hka5/hka5.hpp
View File

@@ -41,10 +41,11 @@ namespace upm {
/**
* @library hka5
* @sensor hka5
* @comname DFRobot Laser PM2.5 Sensor
* @comname Laser Particulate Matter (PM) Sensor
* @type gaseous
* @man dfrobot
* @con uart gpio
* @web https://www.dfrobot.com/wiki/index.php/DFRobot_LM35_Linear_Temperature_Sensor_(SKU:DFR0023)
*
* @brief API for theDFRobot Laser PM2.5 Sensor
*