rt-thread/documentation/0.doxygen
Chen Wang 273185b45a
doxygen: fix two issues when building with doxygen 1.9.8 (#10768)
* 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>
2025-10-10 10:05:06 +08:00
..
components doxygen: group name all in lowcase (part 2) (#10530) 2025-07-22 13:59:25 +08:00
core doxygen: fixed duplicated comments for scheduler APIs 2025-09-09 18:20:41 +08:00
example doxygen: fix two issues when building with doxygen 1.9.8 (#10768) 2025-10-10 10:05:06 +08:00
images doxygen: create framework to unify markdown and source code part (#9946) 2025-01-26 11:44:39 +08:00
0.basicdef.h doxygen: group name all in lowcase 2025-06-25 14:02:28 +08:00
1.core.h doxygen: promote object management to a separate page 2025-07-22 18:07:17 +08:00
2.components.h doxygen: group name all in lowcase 2025-06-25 14:02:28 +08:00
3.hardware.h doxygen: re-org module groups (#10197) 2025-04-18 10:44:43 +08:00
4.doxygen.h doxygen: re-org module groups (#10197) 2025-04-18 10:44:43 +08:00