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 /src | |
| 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 'src')
| -rw-r--r-- | src/object.c | 10 |
1 files changed, 4 insertions, 6 deletions
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 */ |
