diff options
| author | Chen Wang <[email protected]> | 2025-06-24 16:11:28 +0800 |
|---|---|---|
| committer | Rbb666 <[email protected]> | 2025-06-25 14:02:28 +0800 |
| commit | 8e9872a55456b38d28b0d7d076905be84d0af7a2 (patch) | |
| tree | e424d87cf44e15581487affff7e5e4d081576921 /include | |
| parent | 29ab5334af46584604c4a758bfcaf456488863d3 (diff) | |
doxygen: group name all in lowcase
This patch only updated the groups defined in documentation/0.doxygen.
Other groups will be moved into documentation/0.doxygen and updated at
that time.
Signed-off-by: Chen Wang <[email protected]>
Diffstat (limited to 'include')
| -rw-r--r-- | include/rtdef.h | 22 | ||||
| -rw-r--r-- | include/rtservice.h | 2 | ||||
| -rw-r--r-- | include/rtthread.h | 14 |
3 files changed, 19 insertions, 19 deletions
diff --git a/include/rtdef.h b/include/rtdef.h index 068ee17a47..76f5f94bae 100644 --- a/include/rtdef.h +++ b/include/rtdef.h @@ -75,7 +75,7 @@ extern "C" { #endif /** - * @addtogroup group_BasicDef + * @addtogroup group_basic_definition */ /**@{*/ @@ -235,7 +235,7 @@ typedef int (*init_fn_t)(void); #endif /* RT_KERNEL_REALLOC */ /** - * @ingroup group_BasicDef + * @ingroup group_basic_definition * * @def RT_IS_ALIGN(addr, align) * Return true(1) or false(0). @@ -246,7 +246,7 @@ typedef int (*init_fn_t)(void); #define RT_IS_ALIGN(addr, align) ((!(addr & (align - 1))) && (addr != RT_NULL)) /** - * @ingroup group_BasicDef + * @ingroup group_basic_definition * * @def RT_ALIGN(size, align) * Return the most contiguous size aligned at specified width. RT_ALIGN(13, 4) @@ -256,7 +256,7 @@ typedef int (*init_fn_t)(void); #define RT_ALIGN(size, align) (((size) + (align) - 1) & ~((align) - 1)) /** - * @ingroup group_BasicDef + * @ingroup group_basic_definition * * @def RT_ALIGN_DOWN(size, align) * Return the down number of aligned at specified width. RT_ALIGN_DOWN(13, 4) @@ -266,7 +266,7 @@ typedef int (*init_fn_t)(void); #define RT_ALIGN_DOWN(size, align) ((size) & ~((align) - 1)) /** - * @addtogroup group_KernelObject + * @addtogroup group_kernel_object */ /**@{*/ @@ -515,7 +515,7 @@ struct rt_object_information /**@}*/ /** - * @addtogroup group_Clock + * @addtogroup group_clock_management */ /**@{*/ @@ -591,7 +591,7 @@ typedef void (*rt_sighandler_t)(int signo); /**@}*/ /** - * @addtogroup group_Thread + * @addtogroup group_thread_management */ /**@{*/ @@ -964,7 +964,7 @@ typedef struct rt_thread *rt_thread_t; /**@}*/ /** - * @addtogroup group_IPC + * @addtogroup group_thread_comm */ /**@{*/ @@ -972,8 +972,8 @@ typedef struct rt_thread *rt_thread_t; /** * IPC flags and control command definitions */ -#define RT_IPC_FLAG_FIFO 0x00 /**< FIFOed IPC. @ref group_IPC. */ -#define RT_IPC_FLAG_PRIO 0x01 /**< PRIOed IPC. @ref group_IPC. */ +#define RT_IPC_FLAG_FIFO 0x00 /**< FIFOed IPC. @ref group_thread_comm. */ +#define RT_IPC_FLAG_PRIO 0x01 /**< PRIOed IPC. @ref group_thread_comm. */ #define RT_IPC_CMD_UNKNOWN 0x00 /**< unknown IPC command */ #define RT_IPC_CMD_RESET 0x01 /**< reset IPC object */ @@ -1134,7 +1134,7 @@ typedef struct rt_messagequeue *rt_mq_t; /**@}*/ /** - * @addtogroup group_MM + * @addtogroup group_memory_management */ /**@{*/ diff --git a/include/rtservice.h b/include/rtservice.h index f9612e0b55..8622d867a1 100644 --- a/include/rtservice.h +++ b/include/rtservice.h @@ -24,7 +24,7 @@ extern "C" { #endif /** - * @addtogroup group_KernelService + * @addtogroup group_kernel_service */ /**@{*/ diff --git a/include/rtthread.h b/include/rtthread.h index aa7858d8cf..43a353834d 100644 --- a/include/rtthread.h +++ b/include/rtthread.h @@ -50,7 +50,7 @@ int entry(void); #endif /** - * @addtogroup group_KernelObject + * @addtogroup group_kernel_object * @{ */ @@ -90,7 +90,7 @@ void rt_object_put_sethook(void (*hook)(struct rt_object *object)); /**@}*/ /** - * @addtogroup group_Clock + * @addtogroup group_clock_management * @{ */ @@ -139,7 +139,7 @@ void rt_timer_exit_sethook(void (*hook)(struct rt_timer *timer)); /**@}*/ /** - * @addtogroup group_Thread + * @addtogroup group_thread_management * @{ */ @@ -262,7 +262,7 @@ int rt_system_signal_init(void); /**@}*/ /** - * @addtogroup group_MM + * @addtogroup group_memory_management * @{ */ @@ -318,7 +318,7 @@ void rt_page_free(void *addr, rt_size_t npages); #endif /* defined(RT_USING_SLAB) && defined(RT_USING_SLAB_AS_HEAP) */ /** - * @ingroup group_Hook + * @ingroup group_hook * @{ */ @@ -388,7 +388,7 @@ void rt_slab_free(rt_slab_t m, void *ptr); /**@}*/ /** - * @addtogroup group_IPC + * @addtogroup group_thread_comm * @{ */ @@ -762,7 +762,7 @@ void rt_components_board_init(void); #endif /* RT_USING_COMPONENTS_INIT */ /** - * @addtogroup group_KernelService + * @addtogroup group_kernel_service * @{ */ |
