From c40b79037ce8bb09ba95411ebee1b22631cf9027 Mon Sep 17 00:00:00 2001 From: Chen Wang Date: Sat, 15 Feb 2025 12:15:19 +0800 Subject: doxygen: add prefix for groups (#9991) * doxygen: add prefix for groups Add "group_" prefix to doxygen group names. This makes it easier to grep with group name later. This patch only modifies the groups defined in the pathes of INPUT of documentation/Doxyfile: INPUT = . \ ../src \ ../include \ ../components/finsh \ ../components/drivers/include/drivers \ ../components/drivers/clk \ ../components/dfs/dfs_v2/src \ ../components/dfs/dfs_v2/include Other groups are not touched. Signed-off-by: Chen Wang * ci: fixed error report when run file_check.py Such as: - "please delete extra space at the end of this line." - "the RT-Thread error code should return negative value. e.g. return -RT_ERROR" Signed-off-by: Chen Wang --------- Signed-off-by: Chen Wang --- include/rtdef.h | 36 ++++++++++++++++++------------------ include/rtservice.h | 2 +- include/rtthread.h | 28 ++++++++++++++-------------- 3 files changed, 33 insertions(+), 33 deletions(-) (limited to 'include') diff --git a/include/rtdef.h b/include/rtdef.h index 05c59f8908..b1f8e48c6f 100644 --- a/include/rtdef.h +++ b/include/rtdef.h @@ -75,7 +75,7 @@ extern "C" { #endif /** - * @addtogroup BasicDef + * @addtogroup group_BasicDef */ /**@{*/ @@ -235,7 +235,7 @@ typedef int (*init_fn_t)(void); #endif /* RT_KERNEL_REALLOC */ /** - * @ingroup BasicDef + * @ingroup group_BasicDef * * @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 BasicDef + * @ingroup group_BasicDef * * @def RT_ALIGN(size, align) * Return the most contiguous size aligned at specified width. RT_ALIGN(13, 4) @@ -255,7 +255,7 @@ typedef int (*init_fn_t)(void); #define RT_ALIGN(size, align) (((size) + (align) - 1) & ~((align) - 1)) /** - * @ingroup BasicDef + * @ingroup group_BasicDef * * @def RT_ALIGN_DOWN(size, align) * Return the down number of aligned at specified width. RT_ALIGN_DOWN(13, 4) @@ -264,7 +264,7 @@ typedef int (*init_fn_t)(void); #define RT_ALIGN_DOWN(size, align) ((size) & ~((align) - 1)) /** - * @addtogroup KernelObject + * @addtogroup group_KernelObject */ /**@{*/ @@ -513,7 +513,7 @@ struct rt_object_information /**@}*/ /** - * @addtogroup Clock + * @addtogroup group_Clock */ /**@{*/ @@ -576,7 +576,7 @@ typedef struct rt_timer *rt_timer_t; /**@}*/ /** - * @addtogroup Signal + * @addtogroup group_Signal */ /**@{*/ @@ -589,7 +589,7 @@ typedef void (*rt_sighandler_t)(int signo); /**@}*/ /** - * @addtogroup Thread + * @addtogroup group_Thread */ /**@{*/ @@ -961,7 +961,7 @@ typedef struct rt_thread *rt_thread_t; /**@}*/ /** - * @addtogroup IPC + * @addtogroup group_IPC */ /**@{*/ @@ -969,8 +969,8 @@ typedef struct rt_thread *rt_thread_t; /** * IPC flags and control command definitions */ -#define RT_IPC_FLAG_FIFO 0x00 /**< FIFOed IPC. @ref IPC. */ -#define RT_IPC_FLAG_PRIO 0x01 /**< PRIOed IPC. @ref IPC. */ +#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_CMD_UNKNOWN 0x00 /**< unknown IPC command */ #define RT_IPC_CMD_RESET 0x01 /**< reset IPC object */ @@ -991,7 +991,7 @@ struct rt_ipc_object }; /** - * @addtogroup semaphore + * @addtogroup group_semaphore Semaphore * @{ */ @@ -1013,7 +1013,7 @@ typedef struct rt_semaphore *rt_sem_t; /**@}*/ /** - * @addtogroup mutex + * @addtogroup group_mutex Mutex * @{ */ @@ -1040,7 +1040,7 @@ typedef struct rt_mutex *rt_mutex_t; /**@}*/ /** - * @addtogroup event + * @addtogroup group_event Event * @{ */ @@ -1068,7 +1068,7 @@ typedef struct rt_event *rt_event_t; /**@}*/ /** - * @addtogroup mailbox + * @addtogroup group_mailbox MailBox * @{ */ @@ -1097,7 +1097,7 @@ typedef struct rt_mailbox *rt_mailbox_t; /**@}*/ /** - * @addtogroup messagequeue + * @addtogroup group_messagequeue Message Queue * @{ */ @@ -1131,7 +1131,7 @@ typedef struct rt_messagequeue *rt_mq_t; /**@}*/ /** - * @addtogroup MM + * @addtogroup group_MM */ /**@{*/ @@ -1234,7 +1234,7 @@ typedef struct rt_mempool *rt_mp_t; #ifdef RT_USING_DEVICE /** - * @addtogroup Device + * @addtogroup group_Device */ /**@{*/ diff --git a/include/rtservice.h b/include/rtservice.h index a5b15ed1ce..3d99b46151 100644 --- a/include/rtservice.h +++ b/include/rtservice.h @@ -24,7 +24,7 @@ extern "C" { #endif /** - * @addtogroup KernelService + * @addtogroup group_KernelService */ /**@{*/ diff --git a/include/rtthread.h b/include/rtthread.h index 69dcdff8e0..e03a8d3935 100644 --- a/include/rtthread.h +++ b/include/rtthread.h @@ -50,7 +50,7 @@ int entry(void); #endif /** - * @addtogroup KernelObject + * @addtogroup group_KernelObject * @{ */ @@ -90,7 +90,7 @@ void rt_object_put_sethook(void (*hook)(struct rt_object *object)); /**@}*/ /** - * @addtogroup Clock + * @addtogroup group_Clock * @{ */ @@ -138,7 +138,7 @@ void rt_timer_exit_sethook(void (*hook)(struct rt_timer *timer)); /**@}*/ /** - * @addtogroup Thread + * @addtogroup group_Thread * @{ */ @@ -247,7 +247,7 @@ void rt_scheduler_ipi_handler(int vector, void *param); /**@}*/ /** - * @addtogroup Signal + * @addtogroup group_Signal * @{ */ #ifdef RT_USING_SIGNALS @@ -260,7 +260,7 @@ int rt_system_signal_init(void); /**@}*/ /** - * @addtogroup MM + * @addtogroup group_MM * @{ */ @@ -316,7 +316,7 @@ void rt_page_free(void *addr, rt_size_t npages); #endif /* defined(RT_USING_SLAB) && defined(RT_USING_SLAB_AS_HEAP) */ /** - * @ingroup Hook + * @ingroup group_Hook * @{ */ @@ -386,7 +386,7 @@ void rt_slab_free(rt_slab_t m, void *ptr); /**@}*/ /** - * @addtogroup IPC + * @addtogroup group_IPC * @{ */ @@ -411,7 +411,7 @@ rt_err_t rt_thread_suspend_to_list(rt_thread_t thread, rt_list_t *susp_list, int rt_err_t rt_susp_list_enqueue(rt_list_t *susp_list, rt_thread_t thread, int ipc_flags); /** - * @addtogroup semaphore + * @addtogroup group_semaphore Semaphore * @{ */ @@ -440,7 +440,7 @@ rt_err_t rt_sem_control(rt_sem_t sem, int cmd, void *arg); /**@}*/ /** - * @addtogroup mutex + * @addtogroup group_mutex Mutex * @{ */ @@ -479,7 +479,7 @@ rt_inline rt_ubase_t rt_mutex_get_hold(rt_mutex_t mutex) /**@}*/ /** - * @addtogroup event + * @addtogroup group_event Event * @{ */ @@ -516,7 +516,7 @@ rt_err_t rt_event_control(rt_event_t event, int cmd, void *arg); /**@}*/ /** - * @addtogroup mailbox + * @addtogroup group_mailbox MailBox * @{ */ @@ -557,7 +557,7 @@ rt_err_t rt_mb_control(rt_mailbox_t mb, int cmd, void *arg); /**@}*/ /** - * @addtogroup messagequeue + * @addtogroup group_messagequeue Message Queue * @{ */ #ifdef RT_USING_MESSAGEQUEUE @@ -661,7 +661,7 @@ void rt_spin_unlock_irqrestore(struct rt_spinlock *lock, rt_base_t level); #ifdef RT_USING_DEVICE /** - * @addtogroup Device + * @addtogroup group_Device * @{ */ @@ -760,7 +760,7 @@ void rt_components_board_init(void); #endif /* RT_USING_COMPONENTS_INIT */ /** - * @addtogroup KernelService + * @addtogroup group_KernelService * @{ */ -- cgit v1.3.1