From 05dc189e37de721e7355372e777b7a16771be0c5 Mon Sep 17 00:00:00 2001 From: Chen Wang Date: Sun, 28 Sep 2025 17:46:18 +0800 Subject: [PATCH] doxygen: cleanup code for group_object_management 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 --- include/rtdef.h | 5 ++--- include/rtthread.h | 7 ------- src/object.c | 10 ++++------ 3 files changed, 6 insertions(+), 16 deletions(-) diff --git a/include/rtdef.h b/include/rtdef.h index b47bf23ff9..a3d06dba8a 100644 --- a/include/rtdef.h +++ b/include/rtdef.h @@ -267,10 +267,9 @@ typedef int (*init_fn_t)(void); /** * @addtogroup group_object_management + * @{ */ -/**@{*/ - /* * kernel object macros */ @@ -512,7 +511,7 @@ struct rt_object_information #define RT_OBJECT_HOOKLIST_CALL(name, argv) #endif /* RT_USING_HOOKLIST */ -/**@}*/ +/** @} group_object_management */ /** * @addtogroup group_clock_management diff --git a/include/rtthread.h b/include/rtthread.h index 73b31cf1e8..ed6b84c655 100644 --- a/include/rtthread.h +++ b/include/rtthread.h @@ -49,11 +49,6 @@ extern "C" { int entry(void); #endif -/** - * @addtogroup group_object_management - * @{ - */ - /* * 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)); #endif /* RT_USING_HOOK */ -/**@}*/ - /** * @addtogroup group_clock_management * @{ diff --git a/src/object.c b/src/object.c index f924f37bc9..1d5a211208 100644 --- a/src/object.c +++ b/src/object.c @@ -157,10 +157,9 @@ void (*rt_object_put_hook)(struct rt_object *object); /** * @addtogroup group_hook + * @{ */ -/**@{*/ - /** * @brief This function will set a hook function, which will be invoked when object * 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; } -/**@}*/ +/** @} group_hook */ #endif /* RT_USING_HOOK */ /** * @addtogroup group_object_management + * @{ */ -/**@{*/ - /** * @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 -/**@}*/ +/** @} group_object_management */