summaryrefslogtreecommitdiff
path: root/include/rtthread.h
diff options
context:
space:
mode:
authorsupperthomas <[email protected]>2024-06-26 13:40:31 +0800
committerMeco Man <[email protected]>2024-06-26 20:22:43 +0800
commit14e4c45408bec8d87028187c29fba2a03222da4b (patch)
tree488fed25cf9118d6bdbf52878aa9586a25184539 /include/rtthread.h
parentf687ace6ef1a8a720a30f0bd2e3376dacb4f18a3 (diff)
[doc][doxygen] Fix doxygen struct error.
Signed-off-by: supperthomas <[email protected]>
Diffstat (limited to 'include/rtthread.h')
-rw-r--r--include/rtthread.h36
1 files changed, 35 insertions, 1 deletions
diff --git a/include/rtthread.h b/include/rtthread.h
index 87383d3428..43caf895ac 100644
--- a/include/rtthread.h
+++ b/include/rtthread.h
@@ -246,7 +246,7 @@ void rt_scheduler_ipi_handler(int vector, void *param);
/**@}*/
/**
- * @addtogroup Signals
+ * @addtogroup Signal
* @{
*/
#ifdef RT_USING_SIGNALS
@@ -403,6 +403,11 @@ rt_err_t rt_thread_suspend_to_list(rt_thread_t thread, rt_list_t *susp_list, int
/* only for a suspended thread, and caller must hold the scheduler lock */
rt_err_t rt_susp_list_enqueue(rt_list_t *susp_list, rt_thread_t thread, int ipc_flags);
+/**
+ * @addtogroup semaphore
+ * @{
+ */
+
#ifdef RT_USING_SEMAPHORE
/*
* semaphore interface
@@ -425,6 +430,13 @@ rt_err_t rt_sem_release(rt_sem_t sem);
rt_err_t rt_sem_control(rt_sem_t sem, int cmd, void *arg);
#endif /* RT_USING_SEMAPHORE */
+/**@}*/
+
+/**
+ * @addtogroup mutex
+ * @{
+ */
+
#ifdef RT_USING_MUTEX
/*
* mutex interface
@@ -457,6 +469,13 @@ rt_inline rt_ubase_t rt_mutex_get_hold(rt_mutex_t mutex)
#endif /* RT_USING_MUTEX */
+/**@}*/
+
+/**
+ * @addtogroup event
+ * @{
+ */
+
#ifdef RT_USING_EVENT
/*
* event interface
@@ -487,6 +506,13 @@ rt_err_t rt_event_recv_killable(rt_event_t event,
rt_err_t rt_event_control(rt_event_t event, int cmd, void *arg);
#endif /* RT_USING_EVENT */
+/**@}*/
+
+/**
+ * @addtogroup mailbox
+ * @{
+ */
+
#ifdef RT_USING_MAILBOX
/*
* mailbox interface
@@ -521,6 +547,12 @@ rt_err_t rt_mb_recv_killable(rt_mailbox_t mb, rt_ubase_t *value, rt_int32_t time
rt_err_t rt_mb_control(rt_mailbox_t mb, int cmd, void *arg);
#endif /* RT_USING_MAILBOX */
+/**@}*/
+
+/**
+ * @addtogroup messagequeue
+ * @{
+ */
#ifdef RT_USING_MESSAGEQUEUE
struct rt_mq_message
@@ -599,6 +631,8 @@ rt_ssize_t rt_mq_recv_prio(rt_mq_t mq,
#endif /* RT_USING_MESSAGEQUEUE_PRIORITY */
#endif /* RT_USING_MESSAGEQUEUE */
+/**@}*/
+
/* defunct */
void rt_thread_defunct_enqueue(rt_thread_t thread);
rt_thread_t rt_thread_defunct_dequeue(void);