From 5e02709c5533b5741b7ae8eae4945c8c43f86beb Mon Sep 17 00:00:00 2001 From: chenyingchun0312 Date: Mon, 23 Aug 2021 18:52:31 +0800 Subject: [PATCH] =?UTF-8?q?=E3=80=90doc=E3=80=91update=20completion.c=20co?= =?UTF-8?q?mments?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- components/drivers/src/completion.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/components/drivers/src/completion.c b/components/drivers/src/completion.c index 09f51bb9df..f13718f9b3 100644 --- a/components/drivers/src/completion.c +++ b/components/drivers/src/completion.c @@ -39,15 +39,15 @@ RTM_EXPORT(rt_completion_init); * * @param completion is a pointer to a completion object. * - * @param timeout is a timeout period (unit: an OS ticks). If the completion is unavailable, the thread will wait for + * @param timeout is a timeout period (unit: OS ticks). If the completion is unavailable, the thread will wait for * the completion done up to the amount of time specified by the argument. * NOTE: Generally, we use the macro RT_WAITING_FOREVER to set this parameter, which means that when the * completion is unavailable, the thread will be waitting forever. * - * @return Return the operation status. ONLY When the return value is RT_EOK, the operation is successful. + * @return Return the operation status. ONLY when the return value is RT_EOK, the operation is successful. * If the return value is any other values, it means that the completion wait failed. * - * @warning This function can ONLY be called in the thread context. It MUST NOT BE called in interrupt context. + * @warning This function can ONLY be called in the thread context. It MUST NOT be called in interrupt context. */ rt_err_t rt_completion_wait(struct rt_completion *completion, rt_int32_t timeout) @@ -117,7 +117,7 @@ __exit: RTM_EXPORT(rt_completion_wait); /** - * @brief This function indicate a completion has done. + * @brief This function indicates a completion has done. * * @param completion is a pointer to a completion object. */