doxygen: add prefix for groups (#9991)
pkgs_test / change (push) Has been skipped
AutoTestCI / components/cpp11 (push) Has been cancelled
AutoTestCI / kernel/atomic (push) Has been cancelled
AutoTestCI / kernel/atomic/riscv64 (push) Has been cancelled
AutoTestCI / kernel/atomic_c11 (push) Has been cancelled
AutoTestCI / kernel/atomic_c11/riscv64 (push) Has been cancelled
AutoTestCI / kernel/device (push) Has been cancelled
AutoTestCI / kernel/ipc (push) Has been cancelled
AutoTestCI / kernel/irq (push) Has been cancelled
AutoTestCI / kernel/mem (push) Has been cancelled
AutoTestCI / kernel/mem/riscv64 (push) Has been cancelled
AutoTestCI / kernel/thread (push) Has been cancelled
AutoTestCI / kernel/timer (push) Has been cancelled
AutoTestCI / rtsmart/aarch64 (push) Has been cancelled
AutoTestCI / rtsmart/arm (push) Has been cancelled
AutoTestCI / rtsmart/riscv64 (push) Has been cancelled
AutoTestCI / components/utest (push) Has been cancelled
RT-Thread BSP Static Build Check / ESP32C3 (push) Has been cancelled
RT-Thread BSP Static Build Check / Infineon_TI_microchip (push) Has been cancelled
RT-Thread BSP Static Build Check / RT-Thread Online Packages (STM32F407 RT-Spark) (push) Has been cancelled
RT-Thread BSP Static Build Check / RTduino/Arduino Libraries (Raspberry Pico) (push) Has been cancelled
RT-Thread BSP Static Build Check / RTduino/Arduino Libraries (STM32F412 Nucleo) (push) Has been cancelled
RT-Thread BSP Static Build Check / aarch64 (push) Has been cancelled
RT-Thread BSP Static Build Check / gd32_n32_apm32 (push) Has been cancelled
RT-Thread BSP Static Build Check / hpmicro (push) Has been cancelled
RT-Thread BSP Static Build Check / i386-unknown (push) Has been cancelled
RT-Thread BSP Static Build Check / llvm-arm (push) Has been cancelled
RT-Thread BSP Static Build Check / mips (push) Has been cancelled
RT-Thread BSP Static Build Check / nordic(yml) (push) Has been cancelled
RT-Thread BSP Static Build Check / nuvoton (push) Has been cancelled
RT-Thread BSP Static Build Check / nxp_renesas (push) Has been cancelled
RT-Thread BSP Static Build Check / others_at32_hc32_ht32 (push) Has been cancelled
RT-Thread BSP Static Build Check / riscv-none (push) Has been cancelled
RT-Thread BSP Static Build Check / riscv64-unknown (push) Has been cancelled
RT-Thread BSP Static Build Check / simulator (push) Has been cancelled
RT-Thread BSP Static Build Check / stm32_f2_f4 (push) Has been cancelled
RT-Thread BSP Static Build Check / stm32_f7_g0_h7_mp15_u5_h5_wb5 (push) Has been cancelled
RT-Thread BSP Static Build Check / stm32l4_f0_f1 (push) Has been cancelled
BSP compilation with more drivers / BSP Compilation with More Drivers (push) Has been cancelled
doc_doxygen / doxygen_doc generate (push) Has been cancelled
doc_doxygen / deploy (push) Has been cancelled

* 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 <unicorn_wang@outlook.com>

* 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 <unicorn_wang@outlook.com>

---------

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
This commit is contained in:
Chen Wang
2025-02-15 12:15:19 +08:00
committed by GitHub
parent f6f7d91a61
commit c40b79037c
47 changed files with 233 additions and 233 deletions
+2 -2
View File
@@ -37,7 +37,7 @@ static volatile rt_atomic_t rt_tick = 0;
static void (*rt_tick_hook)(void);
/**
* @addtogroup Hook
* @addtogroup group_Hook
*/
/**@{*/
@@ -56,7 +56,7 @@ void rt_tick_sethook(void (*hook)(void))
#endif /* RT_USING_HOOK */
/**
* @addtogroup Clock
* @addtogroup group_Clock
*/
/**@{*/
+6 -6
View File
@@ -63,7 +63,7 @@ extern void (*rt_object_put_hook)(struct rt_object *object);
#endif /* RT_USING_HOOK */
/**
* @addtogroup IPC
* @addtogroup group_IPC
* @{
*/
@@ -314,7 +314,7 @@ void rt_susp_list_print(rt_list_t *list)
#ifdef RT_USING_SEMAPHORE
/**
* @addtogroup semaphore
* @addtogroup group_semaphore Semaphore
* @{
*/
@@ -976,7 +976,7 @@ static void _mutex_before_delete_detach(rt_mutex_t mutex)
}
/**
* @addtogroup mutex
* @addtogroup group_mutex Mutex
* @{
*/
@@ -1745,7 +1745,7 @@ RTM_EXPORT(rt_mutex_control);
#ifdef RT_USING_EVENT
/**
* @addtogroup event
* @addtogroup group_event Event
* @{
*/
@@ -2298,7 +2298,7 @@ RTM_EXPORT(rt_event_control);
#ifdef RT_USING_MAILBOX
/**
* @addtogroup mailbox
* @addtogroup group_mailbox MailBox
* @{
*/
@@ -3043,7 +3043,7 @@ RTM_EXPORT(rt_mb_control);
#ifdef RT_USING_MESSAGEQUEUE
/**
* @addtogroup messagequeue
* @addtogroup group_messagequeue Message Queue
* @{
*/
+3 -3
View File
@@ -30,7 +30,7 @@ static void (*rt_interrupt_enter_hook)(void);
static void (*rt_interrupt_leave_hook)(void);
/**
* @ingroup Hook
* @ingroup group_Hook
*
* @brief This function set a hook function when the system enter a interrupt
*
@@ -44,7 +44,7 @@ void rt_interrupt_enter_sethook(void (*hook)(void))
}
/**
* @ingroup Hook
* @ingroup group_Hook
*
* @brief This function set a hook function when the system exit a interrupt.
*
@@ -59,7 +59,7 @@ void rt_interrupt_leave_sethook(void (*hook)(void))
#endif /* RT_USING_HOOK */
/**
* @addtogroup Kernel
* @addtogroup group_Kernel
*/
/**@{*/
+2 -2
View File
@@ -54,7 +54,7 @@
#endif
/**
* @addtogroup KernelService
* @addtogroup group_KernelService
* @{
*/
@@ -589,7 +589,7 @@ static void (*rt_realloc_exit_hook)(void **ptr, rt_size_t size);
static void (*rt_free_hook)(void **ptr);
/**
* @ingroup Hook
* @ingroup group_Hook
* @{
*/
+1 -1
View File
@@ -254,7 +254,7 @@ rt_err_t rt_smem_detach(rt_smem_t m)
RTM_EXPORT(rt_smem_detach);
/**
* @addtogroup MM
* @addtogroup group_MM
*/
/**@{*/
+2 -2
View File
@@ -29,7 +29,7 @@ static void (*rt_mp_alloc_hook)(struct rt_mempool *mp, void *block);
static void (*rt_mp_free_hook)(struct rt_mempool *mp, void *block);
/**
* @addtogroup Hook
* @addtogroup group_Hook
*/
/**@{*/
@@ -60,7 +60,7 @@ void rt_mp_free_sethook(void (*hook)(struct rt_mempool *mp, void *block))
#endif /* RT_USING_HOOK */
/**
* @addtogroup MM
* @addtogroup group_MM
*/
/**@{*/
+2 -2
View File
@@ -152,7 +152,7 @@ void (*rt_object_take_hook)(struct rt_object *object);
void (*rt_object_put_hook)(struct rt_object *object);
/**
* @addtogroup Hook
* @addtogroup group_Hook
*/
/**@{*/
@@ -231,7 +231,7 @@ void rt_object_put_sethook(void (*hook)(struct rt_object *object))
#endif /* RT_USING_HOOK */
/**
* @addtogroup KernelObject
* @addtogroup group_KernelObject
*/
/**@{*/
+2 -2
View File
@@ -145,7 +145,7 @@ static void (*rt_scheduler_hook)(struct rt_thread *from, struct rt_thread *to);
static void (*rt_scheduler_switch_hook)(struct rt_thread *tid);
/**
* @addtogroup Hook
* @addtogroup group_Hook
*/
/**@{*/
@@ -495,7 +495,7 @@ void rt_system_scheduler_start(void)
}
/**
* @addtogroup Thread
* @addtogroup group_Thread
* @cond
*/
+2 -2
View File
@@ -55,7 +55,7 @@ static void (*rt_scheduler_hook)(struct rt_thread *from, struct rt_thread *to);
static void (*rt_scheduler_switch_hook)(struct rt_thread *tid);
/**
* @addtogroup Hook
* @addtogroup group_Hook
*/
/**@{*/
@@ -187,7 +187,7 @@ void rt_system_scheduler_start(void)
}
/**
* @addtogroup Thread
* @addtogroup group_Thread
* @cond
*/
+1 -1
View File
@@ -469,7 +469,7 @@ rt_inline int zoneindex(rt_size_t *bytes)
}
/**
* @addtogroup MM
* @addtogroup group_MM
*/
/**@{*/
+1 -1
View File
@@ -297,7 +297,7 @@ static rt_err_t _thread_init(struct rt_thread *thread,
}
/**
* @addtogroup Thread
* @addtogroup group_Thread
*/
/**@{*/
+4 -4
View File
@@ -63,7 +63,7 @@ static void (*rt_timer_enter_hook)(struct rt_timer *timer);
static void (*rt_timer_exit_hook)(struct rt_timer *timer);
/**
* @addtogroup Hook
* @addtogroup group_Hook
*/
/**@{*/
@@ -240,7 +240,7 @@ void rt_timer_dump(rt_list_t timer_heads[])
#endif /* (DBG_LVL == DBG_LOG) */
/**
* @addtogroup Clock
* @addtogroup group_Clock
*/
/**@{*/
@@ -816,7 +816,7 @@ static void _timer_thread_entry(void *parameter)
#endif /* RT_USING_TIMER_SOFT */
/**
* @ingroup SystemInit
* @ingroup group_SystemInit
*
* @brief This function will initialize system timer
*/
@@ -835,7 +835,7 @@ void rt_system_timer_init(void)
}
/**
* @ingroup SystemInit
* @ingroup group_SystemInit
*
* @brief This function will initialize system timer thread
*/