mirror of
https://github.com/eclipse/upm.git
synced 2025-10-29 14:15:33 +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 "maxds3231m")
|
||||
set (libdescription "Realtime clock sensor from MAX family")
|
||||
set (libdescription "Realtime Clock (RTC) Sensor Library")
|
||||
set (module_src ${libname}.cxx)
|
||||
set (module_hpp ${libname}.hpp)
|
||||
upm_module_init(mraa)
|
||||
|
||||
@@ -70,10 +70,11 @@ struct Time3231 {
|
||||
/**
|
||||
* @library maxds3231m
|
||||
* @sensor maxds3231m
|
||||
* @comname MAXDS3231M Real-Time Clock
|
||||
* @comname Realtime Clock (RTC) Sensor Library
|
||||
* @type light
|
||||
* @man maxim
|
||||
* @con i2c
|
||||
* @web https://www.maximintegrated.com/en/products/digital/real-time-clocks/DS3231.html
|
||||
*
|
||||
* @brief API for the MAXDS3231M I2C Real-Time Clock
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user