mirror of
https://github.com/eclipse/upm.git
synced 2025-10-30 14:44:56 +03:00
doc: Scrubbed ALL sensor library descriptions
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:
@@ -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)
|
||||
|
||||
@@ -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:
|
||||
/**
|
||||
|
||||
Reference in New Issue
Block a user