mirror of
https://github.com/eclipse/upm.git
synced 2025-07-02 01:41:12 +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 "hcsr04")
|
||||
set (libdescription "Proximity sensor")
|
||||
set (libdescription "Ultrasonic Distance Measuring Sensor")
|
||||
set (module_src ${libname}.cxx)
|
||||
set (module_hpp ${libname}.hpp)
|
||||
upm_module_init(mraa)
|
||||
|
@ -43,10 +43,11 @@ namespace upm {
|
||||
/**
|
||||
* @library hcsr04
|
||||
* @sensor hcsr04
|
||||
* @comname HC-SR04 Ultrasonic Sensor
|
||||
* @comname Ultrasonic Distance Measuring Sensor
|
||||
* @type sound
|
||||
* @man generic
|
||||
* @con gpio
|
||||
* @web https://www.sparkfun.com/products/13959
|
||||
*
|
||||
* @brief API for the HC-SR04 Ultrasonic Sensor
|
||||
*
|
||||
|
Reference in New Issue
Block a user