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 /src | |
| 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 'src')
| -rw-r--r-- | src/idle.c | 15 | ||||
| -rw-r--r-- | src/scheduler_mp.c | 2 | ||||
| -rw-r--r-- | src/scheduler_up.c | 2 | ||||
| -rw-r--r-- | src/signal.c | 2 | ||||
| -rw-r--r-- | src/thread.c | 5 |
5 files changed, 21 insertions, 5 deletions
diff --git a/src/idle.c b/src/idle.c index 62e3b57bab..9a04806199 100644 --- a/src/idle.c +++ b/src/idle.c @@ -79,6 +79,19 @@ rt_err_t rt_thread_idle_sethook(void (*hook)(void)) return ret; } +/** + * @addtogroup group_thread_management + * @{ + */ + +/** + * @brief delete the idle hook on hook list. + * + * @param hook the specified hook function. + * + * @return `RT_EOK`: delete OK. + * `-RT_ENOSYS`: hook was not found. + */ rt_err_t rt_thread_idle_delhook(void (*hook)(void)) { rt_size_t i; @@ -198,3 +211,5 @@ rt_thread_t rt_thread_idle_gethandler(void) return (rt_thread_t)(&idle_thread[id]); } + +/** @} group_thread_management */ diff --git a/src/scheduler_mp.c b/src/scheduler_mp.c index c0a546cf08..4bcbafad6d 100644 --- a/src/scheduler_mp.c +++ b/src/scheduler_mp.c @@ -1582,7 +1582,7 @@ rt_err_t rt_sched_thread_bind_cpu(struct rt_thread *thread, int cpu) } /** - * @} + * @} group_thread_management * * @endcond */ diff --git a/src/scheduler_up.c b/src/scheduler_up.c index 2970202dbf..4db27104cd 100644 --- a/src/scheduler_up.c +++ b/src/scheduler_up.c @@ -724,7 +724,7 @@ rt_err_t rt_sched_thread_bind_cpu(struct rt_thread *thread, int cpu) } /** - * @} + * @} group_thread_management * * @endcond */ diff --git a/src/signal.c b/src/signal.c index 125f388b38..ea3b283c8a 100644 --- a/src/signal.c +++ b/src/signal.c @@ -579,6 +579,8 @@ void rt_thread_free_sig(rt_thread_t tid) } /** + * @ingroup group_thread_management + * * @brief This function can be used to send any signal to any thread. * * @param tid is a pointer to the thread that receives the signal. diff --git a/src/thread.c b/src/thread.c index fcbf737091..481dfebeef 100644 --- a/src/thread.c +++ b/src/thread.c @@ -294,10 +294,9 @@ static rt_err_t _thread_init(struct rt_thread *thread, /** * @addtogroup group_thread_management + * @{ */ -/**@{*/ - /** * @brief This function will initialize a thread. It's used to initialize a * static thread object. @@ -1209,4 +1208,4 @@ rt_err_t rt_thread_get_name(rt_thread_t thread, char *name, rt_uint8_t name_size } RTM_EXPORT(rt_thread_get_name); -/**@}*/ +/** @} group_thread_management */ |
