Skip to content

Commit 4c6b402

Browse files
committed
Update the comments for ringbuffer and workqueue.
1 parent 3de03a0 commit 4c6b402

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

components/drivers/src/ringbuffer.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ rt_inline enum rt_ringbuffer_state rt_ringbuffer_status(struct rt_ringbuffer *rb
2929
}
3030

3131
/**
32-
* @brief Initialize the ring buffer object with the given buffer.
32+
* @brief Initialize the ring buffer object.
3333
*
3434
* @param rb A pointer to the ring buffer object.
3535
* @param pool A pointer to the buffer.
@@ -415,7 +415,7 @@ RTM_EXPORT(rt_ringbuffer_reset);
415415
*
416416
* @param size The size of the buffer in bytes.
417417
*
418-
* @return Return a pointer to ring buffer object. When the return value is RT_NULL, it means the creation failed.
418+
* @return Return a pointer to ring buffer object. When the return value is RT_NULL, it means this creation failed.
419419
*/
420420
struct rt_ringbuffer *rt_ringbuffer_create(rt_uint16_t size)
421421
{

components/drivers/src/workqueue.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,7 @@ rt_err_t rt_workqueue_submit_work(struct rt_workqueue *queue, struct rt_work *wo
302302
}
303303

304304
/**
305-
* @brief Submit a work item to the work queue without delay. This work item will be executed after the current work item is executed.
305+
* @brief Submit a work item to the work queue without delay. This work item will be executed after the current work item.
306306
*
307307
* @param queue A pointer to the workqueue object.
308308
* @param work A pointer to the work item object.

0 commit comments

Comments
 (0)