mirror of
https://github.com/eclipse/upm.git
synced 2025-07-05 19:31:15 +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 @@
|
||||
upm_mixed_module_init (NAME gp2y0a
|
||||
DESCRIPTION "Analog Infrared (IR) based distance sensor"
|
||||
DESCRIPTION "Analog Infrared (IR) Based Distance Sensor"
|
||||
C_HDR gp2y0a.h
|
||||
C_SRC gp2y0a.c
|
||||
CPP_HDR gp2y0a.hpp
|
||||
|
@ -37,11 +37,12 @@ namespace upm {
|
||||
/**
|
||||
* @library gp2y0a
|
||||
* @sensor gp2y0a
|
||||
* @comname GP2Y0A IR Proximity Sensor
|
||||
* @comname Analog Infrared (IR) Based Distance Sensor
|
||||
* @altname Grove 80cm IR Proximity Sensor
|
||||
* @type light
|
||||
* @man seeed
|
||||
* @con analog
|
||||
* @web http://wiki.seeed.cc/Grove-80cm_Infrared_Proximity_Sensor/
|
||||
*
|
||||
* @brief API for the GP2Y0A family of IR Proximity Sensors
|
||||
*
|
||||
|
Reference in New Issue
Block a user