Mirrors_Framework/rt-thread
1
0
Fork 0
mirror of https://github.com/RT-Thread/rt-thread.git synced 2026-09-21 10:36:04 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

doxygen: fix two issues when building with doxygen 1.9.8 (#10768)

Browse Source 
* doxygen: remove @return command if function return void

When doxygen is upgraded to v1.9.8 (on ubuntu 24.04), doxygen
reports: "doxygen error: found documented return type for xxx
that does not return anything" for those functions which return
void but declare "@return" in doxygen comment.

Solution: remove "@return" for those cases, and update
guide document for how to write doxgen comment for functions.

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>

* doxygen: fixed a minor typo for uart doc

This error is found when building with doxygen 1.9.8, but not
detecetd on 1.9.1.

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
This commit is contained in:
Chen Wang
2025-10-10 10:05:06 +08:00
committed by GitHub
parent 1aef0dba71
commit 273185b45a
4 changed files with 7 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
components/drivers/include/drivers/dev_can.h
-2
View File
@@ -709,8 +709,6 @@ rt_err_t rt_hw_can_register(struct rt_can_device *can,
*
* @param[in] can A pointer to the CAN device structure.
* @param[in] event The interrupt event mask, indicating the cause of the interrupt.
*
* @return void
*/
void rt_hw_can_isr(struct rt_can_device *can, int event);