summaryrefslogtreecommitdiff
path: root/components/drivers/include
diff options
context:
space:
mode:
authorJackistang <[email protected]>2021-08-17 22:44:29 +0800
committerJackistang <[email protected]>2021-08-17 22:44:29 +0800
commit6173c9d7d5933adbf2ed374034d34608bbdd3c58 (patch)
tree4644281082dfe0a77c4f8d66dae05c7ba05f8ce1 /components/drivers/include
parenta454422bd22b34fd45340129348a70363d82ef58 (diff)
fix comments error in ringbuffer and workqueue.
Diffstat (limited to 'components/drivers/include')
-rw-r--r--components/drivers/include/ipc/ringbuffer.h6
-rw-r--r--components/drivers/include/ipc/workqueue.h8
2 files changed, 7 insertions, 7 deletions
diff --git a/components/drivers/include/ipc/ringbuffer.h b/components/drivers/include/ipc/ringbuffer.h
index a9d74b064d..da68c5c1fa 100644
--- a/components/drivers/include/ipc/ringbuffer.h
+++ b/components/drivers/include/ipc/ringbuffer.h
@@ -5,7 +5,7 @@
*
* Change Logs:
* Date Author Notes
- * 2021-08-14 Jackistang add commets for function inferface.
+ * 2021-08-14 Jackistang add comments for function interface.
*/
#ifndef RINGBUFFER_H__
#define RINGBUFFER_H__
@@ -82,9 +82,9 @@ void rt_ringbuffer_destroy(struct rt_ringbuffer *rb);
#endif
/**
- * @brief Get buffer size of the ringbuffer object.
+ * @brief Get buffer size of the ring buffer object.
*
- * @param rb A pointer to the ringbuffer object.
+ * @param rb A pointer to the ring buffer object.
*
* @return Buffer size.
*/
diff --git a/components/drivers/include/ipc/workqueue.h b/components/drivers/include/ipc/workqueue.h
index d479d0ec95..70744ad668 100644
--- a/components/drivers/include/ipc/workqueue.h
+++ b/components/drivers/include/ipc/workqueue.h
@@ -6,7 +6,7 @@
* Change Logs:
* Date Author Notes
* 2021-08-01 Meco Man remove rt_delayed_work_init() and rt_delayed_work structure
- * 2021-08-14 Jackistang add commets for rt_work_init()
+ * 2021-08-14 Jackistang add comments for rt_work_init()
*/
#ifndef WORKQUEUE_H__
#define WORKQUEUE_H__
@@ -69,10 +69,10 @@ rt_err_t rt_work_cancel(struct rt_work *work);
#endif /* RT_USING_SYSTEM_WORKQUEUE */
/**
- * @brief Init a work item, and bind it with a callback function.
+ * @brief Initialize a work item, binding with a callback function.
*
- * @param work A pointer to work item object.
- * @param work_func A callback function will be called when this work item is being executed.
+ * @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.
*/
rt_inline void rt_work_init(struct rt_work *work, void (*work_func)(struct rt_work *work, void *work_data),