RT-Thread/rt-thread
1
0
Fork 0
mirror of https://github.com/RT-Thread/rt-thread.git synced 2025-10-18 01:02:50 +08:00
Code Issues 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

12
documentation/0.doxygen/example/src/function.c
View File

@@ -33,10 +33,12 @@
*
* To documenting for functions, a comment block before the function
* declaraion/definition is recommended to describe the general information
* of the function. In the comment block, a `@brief` is required, a `@return`
* is also required no matter if the function return values or not. `@param` is
* required if any, and if it is provided, direction [in]/[out]/[in,out] should
* be provide together. Other commands (such as `@note`) are optional.
* of the function. In the comment block, a `@brief` is required. A `@return`
* is also required if the function is intended to return a value, otherwise
* if the function is implemented with a void return type, `@return` is not
* required. `@param` is required if any, and if it is provided,
* direction [in]/[out]/[in,out] should be provide together. Other commands
* (such as `@note`) are optional.
*
* If you feel that the description of `@brief` is not enough, you
* can add a detailed description part, which is also optional.
@@ -72,8 +74,6 @@
*
* @param[in] b Description of param b
*
* @return void
*
* @note This is a note for this structure, blah blah blah...
*/
void doxygen_example_func_foo(int a, int b)