RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

drivers/ccs811: small cleanups in documentation

Browse Source
This commit is contained in:
Gunar Schorcht 2021-12-04 13:42:44 +01:00
parent 27265095cd
commit 6bdc590516
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
drivers/include/ccs811.h
View File

@ -140,7 +140,7 @@ int ccs811_init (ccs811_t *dev, const ccs811_params_t *params);
*
* The function reads the IAQ sensor values (TVOC and eCO2) and/or the raw
* sensor data. For either \p iaq_tvoc2, \p iaq_eco2, \p raw_i, or \p raw_v
* also ```NULL``` can be passed, if their value are not of interest.
* also `NULL` can be passed, if their value are not of interest.
*
* @note
* - If the function is called and no new data are available, the function
@ -150,7 +150,7 @@ int ccs811_init (ccs811_t *dev, const ccs811_params_t *params);
* new data are available.
* - In #CCS811_MODE_250MS, only RAW data are available. In
* that case, the function fails with error_code #CCS811_ERROR_NO_IAQ_DATA
* if \p iaq_tvoc and \p iaq_eco2 parameters are not ```NULL```.
* if \p iaq_tvoc and \p iaq_eco2 parameters are not `NULL`.
*
* @param[in] dev Device descriptor of CCS811 device to read from
* @param[out] iaq_tvoc TVOC total volatile organic compound (0..1187 ppb)