Mirrors_Framework/rt-thread
1
0
Fork 0
mirror of https://github.com/RT-Thread/rt-thread.git synced 2026-02-08 03:03:07 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

doxygen: fixed build warning for RT_CAN_FILTER_ITEM_INIT (#10758)
Some checks failed
RT-Thread BSP Static Build Check / 🔍 Summary of Git Diff Changes (push) Has been cancelled
Details
RT-Thread BSP Static Build Check / ${{ matrix.legs.RTT_BSP }} (push) Has been cancelled
Details
RT-Thread BSP Static Build Check / collect-artifacts (push) Has been cancelled
Details
doc_doxygen / doxygen_doc generate (push) Has been cancelled
Details
doc_doxygen / deploy (push) Has been cancelled
Details
pkgs_test / change (push) Has been cancelled
Details
utest_auto_run / A9 :components/dfs.cfg (push) Has been cancelled
Details
utest_auto_run / A9 :components/lwip.cfg (push) Has been cancelled
Details
utest_auto_run / A9 :components/netdev.cfg (push) Has been cancelled
Details
utest_auto_run / A9 :cpp11/cpp11.cfg (push) Has been cancelled
Details
utest_auto_run / AARCH64-rtsmart :default.cfg (push) Has been cancelled
Details
utest_auto_run / A9-rtsmart :default.cfg (push) Has been cancelled
Details
utest_auto_run / RISCV-rtsmart :default.cfg (push) Has been cancelled
Details
utest_auto_run / XUANTIE-rtsmart :default.cfg (push) Has been cancelled
Details
utest_auto_run / AARCH64 :default.cfg (push) Has been cancelled
Details
utest_auto_run / A9 :default.cfg (push) Has been cancelled
Details
utest_auto_run / A9-smp :default.cfg (push) Has been cancelled
Details
utest_auto_run / RISCV :default.cfg (push) Has been cancelled
Details
utest_auto_run / A9 :kernel/atomic_c11.cfg (push) Has been cancelled
Details
utest_auto_run / RISCV :kernel/atomic_c11.cfg (push) Has been cancelled
Details
utest_auto_run / A9 :kernel/ipc.cfg (push) Has been cancelled
Details
utest_auto_run / A9 :kernel/kernel_basic.cfg (push) Has been cancelled
Details
utest_auto_run / A9 :kernel/mem.cfg (push) Has been cancelled
Details

Browse Source 
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 <unicorn_wang@outlook.com>
This commit is contained in:
Chen Wang
2025-09-28 19:47:45 +08:00
committed by GitHub
parent 98340c1aab
commit ace7fdbff3
1 changed files with 18 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
components/drivers/include/drivers/dev_can.h
View File

@@ -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) \