From df402a8d5548beefba50f3cea962d7b7b659a2e8 Mon Sep 17 00:00:00 2001 From: Chen Wang Date: Sun, 28 Sep 2025 16:56:56 +0800 Subject: [PATCH] doxygen: fixed build warning for RT_CAN_FILTER_ITEM_INIT The names and number of macro parameters in doxygen comments must match the actual macro definition; otherwise, a warning will be generated. Our goal is to eliminate all warnings. Signed-off-by: Chen Wang --- components/drivers/include/drivers/dev_can.h | 26 ++++++++++++++------ 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/components/drivers/include/drivers/dev_can.h b/components/drivers/include/drivers/dev_can.h index 922ddcbb539..aa4878ee514 100644 --- a/components/drivers/include/drivers/dev_can.h +++ b/components/drivers/include/drivers/dev_can.h @@ -276,19 +276,19 @@ struct rt_can_filter_item #endif /*RT_CAN_USING_HDR*/ }; +#ifdef RT_CAN_USING_HDR /** * @def RT_CAN_FILTER_ITEM_INIT * @brief A helper macro to initialize a `rt_can_filter_item` structure for Mask Mode. * - * @param[in] _id The CAN ID for the filter. - * @param[in] _ide Identifier type (0 for Standard, 1 for Extended). - * @param[in] _rtr Frame type (0 for Data, 1 for Remote). - * @param[in] _mode Filter mode (0 for Mask, 1 for List). - * @param[in] _mask The mask to be applied. - * @param[in] _ind Optional callback function (can be RT_NULL). - * @param[in] _args Optional arguments for the callback (can be RT_NULL). + * @param[in] id The CAN ID for the filter. + * @param[in] ide Identifier type (0 for Standard, 1 for Extended). + * @param[in] rtr Frame type (0 for Data, 1 for Remote). + * @param[in] mode Filter mode (0 for Mask, 1 for List). + * @param[in] mask The mask to be applied. + * @param[in] ind Optional callback function (can be RT_NULL). + * @param[in] args Optional arguments for the callback (can be RT_NULL). */ -#ifdef RT_CAN_USING_HDR #define RT_CAN_FILTER_ITEM_INIT(id,ide,rtr,mode,mask,ind,args) \ {(id), (ide), (rtr), (mode),(mask), -1, CAN_RX_FIFO0,(ind), (args)} #define RT_CAN_FILTER_STD_INIT(id,ind,args) \ @@ -304,6 +304,16 @@ struct rt_can_filter_item #define RT_CAN_EXT_RMT_DATA_FILTER_INIT(id,ind,args) \ RT_CAN_FILTER_ITEM_INIT(id,1,0,1,0xFFFFFFFF,ind,args) #else +/** + * @def RT_CAN_FILTER_ITEM_INIT + * @brief A helper macro to initialize a `rt_can_filter_item` structure for Mask Mode. + * + * @param[in] id The CAN ID for the filter. + * @param[in] ide Identifier type (0 for Standard, 1 for Extended). + * @param[in] rtr Frame type (0 for Data, 1 for Remote). + * @param[in] mode Filter mode (0 for Mask, 1 for List). + * @param[in] mask The mask to be applied. + */ #define RT_CAN_FILTER_ITEM_INIT(id,ide,rtr,mode,mask) \ {(id), (ide), (rtr), (mode), (mask), -1, CAN_RX_FIFO0 } #define RT_CAN_FILTER_STD_INIT(id) \