alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-02 01:41:12 +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/ultrasonic/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "ultrasonic")
set (libdescription "Grove ultrasonic proximity sensor")
set (libdescription "Ultrasonic Proximity Sensor")
set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp)
upm_module_init(mraa)

3
src/ultrasonic/ultrasonic.hpp
View File

@ -44,9 +44,10 @@ namespace upm {
/**
* @library ultrasonic
* @sensor ultrasonic
* @comname Grove Ultrasonic Ranger
* @comname Ultrasonic Proximity Sensor
* @type sound
* @man seeed
* @web http://wiki.seeed.cc/Grove-Ultrasonic_Ranger/
* @con gpio
*
* @brief API for Grove Ultrasonic Ranger