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 <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
* @{
*/
/**@{*/
/*
* 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

View File

@@ -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
* @{

View File

@@ -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 */