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

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

5
dist/tools/doccheck/exclude_patterns vendored
View File

@ -1586,8 +1586,6 @@ boards/hamilton/include/board\.h:[0-9]+: warning: Member HDC1000_PARAM_ADDR \(ma
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 PIR_PARAM_ACTIVE_HIGH \(macro definition\) of group boards_hamilton is not documented\.
boards/hamilton/include/board\.h:[0-9]+: warning: Member PIR_PARAM_GPIO \(macro definition\) of group boards_hamilton is not documented\.
boards/hamilton/include/board\.h:[0-9]+: warning: Member PULSE_COUNTER_GPIO \(macro definition\) of group boards_hamilton is not documented\.
boards/hamilton/include/board\.h:[0-9]+: warning: Member PULSE_COUNTER_GPIO_FLANK \(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\.
@ -9827,9 +9825,6 @@ drivers/ph_oem/include/ph_oem_params\.h:[0-9]+: warning: Member PH_OEM_PARAM_INT
drivers/ph_oem/include/ph_oem_params\.h:[0-9]+: warning: Member PH_OEM_PARAM_INTERRUPT_OPTION \(macro definition\) of file ph_oem_params\.h is not documented\.
drivers/ph_oem/include/ph_oem_params\.h:[0-9]+: warning: Member PH_OEM_PARAM_INTERRUPT_PIN \(macro definition\) of file ph_oem_params\.h is not documented\.
drivers/ph_oem/include/ph_oem_params\.h:[0-9]+: warning: Member PH_OEM_SAUL_INFO \(macro definition\) of file ph_oem_params\.h is not documented\.
drivers/pir/include/pir_params\.h:[0-9]+: warning: Member PIR_PARAMS \(macro definition\) of file pir_params\.h is not documented\.
drivers/pir/include/pir_params\.h:[0-9]+: warning: Member PIR_PARAM_ACTIVE_HIGH \(macro definition\) of file pir_params\.h is not documented\.
drivers/pir/include/pir_params\.h:[0-9]+: warning: Member PIR_SAUL_INFO \(macro definition\) of file pir_params\.h is not documented\.
drivers/pulse_counter/include/pulse_counter_params\.h:[0-9]+: warning: Member PULSE_COUNTER_GPIO \(macro definition\) of file pulse_counter_params\.h is not documented\.
drivers/pulse_counter/include/pulse_counter_params\.h:[0-9]+: warning: Member PULSE_COUNTER_GPIO_FLANK \(macro definition\) of file pulse_counter_params\.h is not documented\.
drivers/pulse_counter/include/pulse_counter_params\.h:[0-9]+: warning: Member PULSE_COUNTER_PARAMS \(macro definition\) of file pulse_counter_params\.h is not documented\.

3
dist/tools/doccheck/generic_exclude_patterns vendored
View File

@ -17,6 +17,9 @@ 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 PIR_PARAM_ACTIVE_HIGH \(macro definition\) of
warning: Member PIR_PARAM_GPIO \(macro definition\) of
warning: Member PIR_SAUL_INFO \(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

17
drivers/pir/include/pir_params.h
View File

@ -28,22 +28,35 @@ extern "C" {
#endif
/**
* @brief Set default configuration parameters for the PIR driver
* @name default configuration parameters for the PIR driver
* @{
*/
#ifndef PIR_PARAM_GPIO
/**
* @brief GPIO pin the PIR is connected to
*/
#define PIR_PARAM_GPIO GPIO_PIN(0, 6)
#endif
#ifndef PIR_PARAM_ACTIVE_HIGH
/**
* @brief Signal polarity: 1 means high on active, 0 means low on active
*/
#define PIR_PARAM_ACTIVE_HIGH 1
#endif
#ifndef PIR_PARAMS
/**
* @brief The PIR configuration parameters
*/
#define PIR_PARAMS { .gpio = PIR_PARAM_GPIO, \
.active_high = PIR_PARAM_ACTIVE_HIGH }
#endif
#ifndef PIR_SAUL_INFO
#define PIR_SAUL_INFO { .name = "pir" }
/**
* @brief The SAUL information the PIR devices get registered with
*/
#define PIR_SAUL_INFO { .name = "PIR" }
#endif
/**@}*/