kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-25 14:33:52 +01:00
Code Releases Activity

drivers/sht1x: fix doccheck

Browse Source 
- replace auto-generated patterns with generic ones
- fix `warning: return value '\-EBADMSG' of sht1x_read has multiple
  documentation sections`
This commit is contained in:
Marian Buschsieweke 2022-09-16 08:34:51 +02:00
parent 31b40a863b
commit 702c36c533
No known key found for this signature in database
GPG Key ID: CB8E3238CE715A94
3 changed files with 4 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
dist/tools/doccheck/exclude_patterns vendored
View File

@ -8119,7 +8119,6 @@ drivers/include/pn532\.h:[0-9]+: warning: Member PN532_FW_FEATURES\(fwver\) \(ma
drivers/include/pn532\.h:[0-9]+: warning: Member PN532_FW_REVISION\(fwver\) \(macro definition\) of group drivers_pn532 is not documented\.
drivers/include/pn532\.h:[0-9]+: warning: Member PN532_FW_VERSION\(fwver\) \(macro definition\) of group drivers_pn532 is not documented\.
drivers/include/pn532\.h:[0-9]+: warning: Member PN532_IC_VERSION\(fwver\) \(macro definition\) of group drivers_pn532 is not documented\.
drivers/include/sht1x\.h:[0-9]+: warning: return value '\-EBADMSG' of sht1x_read has multiple documentation sections
drivers/include/sht2x\.h:[0-9]+: warning: Member SHT2X_USER_EOB_MASK \(macro definition\) of group drivers_sht2x is not documented\.
drivers/include/sht2x\.h:[0-9]+: warning: Member SHT2X_USER_HEATER_MASK \(macro definition\) of group drivers_sht2x is not documented\.
drivers/include/sht2x\.h:[0-9]+: warning: Member SHT2X_USER_OTP_MASK \(macro definition\) of group drivers_sht2x is not documented\.
@ -10029,11 +10028,6 @@ drivers/seesaw_soil/include/seesaw_soil_regs\.h:[0-9]+: warning: Member SEESAW_S
drivers/sgp30/include/sgp30_params\.h:[0-9]+: warning: Member SGP30_PARAMS \(macro definition\) of file sgp30_params\.h is not documented\.
drivers/sgp30/include/sgp30_params\.h:[0-9]+: warning: Member SGP30_PARAM_I2C_DEV \(macro definition\) of file sgp30_params\.h is not documented\.
drivers/sgp30/include/sgp30_params\.h:[0-9]+: warning: Member SGP30_SAUL_INFO \(macro definition\) of file sgp30_params\.h is not documented\.
drivers/sht1x/include/sht1x_params\.h:[0-9]+: warning: Member SHT1X_PARAMS \(macro definition\) of file sht1x_params\.h is not documented\.
drivers/sht1x/include/sht1x_params\.h:[0-9]+: warning: Member SHT1X_PARAM_CLK \(macro definition\) of file sht1x_params\.h is not documented\.
drivers/sht1x/include/sht1x_params\.h:[0-9]+: warning: Member SHT1X_PARAM_DATA \(macro definition\) of file sht1x_params\.h is not documented\.
drivers/sht1x/include/sht1x_params\.h:[0-9]+: warning: Member SHT1X_PARAM_VDD \(macro definition\) of file sht1x_params\.h is not documented\.
drivers/sht1x/include/sht1x_params\.h:[0-9]+: warning: Member SHT1X_SAULINFO \(macro definition\) of file sht1x_params\.h is not documented\.
drivers/sht2x/include/sht2x_params\.h:[0-9]+: warning: Member SHT2X_PARAMS_DEFAULT \(macro definition\) of file sht2x_params\.h is not documented\.
drivers/sht2x/include/sht2x_params\.h:[0-9]+: warning: Member SHT2X_PARAM_CRC_MODE \(macro definition\) of file sht2x_params\.h is not documented\.
drivers/sht2x/include/sht2x_params\.h:[0-9]+: warning: Member SHT2X_PARAM_I2C_ADDR \(macro definition\) of file sht2x_params\.h is not documented\.

3
dist/tools/doccheck/generic_exclude_patterns vendored
View File

@ -17,3 +17,6 @@ warning: Member LED[0-9]_PIN_NUM \(macro definition\) of
warning: Member LED[0-9]_PORT \(macro definition\) of
warning: Member LED[0-9]_PORT_NUM \(macro definition\) of
warning: Member LED[0-9]_TOGGLE \(macro definition\) of
warning: Member SHT1X_PARAMS \(macro definition\) of
warning: Member SHT1X_PARAM_[A-Z0-9_]* \(macro definition\) of
warning: Member SHT1X_SAULINFO \(macro definition\) of

3
drivers/include/sht1x.h
View File

@ -125,9 +125,8 @@ int16_t sht1x_humidity(const sht1x_dev_t *dev, uint16_t raw, int16_t temp);
*
* @retval 0 Success
* @retval -EIO IO failure (`gpio_init()` failed)
* @retval -EBADMSG CRC-8 checksum didn't match (--> Retry)
* @retval -EBADMSG CRC-8 checksum didn't match
* @retval -EINVAL Passed `NULL` for dev or for both `temp` and `hum`
* @retval -EBADMSG CRC checksum didn't match
* @retval -ECANCELED Measurement timed out
* @retval -EPROTO Sensor did not acknowledge command
*