summaryrefslogtreecommitdiff
path: root/components/drivers/include/ipc
diff options
context:
space:
mode:
authorJackistang <[email protected]>2021-08-18 09:44:52 +0800
committerJackistang <[email protected]>2021-08-18 09:44:52 +0800
commit3de03a072e3145522546b46117e51e9e444e1b4e (patch)
treee92896137a6712bba0f1369ac0ace7549fa5e4fa /components/drivers/include/ipc
parent6173c9d7d5933adbf2ed374034d34608bbdd3c58 (diff)
修改 ringbuffer 和 workqueue 注释的语法
Diffstat (limited to 'components/drivers/include/ipc')
-rw-r--r--components/drivers/include/ipc/ringbuffer.h2
-rw-r--r--components/drivers/include/ipc/workqueue.h4
2 files changed, 3 insertions, 3 deletions
diff --git a/components/drivers/include/ipc/ringbuffer.h b/components/drivers/include/ipc/ringbuffer.h
index da68c5c1fa..7da50225b3 100644
--- a/components/drivers/include/ipc/ringbuffer.h
+++ b/components/drivers/include/ipc/ringbuffer.h
@@ -82,7 +82,7 @@ void rt_ringbuffer_destroy(struct rt_ringbuffer *rb);
#endif
/**
- * @brief Get buffer size of the ring buffer object.
+ * @brief Get the buffer size of the ring buffer object.
*
* @param rb A pointer to the ring buffer object.
*
diff --git a/components/drivers/include/ipc/workqueue.h b/components/drivers/include/ipc/workqueue.h
index 70744ad668..776709a8ab 100644
--- a/components/drivers/include/ipc/workqueue.h
+++ b/components/drivers/include/ipc/workqueue.h
@@ -72,8 +72,8 @@ rt_err_t rt_work_cancel(struct rt_work *work);
* @brief Initialize a work item, binding with a callback function.
*
* @param work A pointer to the work item object.
- * @param work_func A callback function will be called when this work item is executed.
- * @param work_data A user data passed to the callback function as it's second parameter.
+ * @param work_func A callback function that will be called when this work item is executed.
+ * @param work_data A user data passed to the callback function as the second parameter.
*/
rt_inline void rt_work_init(struct rt_work *work, void (*work_func)(struct rt_work *work, void *work_data),
void *work_data)