summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authortuduweb <[email protected]>2023-02-03 10:00:58 +0800
committerGitHub <[email protected]>2023-02-02 21:00:58 -0500
commit9fbf63441e1b8cea112987ee30fe8b670668e87b (patch)
treefee52a0d11ed00ce972fe347ea9647c75711ec4b /src
parentfb8e9ea93a7e455a09439d33222bd1da74822633 (diff)
[doxygen] Fix some warnings in doxygen (#6899)
Diffstat (limited to 'src')
-rw-r--r--src/ipc.c26
-rw-r--r--src/kservice.c6
-rw-r--r--src/mem.c2
-rw-r--r--src/thread.c3
4 files changed, 15 insertions, 22 deletions
diff --git a/src/ipc.c b/src/ipc.c
index fa25ce73a1..0aafb2ea6d 100644
--- a/src/ipc.c
+++ b/src/ipc.c
@@ -67,10 +67,9 @@ extern void (*rt_object_put_hook)(struct rt_object *object);
/**
* @addtogroup IPC
+ * @{
*/
-/**@{*/
-
/**
* @brief This function will initialize an IPC object, such as semaphore, mutex, messagequeue and mailbox.
*
@@ -112,6 +111,8 @@ rt_inline rt_err_t _ipc_object_init(struct rt_ipc_object *ipc)
* the first-in-first-out principle, and you clearly understand that all threads involved in
* this semaphore will become non-real-time threads.
*
+ * @param suspend_flag status flag of the thread to be suspended.
+ *
* @return Return the operation status. When the return value is RT_EOK, the function is successfully executed.
* When the return value is any other values, it means the initialization failed.
*
@@ -257,14 +258,12 @@ rt_inline rt_err_t _ipc_list_resume_all(rt_list_t *list)
return RT_EOK;
}
-/**@}*/
-
#ifdef RT_USING_SEMAPHORE
/**
* @addtogroup semaphore
+ * @{
*/
-/**@{*/
/**
* @brief This function will initialize a static semaphore object.
*
@@ -777,7 +776,7 @@ rt_inline rt_uint8_t _thread_get_mutex_priority(struct rt_thread* thread)
}
rt_inline void _thread_update_priority(struct rt_thread *thread, rt_uint8_t priority, int suspend_flag)
-{
+{
rt_err_t ret;
RT_DEBUG_LOG(RT_DEBUG_IPC,
("thread:%s priority -> %d\n", thread->name, priority));
@@ -828,10 +827,9 @@ rt_inline void _thread_update_priority(struct rt_thread *thread, rt_uint8_t prio
/**
* @addtogroup mutex
+ * @{
*/
-/**@{*/
-
/**
* @brief Initialize a static mutex object.
*
@@ -1538,10 +1536,9 @@ RTM_EXPORT(rt_mutex_control);
#ifdef RT_USING_EVENT
/**
* @addtogroup event
+ * @{
*/
-/**@{*/
-
/**
* @brief The function will initialize a static event object.
*
@@ -2084,10 +2081,9 @@ RTM_EXPORT(rt_event_control);
#ifdef RT_USING_MAILBOX
/**
* @addtogroup mailbox
+ * @{
*/
-/**@{*/
-
/**
* @brief Initialize a static mailbox object.
*
@@ -2102,6 +2098,8 @@ RTM_EXPORT(rt_event_control);
*
* @param name is a pointer to the name that given to the mailbox.
*
+ * @param msgpool the begin address of buffer to save received mail.
+ *
* @param size is the maximum number of mails in the mailbox.
* For example, when the mailbox buffer capacity is N, size is N/4.
*
@@ -2842,10 +2840,9 @@ RTM_EXPORT(rt_mb_control);
#ifdef RT_USING_MESSAGEQUEUE
/**
* @addtogroup messagequeue
+ * @{
*/
-/**@{*/
-
struct rt_mq_message
{
struct rt_mq_message *next;
@@ -3778,5 +3775,4 @@ RTM_EXPORT(rt_mq_control);
/**@}*/
#endif /* RT_USING_MESSAGEQUEUE */
-
/**@}*/
diff --git a/src/kservice.c b/src/kservice.c
index 0a8902b360..54c2e133ab 100644
--- a/src/kservice.c
+++ b/src/kservice.c
@@ -44,10 +44,9 @@
/**
* @addtogroup KernelService
+ * @{
*/
-/**@{*/
-
/* global errno in RT-Thread */
static volatile int __rt_errno;
@@ -1390,10 +1389,9 @@ static void (*rt_free_hook)(void *ptr);
/**
* @addtogroup Hook
+ * @{
*/
-/**@{*/
-
/**
* @brief This function will set a hook function, which will be invoked when a memory
* block is allocated from heap memory.
diff --git a/src/mem.c b/src/mem.c
index 221a5553e6..aade0f5bfa 100644
--- a/src/mem.c
+++ b/src/mem.c
@@ -165,8 +165,6 @@ static void plug_holes(struct rt_small_mem *m, struct rt_small_mem_item *mem)
/**
* @brief This function will initialize small memory management algorithm.
*
- * @param m the small memory management object.
- *
* @param name is the name of the small memory management object.
*
* @param begin_addr the beginning address of memory.
diff --git a/src/thread.c b/src/thread.c
index 6c642bb8a8..5614edea4d 100644
--- a/src/thread.c
+++ b/src/thread.c
@@ -967,7 +967,8 @@ static void rt_thread_set_suspend_state(struct rt_thread *thread, int suspend_fl
* thread is executing when you suspend it. If you suspend a thread while sharing a resouce with
* other threads and occupying this resouce, starvation can occur very easily.
*
- * @param thread is the thread to be suspended.
+ * @param thread the thread to be suspended.
+ * @param suspend_flag status flag of the thread to be suspended.
*
* @return Return the operation status. If the return value is RT_EOK, the function is successfully executed.
* If the return value is any other values, it means this operation failed.