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]>

1 files changed, 6 insertions, 18 deletions

diff --git a/include/rtthread.h b/include/rtthread.h
index ed6b84c655..7f97c068cd 100644
--- a/include/rtthread.h
+++ b/include/rtthread.h
@@ -131,11 +131,6 @@ void rt_timer_exit_sethook(void (*hook)(struct rt_timer *timer));
 
 /**@}*/
 
-/**
- * @addtogroup group_thread_management
- * @{
- */
-
 /*
  * thread interface
  */
@@ -187,6 +182,8 @@ void rt_thread_suspend_sethook(void (*hook)(rt_thread_t thread));
 void rt_thread_resume_sethook (void (*hook)(rt_thread_t thread));
 
 /**
+ * @ingroup group_thread_management
+ *
  * @brief Sets a hook function when a thread is initialized.
  *
  * @param thread is the target thread that initializing
@@ -201,11 +198,12 @@ RT_OBJECT_HOOKLIST_DECLARE(rt_thread_inited_hookproto_t, rt_thread_inited);
  */
 void rt_thread_idle_init(void);
 #if defined(RT_USING_HOOK) || defined(RT_USING_IDLE_HOOK)
-// FIXME: Have to write doxygen comment here for rt_thread_idle_sethook/rt_thread_idle_delhook
+// FIXME: Have to write doxygen comment here for rt_thread_idle_sethook
 //        but not in src/idle.c. Because the `rt_align(RT_ALIGN_SIZE)` in src/idle.c
-//        will make wierd output for html document generation, i.e. can not generate
-//        function link to rt_thread_idle_sethook, while function link to rt_thread_idle_delhook is ok.
+//        will make doxygen building failed.
 /**
+ * @ingroup group_thread_management
+ *
  * @brief This function sets a hook function to idle thread loop. When the system performs
  *        idle loop, this hook function should be invoked.
  *
@@ -217,14 +215,6 @@ void rt_thread_idle_init(void);
  * @note the hook function must be simple and never be blocked or suspend.
  */
 rt_err_t rt_thread_idle_sethook(void (*hook)(void));
-/**
- * @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));
 #endif /* defined(RT_USING_HOOK) || defined(RT_USING_IDLE_HOOK) */
 rt_thread_t rt_thread_idle_gethandler(void);
@@ -265,8 +255,6 @@ void rt_secondary_cpu_entry(void);
 void rt_scheduler_ipi_handler(int vector, void *param);
 #endif /* RT_USING_SMP */
 
-/**@}*/
-
 /**
  * @addtogroup group_signal
  * @{