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

Browse Source 
This commits add documentation to the AT86RF2xx params and adds generic
exclude patters to the doc check, so that when boards provide custom
AT86RF2xx 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:20:00 +01:00
parent 404c8930da
commit 479d5a311c
No known key found for this signature in database
GPG Key ID: CB8E3238CE715A94
3 changed files with 32 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
dist/tools/doccheck/exclude_patterns vendored
View File

@ -720,10 +720,6 @@ boards/common/esp8266/include/board_common\.h:[0-9]+: warning: Member SPIFFS_HAL
boards/common/esp8266/include/board_common\.h:[0-9]+: warning: Member SPIFFS_READ_ONLY \(macro definition\) of file board_common\.h is not documented\.
boards/common/esp8266/include/board_common\.h:[0-9]+: warning: Member SPIFFS_SINGLETON \(macro definition\) of file board_common\.h is not documented\.
boards/common/esp8266/include/periph_conf_common\.h:[0-9]+: warning: Member BIT\(X\) \(macro definition\) of file periph_conf_common\.h is not documented\.
boards/common/iotlab/include/board_common\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_CS \(macro definition\) of group boards_common_iotlab is not documented\.
boards/common/iotlab/include/board_common\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_INT \(macro definition\) of group boards_common_iotlab is not documented\.
boards/common/iotlab/include/board_common\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_RESET \(macro definition\) of group boards_common_iotlab is not documented\.
boards/common/iotlab/include/board_common\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_SLEEP \(macro definition\) of group boards_common_iotlab is not documented\.
boards/common/iotlab/include/board_common\.h:[0-9]+: warning: Member CONFIG_ZTIMER_USEC_DEV \(macro definition\) of group boards_common_iotlab is not documented\.
boards/common/iotlab/include/board_common\.h:[0-9]+: warning: Member CONFIG_ZTIMER_USEC_MIN \(macro definition\) of group boards_common_iotlab is not documented\.
boards/common/iotlab/include/board_common\.h:[0-9]+: warning: Member CONFIG_ZTIMER_USEC_TYPE \(macro definition\) of group boards_common_iotlab is not documented\.
@ -1473,12 +1469,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 AT86RF2XX_PARAM_CS \(macro definition\) of group boards_hamilton is not documented\.
boards/hamilton/include/board\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_INT \(macro definition\) of group boards_hamilton is not documented\.
boards/hamilton/include/board\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_RESET \(macro definition\) of group boards_hamilton is not documented\.
boards/hamilton/include/board\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_SLEEP \(macro definition\) of group boards_hamilton is not documented\.
boards/hamilton/include/board\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_SPI \(macro definition\) of group boards_hamilton is not documented\.
boards/hamilton/include/board\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_SPI_CLK \(macro definition\) of group boards_hamilton 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\.
@ -1968,9 +1958,6 @@ boards/msbiot/include/periph_conf\.h:[0-9]+: warning: Member pwm_config\[\] \(va
boards/msbiot/include/periph_conf\.h:[0-9]+: warning: Member spi_config\[\] \(variable\) of file periph_conf\.h is not documented\.
boards/msbiot/include/periph_conf\.h:[0-9]+: warning: Member timer_config\[\] \(variable\) of file periph_conf\.h is not documented\.
boards/msbiot/include/periph_conf\.h:[0-9]+: warning: Member uart_config\[\] \(variable\) of file periph_conf\.h is not documented\.
boards/mulle/include/board\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_INT \(macro definition\) of file board\.h is not documented\.
boards/mulle/include/board\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_RESET \(macro definition\) of file board\.h is not documented\.
boards/mulle/include/board\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_SLEEP \(macro definition\) of file board\.h is not documented\.
boards/mulle/include/board\.h:[0-9]+: warning: Member LED0_BIT \(macro definition\) of file board\.h is not documented\.
boards/mulle/include/board\.h:[0-9]+: warning: Member LED1_BIT \(macro definition\) of file board\.h is not documented\.
boards/mulle/include/board\.h:[0-9]+: warning: Member LED2_BIT \(macro definition\) of file board\.h is not documented\.
@ -3450,10 +3437,6 @@ boards/saml21\-xpro/include/periph_conf\.h:[0-9]+: warning: Member sam_usbdev_co
boards/saml21\-xpro/include/periph_conf\.h:[0-9]+: warning: Member spi_config\[\] \(variable\) of file periph_conf\.h is not documented\.
boards/saml21\-xpro/include/periph_conf\.h:[0-9]+: warning: Member timer_config\[\] \(variable\) of file periph_conf\.h is not documented\.
boards/saml21\-xpro/include/periph_conf\.h:[0-9]+: warning: Member uart_config\[\] \(variable\) of file periph_conf\.h is not documented\.
boards/samr21\-xpro/include/board\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_CS \(macro definition\) of file board\.h is not documented\.
boards/samr21\-xpro/include/board\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_INT \(macro definition\) of file board\.h is not documented\.
boards/samr21\-xpro/include/board\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_RESET \(macro definition\) of file board\.h is not documented\.
boards/samr21\-xpro/include/board\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_SLEEP \(macro definition\) of file board\.h is not documented\.
boards/samr21\-xpro/include/board\.h:[0-9]+: warning: Member CONFIG_ZTIMER_USEC_DEV \(macro definition\) of file board\.h is not documented\.
boards/samr21\-xpro/include/board\.h:[0-9]+: warning: Member CONFIG_ZTIMER_USEC_MIN \(macro definition\) of file board\.h is not documented\.
boards/samr21\-xpro/include/board\.h:[0-9]+: warning: Member CONFIG_ZTIMER_USEC_TYPE \(macro definition\) of file board\.h is not documented\.
@ -3503,12 +3486,6 @@ boards/samr21\-xpro/include/periph_conf\.h:[0-9]+: warning: Member sam_usbdev_co
boards/samr21\-xpro/include/periph_conf\.h:[0-9]+: warning: Member spi_config\[\] \(variable\) of file periph_conf\.h is not documented\.
boards/samr21\-xpro/include/periph_conf\.h:[0-9]+: warning: Member timer_config\[\] \(variable\) of file periph_conf\.h is not documented\.
boards/samr21\-xpro/include/periph_conf\.h:[0-9]+: warning: Member uart_config\[\] \(variable\) of file periph_conf\.h is not documented\.
boards/samr30\-xpro/include/board\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_CS \(macro definition\) of group boards_samr30\-xpro is not documented\.
boards/samr30\-xpro/include/board\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_INT \(macro definition\) of group boards_samr30\-xpro is not documented\.
boards/samr30\-xpro/include/board\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_RESET \(macro definition\) of group boards_samr30\-xpro is not documented\.
boards/samr30\-xpro/include/board\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_SLEEP \(macro definition\) of group boards_samr30\-xpro is not documented\.
boards/samr30\-xpro/include/board\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_SPI \(macro definition\) of group boards_samr30\-xpro is not documented\.
boards/samr30\-xpro/include/board\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_SPI_CLK \(macro definition\) of group boards_samr30\-xpro is not documented\.
boards/samr30\-xpro/include/board\.h:[0-9]+: warning: Member LED_PORT \(macro definition\) of group boards_samr30\-xpro is not documented\.
boards/samr30\-xpro/include/board\.h:[0-9]+: warning: Member RFCTL1_PIN \(macro definition\) of group boards_samr30\-xpro is not documented\.
boards/samr30\-xpro/include/board\.h:[0-9]+: warning: Member RFCTL2_PIN \(macro definition\) of group boards_samr30\-xpro is not documented\.
@ -6505,13 +6482,6 @@ drivers/at86rf2xx/include/at86rf2xx_aes\.h:[0-9]+: warning: Member AT86RF2XX_REG
drivers/at86rf2xx/include/at86rf2xx_aes\.h:[0-9]+: warning: Member AT86RF2XX_REG__AES_KEY_END \(macro definition\) of file at86rf2xx_aes\.h is not documented\.
drivers/at86rf2xx/include/at86rf2xx_aes\.h:[0-9]+: warning: Member AT86RF2XX_REG__AES_KEY_START \(macro definition\) of file at86rf2xx_aes\.h is not documented\.
drivers/at86rf2xx/include/at86rf2xx_aes\.h:[0-9]+: warning: Member AT86RF2XX_REG__AES_STATUS \(macro definition\) of file at86rf2xx_aes\.h is not documented\.
drivers/at86rf2xx/include/at86rf2xx_params\.h:[0-9]+: warning: Member AT86RF2XX_PARAMS \(macro definition\) of file at86rf2xx_params\.h is not documented\.
drivers/at86rf2xx/include/at86rf2xx_params\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_CS \(macro definition\) of file at86rf2xx_params\.h is not documented\.
drivers/at86rf2xx/include/at86rf2xx_params\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_INT \(macro definition\) of file at86rf2xx_params\.h is not documented\.
drivers/at86rf2xx/include/at86rf2xx_params\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_RESET \(macro definition\) of file at86rf2xx_params\.h is not documented\.
drivers/at86rf2xx/include/at86rf2xx_params\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_SLEEP \(macro definition\) of file at86rf2xx_params\.h is not documented\.
drivers/at86rf2xx/include/at86rf2xx_params\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_SPI \(macro definition\) of file at86rf2xx_params\.h is not documented\.
drivers/at86rf2xx/include/at86rf2xx_params\.h:[0-9]+: warning: Member AT86RF2XX_PARAM_SPI_CLK \(macro definition\) of file at86rf2xx_params\.h is not documented\.
drivers/at86rf2xx/include/at86rf2xx_registers\.h:[0-9]+: warning: Member AT86RF212B_PARTNUM \(macro definition\) of file at86rf2xx_registers\.h is not documented\.
drivers/at86rf2xx/include/at86rf2xx_registers\.h:[0-9]+: warning: Member AT86RF231_PARTNUM \(macro definition\) of file at86rf2xx_registers\.h is not documented\.
drivers/at86rf2xx/include/at86rf2xx_registers\.h:[0-9]+: warning: Member AT86RF232_PARTNUM \(macro definition\) of file at86rf2xx_registers\.h is not documented\.

6
dist/tools/doccheck/generic_exclude_patterns vendored
View File

@ -1,3 +1,9 @@
warning: Member AT86RF2XX_PARAM_CS \(macro definition\) of
warning: Member AT86RF2XX_PARAM_INT \(macro definition\) of
warning: Member AT86RF2XX_PARAM_RESET \(macro definition\) of
warning: Member AT86RF2XX_PARAM_SLEEP \(macro definition\) of
warning: Member AT86RF2XX_PARAM_SPI \(macro definition\) of
warning: Member AT86RF2XX_PARAM_SPI_CLK \(macro definition\) of
warning: Member BTN[0-9]_INT_FLANK \(macro definition\) of
warning: Member BTN[0-9]_MASK \(macro definition\) of
warning: Member BTN[0-9]_MODE \(macro definition\) of

26
drivers/at86rf2xx/include/at86rf2xx_params.h
View File

@ -32,25 +32,51 @@ extern "C" {
* @{
*/
#ifndef AT86RF2XX_PARAM_SPI
/**
* @brief SPI bus the AT86RF2xx is connected to
*/
#define AT86RF2XX_PARAM_SPI (SPI_DEV(0))
#endif
#ifndef AT86RF2XX_PARAM_SPI_CLK
/**
* @brief Clock to drive the SPI bus when speaking with the AT86RF2xx
*/
#define AT86RF2XX_PARAM_SPI_CLK (SPI_CLK_5MHZ)
#endif
#ifndef AT86RF2XX_PARAM_CS
/**
* @brief GPIO pin the CS pin of the AT86RF2xx is connected to
*/
#define AT86RF2XX_PARAM_CS (GPIO_PIN(0, 0))
#endif
#ifndef AT86RF2XX_PARAM_INT
/**
* @brief GPIO pin the INT pin of the AT86RF2xx is connected to
*/
#define AT86RF2XX_PARAM_INT (GPIO_PIN(0, 1))
#endif
#ifndef AT86RF2XX_PARAM_SLEEP
/**
* @brief GPIO pin the SLEEP pin of the AT86RF2xx is connected to
*/
#define AT86RF2XX_PARAM_SLEEP (GPIO_PIN(0, 2))
#endif
#ifndef AT86RF2XX_PARAM_RESET
/**
* @brief GPIO pin the RESET pin of the AT86RF2xx is connected to
*/
#define AT86RF2XX_PARAM_RESET (GPIO_PIN(0, 3))
#endif
#ifndef AT86RF2XX_PARAMS
/**
* @brief Parameters to initialize the AT86RF2xx driver with
*/
#define AT86RF2XX_PARAMS { .spi = AT86RF2XX_PARAM_SPI, \
.spi_clk = AT86RF2XX_PARAM_SPI_CLK, \
.cs_pin = AT86RF2XX_PARAM_CS, \