diff options
| author | Chen Wang <[email protected]> | 2025-09-29 16:43:04 +0800 |
|---|---|---|
| committer | R b b666 <[email protected]> | 2025-09-30 10:25:08 +0800 |
| commit | 3dd4f71bb6bd546757f591e1ed61e8b96ae95352 (patch) | |
| tree | 556e758667f8b4ebd615b7648903e1ff27437fc2 /include/rtdef.h | |
| parent | 05dc189e37de721e7355372e777b7a16771be0c5 (diff) | |
doxygen: cleanup code for group_thread_management
The cleanup involved three parts:
- Merging the standalone "/**@{*/" into
"@addtogroup group_thread_management"
- Changing "/**@}*/" to "/** @} group_thread_management */",
adding the group name makes it easier to find the matching "@{" part.
- Deleting the "@addtogroup" directive in "include/rtthread.h"
because this header file doesn't have doxygen comments.
All doxygen comments for function bodies are defined in other .c files.
Note, we remian two doxygen comments for rt_thread_inited_hookproto_t
and rt_thread_idle_sethook in the "include/rtthread.h".
rt_thread_inited_hookproto_t is really defined here.
For rt_thread_idle_sethook, please see FIXME comment for reason.
Signed-off-by: Chen Wang <[email protected]>
Diffstat (limited to 'include/rtdef.h')
| -rw-r--r-- | include/rtdef.h | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/include/rtdef.h b/include/rtdef.h index a3d06dba8a..a9a7bd0666 100644 --- a/include/rtdef.h +++ b/include/rtdef.h @@ -591,10 +591,9 @@ typedef void (*rt_sighandler_t)(int signo); /** * @addtogroup group_thread_management + * @{ */ -/**@{*/ - /* * Thread */ @@ -955,7 +954,7 @@ typedef struct rt_thread *rt_thread_t; #define LWP_IS_USER_MODE(t) (0) #endif /* RT_USING_SMART */ -/**@}*/ +/** @} group_thread_management */ /** * @addtogroup group_thread_comm |
