kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2026-01-01 01:41:18 +01:00
Code Releases Activity

drivers/hdc1000: Add missing doc and fix doccheck

Browse Source 
This commits add documentation to the HDC1000 params and adds generic
exclude patters to the doc check, so that when boards provide custom
HDC1000 params they do not need to document them again. The reasoning
is that the documentation in the central place is sufficient.
This commit is contained in:
Marian Buschsieweke 2023-01-04 21:35:08 +01:00
parent efbf6efdd3
commit 5d93a485c5
No known key found for this signature in database
GPG Key ID: CB8E3238CE715A94
3 changed files with 27 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
dist/tools/doccheck/exclude_patterns vendored
View File

@ -1463,10 +1463,6 @@ boards/frdm\-kw41z/include/periph_conf\.h:[0-9]+: warning: Member ADC_REF_SETTIN
boards/frdm\-kw41z/include/periph_conf\.h:[0-9]+: warning: Member SPI_NUMOF \(macro definition\) of file periph_conf\.h is not documented\.
boards/frdm\-kw41z/include/periph_conf\.h:[0-9]+: warning: Member adc_config\[\] \(variable\) of file periph_conf\.h is not documented\.
boards/frdm\-kw41z/include/periph_conf\.h:[0-9]+: warning: Member spi_config\[\] \(variable\) of file periph_conf\.h is not documented\.
boards/hamilton/include/board\.h:[0-9]+: warning: Member HDC1000_PARAM_ADDR \(macro definition\) of group boards_hamilton is not documented\.
boards/hamilton/include/board\.h:[0-9]+: warning: Member HDC1000_PARAM_I2C \(macro definition\) of group boards_hamilton is not documented\.
boards/hamilton/include/board\.h:[0-9]+: warning: Member HDC1000_PARAM_RENEW_INTERVAL \(macro definition\) of group boards_hamilton is not documented\.
boards/hamilton/include/board\.h:[0-9]+: warning: Member HDC1000_PARAM_RES \(macro definition\) of group boards_hamilton is not documented\.
boards/hamilton/include/board\.h:[0-9]+: warning: Member TMP006_PARAM_ADDR \(macro definition\) of group boards_hamilton is not documented\.
boards/hamilton/include/board\.h:[0-9]+: warning: Member TMP006_PARAM_I2C \(macro definition\) of group boards_hamilton is not documented\.
boards/hamilton/include/board\.h:[0-9]+: warning: Member TMP006_PARAM_RATE \(macro definition\) of group boards_hamilton is not documented\.
@ -7404,12 +7400,6 @@ drivers/hd44780/include/hd44780_params\.h:[0-9]+: warning: Member HD44780_PARAM_
drivers/hd44780/include/hd44780_params\.h:[0-9]+: warning: Member HD44780_PARAM_PIN_RS \(macro definition\) of file hd44780_params\.h is not documented\.
drivers/hd44780/include/hd44780_params\.h:[0-9]+: warning: Member HD44780_PARAM_PIN_RW \(macro definition\) of file hd44780_params\.h is not documented\.
drivers/hd44780/include/hd44780_params\.h:[0-9]+: warning: Member HD44780_PARAM_ROWS \(macro definition\) of file hd44780_params\.h is not documented\.
drivers/hdc1000/include/hdc1000_params\.h:[0-9]+: warning: Member HDC1000_PARAMS \(macro definition\) of file hdc1000_params\.h is not documented\.
drivers/hdc1000/include/hdc1000_params\.h:[0-9]+: warning: Member HDC1000_PARAM_ADDR \(macro definition\) of file hdc1000_params\.h is not documented\.
drivers/hdc1000/include/hdc1000_params\.h:[0-9]+: warning: Member HDC1000_PARAM_I2C \(macro definition\) of file hdc1000_params\.h is not documented\.
drivers/hdc1000/include/hdc1000_params\.h:[0-9]+: warning: Member HDC1000_PARAM_RENEW_INTERVAL \(macro definition\) of file hdc1000_params\.h is not documented\.
drivers/hdc1000/include/hdc1000_params\.h:[0-9]+: warning: Member HDC1000_PARAM_RES \(macro definition\) of file hdc1000_params\.h is not documented\.
drivers/hdc1000/include/hdc1000_params\.h:[0-9]+: warning: Member HDC1000_SAUL_INFO \(macro definition\) of file hdc1000_params\.h is not documented\.
drivers/hdc1000/include/hdc1000_regs\.h:[0-9]+: warning: Member HDC1000_BTST_LOW \(macro definition\) of file hdc1000_regs\.h is not documented\.
drivers/hdc1000/include/hdc1000_regs\.h:[0-9]+: warning: Member HDC1000_CONFIG \(macro definition\) of file hdc1000_regs\.h is not documented\.
drivers/hdc1000/include/hdc1000_regs\.h:[0-9]+: warning: Member HDC1000_DEVICE_ID \(macro definition\) of file hdc1000_regs\.h is not documented\.

4
dist/tools/doccheck/generic_exclude_patterns vendored
View File

@ -16,6 +16,10 @@ warning: Member FXOS8700_PARAM_I2C \(macro definition\) of
warning: Member FXOS8700_PARAM_RENEW_INTERVAL \(macro definition\) of
warning: Member FXOS8700_REG_[A-Z0-9_]* \(macro definition\) of
warning: Member FXOS8700_SAUL_INFO \(macro definition\) of
warning: Member HDC1000_PARAM_ADDR \(macro definition\) of
warning: Member HDC1000_PARAM_I2C \(macro definition\) of
warning: Member HDC1000_PARAM_RENEW_INTERVAL \(macro definition\) of
warning: Member HDC1000_PARAM_RES \(macro definition\) of
warning: Member LED[0-9]_ENABLE_PORT \(macro definition\) of
warning: Member LED[0-9]_IS_INVERTED \(macro definition\) of
warning: Member LED[0-9]_MASK \(macro definition\) of

24
drivers/hdc1000/include/hdc1000_params.h
View File

@ -28,29 +28,51 @@ extern "C" {
#endif
/**
* @name Set default configuration parameters for the HDC1000 driver
* @name Default configuration parameters for the HDC1000 driver
* @{
*/
#ifndef HDC1000_PARAM_I2C
/**
* @brief I2C bus the HDC1000 is connected to
*/
#define HDC1000_PARAM_I2C I2C_DEV(0)
#endif
#ifndef HDC1000_PARAM_ADDR
/**
* @brief I2C address of the HDC1000
*/
#define HDC1000_PARAM_ADDR (CONFIG_HDC1000_I2C_ADDRESS)
#endif
#ifndef HDC1000_PARAM_RES
/**
* @brief Resolution to sample the humidity and temperature at
*/
#define HDC1000_PARAM_RES HDC1000_14BIT
#endif
#ifndef HDC1000_PARAM_RENEW_INTERVAL
/**
* @brief Interval at which the driver should renew the sensor data cache
*/
#define HDC1000_PARAM_RENEW_INTERVAL (1000000ul)
#endif
#ifndef HDC1000_PARAMS
/**
* @brief Parameters to initialize the HDC1000 driver with
*/
#define HDC1000_PARAMS { .i2c = HDC1000_PARAM_I2C, \
.addr = HDC1000_PARAM_ADDR, \
.res = HDC1000_PARAM_RES, \
.renew_interval = HDC1000_PARAM_RENEW_INTERVAL }
#endif
#ifndef HDC1000_SAUL_INFO
/**
* @brief SAUL info to register HDC1000 driver instances with
*/
#define HDC1000_SAUL_INFO { .name = "hdc1000" }
#endif
/**@}*/