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

@ -1,5 +1,5 @@
set (libname "apds9002")
set (libdescription "Apds9002 luminance module")
set (libdescription "Ambient Light Photo Sensor")
set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp)
upm_module_init(mraa)

13
src/apds9002/apds9002.hpp
View File

@ -26,22 +26,23 @@
#include <string>
#include <mraa/aio.h>
namespace upm {
namespace upm {
/**
* @brief APDS-9002 Luminance Sensor library
* @defgroup apds9002 libupm-apds9002
* @ingroup seeed analog light
*/
*/
/**
* @library apds9002
* @sensor apds9002
* @comname APDS-9002 Luminance Sensor
* @comname Ambient Light Photo Sensor
* @altname Grove Luminance Sensor
* @type light
* @man seeed
* @con analog
*
* @web https://www.seeedstudio.com/Grove-Luminance-Sensor-p-1941.html
*
* @brief UPM module for the APDS-9002 Luminance Sensor
*
* This sensor transforms luminous intensity to output analog values.
@ -50,7 +51,7 @@ namespace upm {
* @image html apds9002.jpg
* @snippet apds9002.cxx Interesting
*/
class APDS9002 {
public:
/**