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

@ -1,5 +1,5 @@
set (libname "max5487")
set (libdescription "Digital potentiometer")
set (libdescription "Digital Potentiometer")
set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp)
upm_module_init(mraa)

3
src/max5487/max5487.hpp
View File

@ -42,10 +42,11 @@ namespace upm {
/**
* @library max5487
* @sensor max5487
* @comname MAX5487 Digital Potentiometer
* @comname Digital Potentiometer
* @type digipot
* @man maxim
* @con spi
* @web https://www.maximintegrated.com/en/products/analog/data-converters/digital-potentiometers/MAX5487.html
*
* @brief API for the MAX5487 SPI Digital Potentiometer
*