From 4c6b4028e35814775fbeadb4fcc2d0a5b00a19b7 Mon Sep 17 00:00:00 2001 From: Jackistang Date: Wed, 18 Aug 2021 22:51:00 +0800 Subject: [PATCH] Update the comments for ringbuffer and workqueue. --- components/drivers/src/ringbuffer.c | 4 ++-- components/drivers/src/workqueue.c | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/components/drivers/src/ringbuffer.c b/components/drivers/src/ringbuffer.c index a8233a7555..31eab4816c 100644 --- a/components/drivers/src/ringbuffer.c +++ b/components/drivers/src/ringbuffer.c @@ -29,7 +29,7 @@ rt_inline enum rt_ringbuffer_state rt_ringbuffer_status(struct rt_ringbuffer *rb } /** - * @brief Initialize the ring buffer object with the given buffer. + * @brief Initialize the ring buffer object. * * @param rb A pointer to the ring buffer object. * @param pool A pointer to the buffer. @@ -415,7 +415,7 @@ RTM_EXPORT(rt_ringbuffer_reset); * * @param size The size of the buffer in bytes. * - * @return Return a pointer to ring buffer object. When the return value is RT_NULL, it means the creation failed. + * @return Return a pointer to ring buffer object. When the return value is RT_NULL, it means this creation failed. */ struct rt_ringbuffer *rt_ringbuffer_create(rt_uint16_t size) { diff --git a/components/drivers/src/workqueue.c b/components/drivers/src/workqueue.c index 4a776ca485..b5d803472b 100644 --- a/components/drivers/src/workqueue.c +++ b/components/drivers/src/workqueue.c @@ -302,7 +302,7 @@ rt_err_t rt_workqueue_submit_work(struct rt_workqueue *queue, struct rt_work *wo } /** - * @brief Submit a work item to the work queue without delay. This work item will be executed after the current work item is executed. + * @brief Submit a work item to the work queue without delay. This work item will be executed after the current work item. * * @param queue A pointer to the workqueue object. * @param work A pointer to the work item object. -- GitLab