summaryrefslogtreecommitdiff
path: root/include/rtthread.h
diff options
context:
space:
mode:
authorChen Wang <[email protected]>2025-02-15 12:15:19 +0800
committerGitHub <[email protected]>2025-02-15 12:15:19 +0800
commitc40b79037ce8bb09ba95411ebee1b22631cf9027 (patch)
treed4b1874eda192bd78d4f2790aed3c6f9dc6a0679 /include/rtthread.h
parentf6f7d91a61c9a75ce8e79f6156a2a97f24baed90 (diff)
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 <[email protected]> * 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 <[email protected]> --------- Signed-off-by: Chen Wang <[email protected]>
Diffstat (limited to 'include/rtthread.h')
-rw-r--r--include/rtthread.h28
1 files changed, 14 insertions, 14 deletions
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
* @{
*/