doxygen: cleanup code for group_object_management
Some checks failed
RT-Thread BSP Static Build Check / 🔍 Summary of Git Diff Changes (push) Has been cancelled
RT-Thread BSP Static Build Check / ${{ matrix.legs.RTT_BSP }} (push) Has been cancelled
RT-Thread BSP Static Build Check / collect-artifacts (push) Has been cancelled
doc_doxygen / doxygen_doc generate (push) Has been cancelled
doc_doxygen / deploy (push) Has been cancelled
pkgs_test / change (push) Has been cancelled
utest_auto_run / A9 :components/dfs.cfg (push) Has been cancelled
utest_auto_run / A9 :components/lwip.cfg (push) Has been cancelled
utest_auto_run / A9 :components/netdev.cfg (push) Has been cancelled
utest_auto_run / A9 :cpp11/cpp11.cfg (push) Has been cancelled
utest_auto_run / AARCH64-rtsmart :default.cfg (push) Has been cancelled
utest_auto_run / A9-rtsmart :default.cfg (push) Has been cancelled
utest_auto_run / RISCV-rtsmart :default.cfg (push) Has been cancelled
utest_auto_run / XUANTIE-rtsmart :default.cfg (push) Has been cancelled
utest_auto_run / AARCH64 :default.cfg (push) Has been cancelled
utest_auto_run / A9 :default.cfg (push) Has been cancelled
utest_auto_run / A9-smp :default.cfg (push) Has been cancelled
utest_auto_run / RISCV :default.cfg (push) Has been cancelled
utest_auto_run / A9 :kernel/atomic_c11.cfg (push) Has been cancelled
utest_auto_run / RISCV :kernel/atomic_c11.cfg (push) Has been cancelled
utest_auto_run / A9 :kernel/ipc.cfg (push) Has been cancelled
utest_auto_run / A9 :kernel/kernel_basic.cfg (push) Has been cancelled
utest_auto_run / A9 :kernel/mem.cfg (push) Has been cancelled

The cleanup involved three parts:

- Merging the standalone "/**@{*/" into
  "@addtogroup group_object_management"

- Changing "/**@}*/" to "/** @} group_object_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 "src/object.c".

Plus minor cleanup for group_hook in src/object.c.

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
This commit is contained in:
Chen Wang
2025-09-28 17:46:18 +08:00
committed by R b b666
parent ace7fdbff3
commit 05dc189e37
3 changed files with 6 additions and 16 deletions

View File

@@ -267,10 +267,9 @@ typedef int (*init_fn_t)(void);
/** /**
* @addtogroup group_object_management * @addtogroup group_object_management
* @{
*/ */
/**@{*/
/* /*
* kernel object macros * kernel object macros
*/ */
@@ -512,7 +511,7 @@ struct rt_object_information
#define RT_OBJECT_HOOKLIST_CALL(name, argv) #define RT_OBJECT_HOOKLIST_CALL(name, argv)
#endif /* RT_USING_HOOKLIST */ #endif /* RT_USING_HOOKLIST */
/**@}*/ /** @} group_object_management */
/** /**
* @addtogroup group_clock_management * @addtogroup group_clock_management

View File

@@ -49,11 +49,6 @@ extern "C" {
int entry(void); int entry(void);
#endif #endif
/**
* @addtogroup group_object_management
* @{
*/
/* /*
* kernel object interface * kernel object interface
*/ */
@@ -87,8 +82,6 @@ void rt_object_take_sethook(void (*hook)(struct rt_object *object));
void rt_object_put_sethook(void (*hook)(struct rt_object *object)); void rt_object_put_sethook(void (*hook)(struct rt_object *object));
#endif /* RT_USING_HOOK */ #endif /* RT_USING_HOOK */
/**@}*/
/** /**
* @addtogroup group_clock_management * @addtogroup group_clock_management
* @{ * @{

View File

@@ -157,10 +157,9 @@ void (*rt_object_put_hook)(struct rt_object *object);
/** /**
* @addtogroup group_hook * @addtogroup group_hook
* @{
*/ */
/**@{*/
/** /**
* @brief This function will set a hook function, which will be invoked when object * @brief This function will set a hook function, which will be invoked when object
* attaches to kernel object system. * attaches to kernel object system.
@@ -231,15 +230,14 @@ void rt_object_put_sethook(void (*hook)(struct rt_object *object))
rt_object_put_hook = hook; rt_object_put_hook = hook;
} }
/**@}*/ /** @} group_hook */
#endif /* RT_USING_HOOK */ #endif /* RT_USING_HOOK */
/** /**
* @addtogroup group_object_management * @addtogroup group_object_management
* @{
*/ */
/**@{*/
/** /**
* @brief This function will return the specified type of object information. * @brief This function will return the specified type of object information.
* *
@@ -814,5 +812,5 @@ rt_err_t rt_custom_object_destroy(rt_object_t obj)
} }
#endif #endif
/**@}*/ /** @} group_object_management */