Skip to content

Commit 05dc189

Browse files
unicornxRbb666
authored andcommitted
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>
1 parent ace7fdb commit 05dc189

File tree

3 files changed

+6
-16
lines changed

3 files changed

+6
-16
lines changed

include/rtdef.h

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -267,10 +267,9 @@ typedef int (*init_fn_t)(void);
267267

268268
/**
269269
* @addtogroup group_object_management
270+
* @{
270271
*/
271272

272-
/**@{*/
273-
274273
/*
275274
* kernel object macros
276275
*/
@@ -512,7 +511,7 @@ struct rt_object_information
512511
#define RT_OBJECT_HOOKLIST_CALL(name, argv)
513512
#endif /* RT_USING_HOOKLIST */
514513

515-
/**@}*/
514+
/** @} group_object_management */
516515

517516
/**
518517
* @addtogroup group_clock_management

include/rtthread.h

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,6 @@ extern "C" {
4949
int entry(void);
5050
#endif
5151

52-
/**
53-
* @addtogroup group_object_management
54-
* @{
55-
*/
56-
5752
/*
5853
* kernel object interface
5954
*/
@@ -87,8 +82,6 @@ void rt_object_take_sethook(void (*hook)(struct rt_object *object));
8782
void rt_object_put_sethook(void (*hook)(struct rt_object *object));
8883
#endif /* RT_USING_HOOK */
8984

90-
/**@}*/
91-
9285
/**
9386
* @addtogroup group_clock_management
9487
* @{

src/object.c

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -157,10 +157,9 @@ void (*rt_object_put_hook)(struct rt_object *object);
157157

158158
/**
159159
* @addtogroup group_hook
160+
* @{
160161
*/
161162

162-
/**@{*/
163-
164163
/**
165164
* @brief This function will set a hook function, which will be invoked when object
166165
* attaches to kernel object system.
@@ -231,15 +230,14 @@ void rt_object_put_sethook(void (*hook)(struct rt_object *object))
231230
rt_object_put_hook = hook;
232231
}
233232

234-
/**@}*/
233+
/** @} group_hook */
235234
#endif /* RT_USING_HOOK */
236235

237236
/**
238237
* @addtogroup group_object_management
238+
* @{
239239
*/
240240

241-
/**@{*/
242-
243241
/**
244242
* @brief This function will return the specified type of object information.
245243
*
@@ -814,5 +812,5 @@ rt_err_t rt_custom_object_destroy(rt_object_t obj)
814812
}
815813
#endif
816814

817-
/**@}*/
815+
/** @} group_object_management */
818816

0 commit comments

Comments
 (0)