diff options
| author | Chen Wang <[email protected]> | 2025-09-28 17:46:18 +0800 |
|---|---|---|
| committer | R b b666 <[email protected]> | 2025-09-29 14:22:40 +0800 |
| commit | 05dc189e37de721e7355372e777b7a16771be0c5 (patch) | |
| tree | a52b4b3adc7d88c782a261374f0d0de4d70d75d4 /include | |
| parent | ace7fdbff3a120599f4d250399bc45777f4e1c52 (diff) | |
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 <[email protected]>
Diffstat (limited to 'include')
| -rw-r--r-- | include/rtdef.h | 5 | ||||
| -rw-r--r-- | include/rtthread.h | 7 |
2 files changed, 2 insertions, 10 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 * @{ |