summaryrefslogtreecommitdiff
path: root/components/drivers
diff options
context:
space:
mode:
authorchenyingchun0312 <[email protected]>2021-08-23 18:52:31 +0800
committerchenyingchun0312 <[email protected]>2021-08-23 18:52:31 +0800
commit5e02709c5533b5741b7ae8eae4945c8c43f86beb (patch)
tree066de0588659dc79b42a2f04c8eba331ed5db105 /components/drivers
parenta6870449ba81179ac2d71f72392b9919e2f13477 (diff)
【doc】update completion.c comments
Diffstat (limited to 'components/drivers')
-rw-r--r--components/drivers/src/completion.c8
1 files 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.
*/