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/hm11/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "hm11")
set (libdescription "Grove hm11 bluetooth low energy module")
set (libdescription "Bluetooth Low Energy Module")
set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp)
upm_module_init(mraa)

4
src/hm11/hm11.hpp
View File

@ -55,13 +55,13 @@ namespace upm {
/**
* @library hm11
* @sensor hm11
* @comname HM-11 Bluetooth Low Energy
* @comname Bluetooth Low Energy Module
* @altname Grove BLE
* @altid HM-10, HM-12
* @type wifi
* @man seeed
* @con uart
* @web http://www.seeedstudio.com/wiki/images/c/cd/Bluetooth4_en.pdf
* @web http://wiki.seeed.cc/Bluetooth_V4.0_HM_11_BLE_Module/
*
* @brief API for the HM-11 4.0 Bluetooth Low Energy Module
*