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/fxos8700: Add missing doc and fix doccheck

Browse Source 
This commits add documentation to the FXOS8700 params and adds generic
exclude patters to the doc check, so that when boards provide custom
FXOS8700 params they do not need to document them again. The reasoning
is that the documentation in the central place is sufficient.

In addition, a generic exclude patter is added to match FXOS8700_REG_*,
as the register names are relatively self-explaining and an
implementation detail of the driver that doesn't need public
documentation.
This commit is contained in:
Marian Buschsieweke 2023-01-04 21:29:09 +01:00
parent 479d5a311c
commit efbf6efdd3
No known key found for this signature in database
GPG Key ID: CB8E3238CE715A94
3 changed files with 30 additions and 152 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

147
dist/tools/doccheck/exclude_patterns vendored
View File

@ -1371,8 +1371,6 @@ boards/firefly/include/board\.h:[0-9]+: warning: Member CC1200_SCLK_GPIO \(macro
boards/firefly/include/board\.h:[0-9]+: warning: Member CC1200_SPI_DEV \(macro definition\) of file board\.h is not documented\.
boards/firefly/include/periph_conf\.h:[0-9]+: warning: Member SPI_NUMOF \(macro definition\) of file periph_conf\.h is not documented\.
boards/firefly/include/periph_conf\.h:[0-9]+: warning: Member spi_config\[\] \(variable\) of file periph_conf\.h is not documented\.
boards/frdm\-k22f/include/board\.h:[0-9]+: warning: Member FXOS8700_PARAM_ADDR \(macro definition\) of file board\.h is not documented\.
boards/frdm\-k22f/include/board\.h:[0-9]+: warning: Member FXOS8700_PARAM_I2C \(macro definition\) of file board\.h is not documented\.
boards/frdm\-k22f/include/periph_conf\.h:[0-9]+: warning: Member ADC_NUMOF \(macro definition\) of file periph_conf\.h is not documented\.
boards/frdm\-k22f/include/periph_conf\.h:[0-9]+: warning: Member ADC_REF_SETTING \(macro definition\) of file periph_conf\.h is not documented\.
boards/frdm\-k22f/include/periph_conf\.h:[0-9]+: warning: Member CLOCK_BUSCLOCK \(macro definition\) of file periph_conf\.h is not documented\.
@ -1401,8 +1399,6 @@ boards/frdm\-k22f/include/periph_conf\.h:[0-9]+: warning: Member pwm_config\[\]
boards/frdm\-k22f/include/periph_conf\.h:[0-9]+: warning: Member spi_clk_config\[\] \(variable\) of file periph_conf\.h is not documented\.
boards/frdm\-k22f/include/periph_conf\.h:[0-9]+: warning: Member spi_config\[\] \(variable\) of file periph_conf\.h is not documented\.
boards/frdm\-k22f/include/periph_conf\.h:[0-9]+: warning: Member uart_config\[\] \(variable\) of file periph_conf\.h is not documented\.
boards/frdm\-k64f/include/board\.h:[0-9]+: warning: Member FXOS8700_PARAM_ADDR \(macro definition\) of file board\.h is not documented\.
boards/frdm\-k64f/include/board\.h:[0-9]+: warning: Member FXOS8700_PARAM_I2C \(macro definition\) of file board\.h is not documented\.
boards/frdm\-k64f/include/periph_conf\.h:[0-9]+: warning: Member ADC_NUMOF \(macro definition\) of file periph_conf\.h is not documented\.
boards/frdm\-k64f/include/periph_conf\.h:[0-9]+: warning: Member ADC_REF_SETTING \(macro definition\) of file periph_conf\.h is not documented\.
boards/frdm\-k64f/include/periph_conf\.h:[0-9]+: warning: Member CLOCK_BUSCLOCK \(macro definition\) of file periph_conf\.h is not documented\.
@ -1462,16 +1458,11 @@ boards/frdm\-kw41z/include/board\.h:[0-9]+: warning: Member CONFIG_ZTIMER_USEC_D
boards/frdm\-kw41z/include/board\.h:[0-9]+: warning: Member CONFIG_ZTIMER_USEC_TYPE \(macro definition\) of file board\.h is not documented\.
boards/frdm\-kw41z/include/board\.h:[0-9]+: warning: Member FRDM_NOR_SPI_CLK \(macro definition\) of file board\.h is not documented\.
boards/frdm\-kw41z/include/board\.h:[0-9]+: warning: Member FRDM_NOR_SPI_DEV \(macro definition\) of file board\.h is not documented\.
boards/frdm\-kw41z/include/board\.h:[0-9]+: warning: Member FXOS8700_PARAM_ADDR \(macro definition\) of file board\.h is not documented\.
boards/frdm\-kw41z/include/board\.h:[0-9]+: warning: Member FXOS8700_PARAM_I2C \(macro definition\) of file board\.h is not documented\.
boards/frdm\-kw41z/include/periph_conf\.h:[0-9]+: warning: Member ADC_NUMOF \(macro definition\) of file periph_conf\.h is not documented\.
boards/frdm\-kw41z/include/periph_conf\.h:[0-9]+: warning: Member ADC_REF_SETTING \(macro definition\) of file periph_conf\.h is not documented\.
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 FXOS8700_PARAM_ADDR \(macro definition\) of group boards_hamilton is not documented\.
boards/hamilton/include/board\.h:[0-9]+: warning: Member FXOS8700_PARAM_I2C \(macro definition\) of group boards_hamilton is not documented\.
boards/hamilton/include/board\.h:[0-9]+: warning: Member FXOS8700_PARAM_RENEW_INTERVAL \(macro definition\) of group boards_hamilton 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\.
@ -7371,144 +7362,6 @@ drivers/feetech/include/feetech_protocol\.h:[0-9]+: warning: Member scs15_regist
drivers/feetech/include/feetech_protocol\.h:[0-9]+: warning: Member scs15_register8_t \(enumeration\) of file feetech_protocol\.h is not documented\.
drivers/feetech/include/feetech_reader\.h:[0-9]+: warning: Member FEETECH_ACK_SIZE \(macro definition\) of file feetech_reader\.h is not documented\.
drivers/feetech/include/feetech_reader\.h:[0-9]+: warning: Member FEETECH_RESPONSE_SIZE\(len\) \(macro definition\) of file feetech_reader\.h is not documented\.
drivers/fxos8700/include/fxos8700_params\.h:[0-9]+: warning: Member FXOS8700_PARAMS \(macro definition\) of file fxos8700_params\.h is not documented\.
drivers/fxos8700/include/fxos8700_params\.h:[0-9]+: warning: Member FXOS8700_PARAM_ACC_RANGE \(macro definition\) of file fxos8700_params\.h is not documented\.
drivers/fxos8700/include/fxos8700_params\.h:[0-9]+: warning: Member FXOS8700_PARAM_ADDR \(macro definition\) of file fxos8700_params\.h is not documented\.
drivers/fxos8700/include/fxos8700_params\.h:[0-9]+: warning: Member FXOS8700_PARAM_RENEW_INTERVAL \(macro definition\) of file fxos8700_params\.h is not documented\.
drivers/fxos8700/include/fxos8700_params\.h:[0-9]+: warning: Member FXOS8700_SAUL_INFO \(macro definition\) of file fxos8700_params\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_ASLP_COUNT \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_A_FFMT_CFG \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_A_FFMT_COUNT \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_A_FFMT_SRC \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_A_FFMT_THS \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_A_FFMT_THS_X_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_A_FFMT_THS_X_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_A_FFMT_THS_Y_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_A_FFMT_THS_Y_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_A_FFMT_THS_Z_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_A_FFMT_THS_Z_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_A_VECM_CFG \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_A_VECM_CNT \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_A_VECM_INITX_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_A_VECM_INITX_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_A_VECM_INITY_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_A_VECM_INITY_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_A_VECM_INITZ_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_A_VECM_INITZ_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_A_VECM_THS_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_A_VECM_THS_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_CMP_X_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_CMP_X_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_CMP_Y_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_CMP_Y_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_CMP_Z_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_CMP_Z_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_CTRL_REG1 \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_CTRL_REG1_MASK__ACTIVE \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_CTRL_REG1_MASK__ODR \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_CTRL_REG1_ODR__100HZ \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_CTRL_REG1_ODR__200HZ \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_CTRL_REG1_ODR__25HZ \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_CTRL_REG1_ODR__400HZ \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_CTRL_REG1_ODR__50HZ \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_CTRL_REG2 \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_CTRL_REG3 \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_CTRL_REG4 \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_CTRL_REG5 \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_F_SETUP \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_HP_FILTER_CUTOFF \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_INT_SOURCE \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_MAX_X_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_MAX_X_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_MAX_Y_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_MAX_Y_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_MAX_Z_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_MAX_Z_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_MIN_X_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_MIN_X_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_MIN_Y_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_MIN_Y_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_MIN_Z_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_MIN_Z_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_CTRL_REG1 \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_CTRL_REG1_HMS__ACC_ONLY \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_CTRL_REG1_HMS__HYBRID \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_CTRL_REG1_HMS__MAG_ONLY \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_CTRL_REG1_MASK__HMS \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_CTRL_REG2 \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_CTRL_REG2_MASK__HYB_AUTOINC_MODE \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_CTRL_REG3 \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_DR_STATUS \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_DR_STATUS_MASK__XYZ_READY \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_INT_SRC \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_OFF_X_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_OFF_X_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_OFF_Y_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_OFF_Y_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_OFF_Z_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_OFF_Z_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_OUT_X_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_OUT_X_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_OUT_Y_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_OUT_Y_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_OUT_Z_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_OUT_Z_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_THS_CFG \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_THS_COUNT \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_THS_SRC \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_THS_X_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_THS_X_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_THS_Y_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_THS_Y_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_THS_Z_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_THS_Z_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_VECM_CFG \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_VECM_CNT \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_VECM_INITX_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_VECM_INITX_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_VECM_INITY_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_VECM_INITY_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_VECM_INITZ_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_VECM_INITZ_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_VECM_THS_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_M_VECM_THS_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_OFF_X \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_OFF_Y \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_OFF_Z \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_OUT_X_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_OUT_X_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_OUT_Y_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_OUT_Y_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_OUT_Z_LSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_OUT_Z_MSB \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_PL_BF_ZCOMP \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_PL_CFG \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_PL_COUNT \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_PL_STATUS \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_PL_THS_REG \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_PULSE_CFG \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_PULSE_LTCY \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_PULSE_SRC \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_PULSE_THSX \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_PULSE_THSY \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_PULSE_THSZ \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_PULSE_TMLT \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_PULSE_WIND \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_STATUS \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_STATUS_MASK__XYZ_READY \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_SYSMOD \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_TEMP \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_TRANSIENT_CFG \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_TRANSIENT_COUNT \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_TRANSIENT_SRC \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_TRANSIENT_THS \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_TRIG_CFG \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_WHO_AM_I \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_XYZ_DATA_CFG \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_XYZ_DATA_CFG_FS__2G \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_XYZ_DATA_CFG_FS__4G \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_XYZ_DATA_CFG_FS__8G \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_REG_XYZ_DATA_CFG_MASK__FS \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/fxos8700/include/fxos8700_regs\.h:[0-9]+: warning: Member FXOS8700_WHO_AM_I_VAL \(macro definition\) of file fxos8700_regs\.h is not documented\.
drivers/hd44780/include/hd44780_internal\.h:[0-9]+: warning: Member HD44780_1LINE \(macro definition\) of file hd44780_internal\.h is not documented\.
drivers/hd44780/include/hd44780_internal\.h:[0-9]+: warning: Member HD44780_2LINE \(macro definition\) of file hd44780_internal\.h is not documented\.

5
dist/tools/doccheck/generic_exclude_patterns vendored
View File

@ -11,6 +11,11 @@ warning: Member BTN[0-9]_PIN \(macro definition\) of
warning: Member BTN[0-9]_PORT \(macro definition\) of
warning: Member BTN[0-9]_PRESSED \(macro definition\) of
warning: Member BTN[0-9]_RELEASED \(macro definition\) of
warning: Member FXOS8700_PARAM_ADDR \(macro definition\) of
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 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

30
drivers/fxos8700/include/fxos8700_params.h
View File

@ -28,33 +28,53 @@ extern "C" {
#endif
/**
* @brief Default configuration parameters for the FXOS8700 driver
*
* The valid address range is 0x1E - 0x1F depending on the configuration of the
* address pins SA0 and SA1.
*
* @name Default configuration parameters for the FXOS8700 driver
* @{
*/
#ifndef FXOS8700_PARAM_I2C
/**
* @brief The I2C bus the FXOS8700 is connected to
*/
#define FXOS8700_PARAM_I2C I2C_DEV(0)
#endif
#ifndef FXOS8700_PARAM_ADDR
/**
* @brief The I2C address of the FXOS8700
*
* The valid address range is 0x1E - 0x1F depending on the configuration of the
* address pins SA0 and SA1.
*/
#define FXOS8700_PARAM_ADDR 0x1E
#endif
#ifndef FXOS8700_PARAM_ACC_RANGE
/**
* @brief The accelerator full-scale range to configure the FXOS8700 with
*/
#define FXOS8700_PARAM_ACC_RANGE FXOS8700_REG_XYZ_DATA_CFG_FS__8G
#endif
#ifndef FXOS8700_PARAM_RENEW_INTERVAL
/**
* @brief The interval for cache renewal to configure the driver with
*/
#define FXOS8700_PARAM_RENEW_INTERVAL 1000000ul
#endif
#ifndef FXOS8700_PARAMS
/**
* @brief The parameters to initialize the FXOS8700 driver with
*/
#define FXOS8700_PARAMS { .i2c = FXOS8700_PARAM_I2C, \
.addr = FXOS8700_PARAM_ADDR, \
.acc_range = FXOS8700_PARAM_ACC_RANGE, \
.renew_interval = FXOS8700_PARAM_RENEW_INTERVAL }
#endif
#ifndef FXOS8700_SAUL_INFO
/**
* @brief The SAUL info to register the FXOS8700 driver instances with
*/
#define FXOS8700_SAUL_INFO { .name = "fxos8700" }
#endif
/**@}*/