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 "ds1307")
|
||||
set (libdescription "Real time clock (RTC) module")
|
||||
set (libdescription "Real Time Clock (RTC) Module")
|
||||
set (module_src ${libname}.cxx)
|
||||
set (module_hpp ${libname}.hpp)
|
||||
upm_module_init(mraa)
|
||||
|
@ -51,11 +51,12 @@ namespace upm {
|
||||
/**
|
||||
* @library ds1307
|
||||
* @sensor ds1307
|
||||
* @comname Grove RTC (Real-Time Clock)
|
||||
* @comname Real Time Clock (RTC) Module
|
||||
* @altname DS1307 RTC
|
||||
* @type time
|
||||
* @man seeed
|
||||
* @con i2c
|
||||
* @web https://www.maximintegrated.com/en/products/digital/real-time-clocks/DS1307.html
|
||||
*
|
||||
* @brief API for the DS1307 Real-Time CLock
|
||||
*
|
||||
|
Reference in New Issue
Block a user