From 6173c9d7d5933adbf2ed374034d34608bbdd3c58 Mon Sep 17 00:00:00 2001 From: Jackistang Date: Tue, 17 Aug 2021 22:44:29 +0800 Subject: fix comments error in ringbuffer and workqueue. --- components/drivers/src/workqueue.c | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'components/drivers/src/workqueue.c') diff --git a/components/drivers/src/workqueue.c b/components/drivers/src/workqueue.c index 37733a1f65..60472d9ca4 100644 --- a/components/drivers/src/workqueue.c +++ b/components/drivers/src/workqueue.c @@ -7,7 +7,7 @@ * Date Author Notes * 2017-02-27 Bernard fix the re-work issue. * 2021-08-01 Meco Man remove rt_delayed_work_init() - * 2021-08-14 Jackistang add commets for function interface. + * 2021-08-14 Jackistang add comments for function interface. */ #include @@ -217,7 +217,7 @@ static void _delayed_work_timeout_handler(void *parameter) * @param stack_size The stack size for work queue thread. * @param priority The priority for work queue thread. * - * @return Return a pointer to workqueue object. When the return value is RT_NULL, it means the creation failed. + * @return Return a pointer to workqueue object. It will return RT_NULL if failed. */ struct rt_workqueue *rt_workqueue_create(const char *name, rt_uint16_t stack_size, rt_uint8_t priority) { @@ -272,7 +272,7 @@ rt_err_t rt_workqueue_destroy(struct rt_workqueue *queue) * @param work A pointer to work item object. * * @return RT_EOK Success. - * @return -RT_EBUSY This work item is been executing now. + * @return -RT_EBUSY This work item is executing. */ rt_err_t rt_workqueue_dowork(struct rt_workqueue *queue, struct rt_work *work) { @@ -287,10 +287,10 @@ rt_err_t rt_workqueue_dowork(struct rt_workqueue *queue, struct rt_work *work) * * @param queue A pointer to workqueue object. * @param work A pointer to work item object. - * @param time This work item will be delayed by time (unit: an OS tick) before it's been submitted to the work queue. + * @param time This work item will be delayed by time (unit: an OS ticks) before it's been submitted to the work queue. * * @return RT_EOK Success. - * @return -RT_EBUSY This work item is been executing now. + * @return -RT_EBUSY This work item is executing. * @return -RT_ERROR Time is invalid. */ rt_err_t rt_workqueue_submit_work(struct rt_workqueue *queue, struct rt_work *work, rt_tick_t time) @@ -343,7 +343,7 @@ rt_err_t rt_workqueue_critical_work(struct rt_workqueue *queue, struct rt_work * * @param work A pointer to work item object. * * @return RT_EOK Success. - * @return -RT_EBUSY This work item is been executing now. + * @return -RT_EBUSY This work item is executing. */ rt_err_t rt_workqueue_cancel_work(struct rt_workqueue *queue, struct rt_work *work) { @@ -419,7 +419,7 @@ static struct rt_workqueue *sys_workq; * @param time This work item will be delayed by time (unit: an OS tick) before it's been submitted to system work queue. * * @return RT_EOK Success. - * @return -RT_EBUSY This work item is been executing now. + * @return -RT_EBUSY This work item is executing. * @return -RT_ERROR Time is invalid. */ rt_err_t rt_work_submit(struct rt_work *work, rt_tick_t time) @@ -433,7 +433,7 @@ rt_err_t rt_work_submit(struct rt_work *work, rt_tick_t time) * @param work A pointer to work item object. * * @return RT_EOK Success. - * @return -RT_EBUSY This work item is been executing now. + * @return -RT_EBUSY This work item is executing. */ rt_err_t rt_work_cancel(struct rt_work *work) { -- cgit v1.3.1