Browse Source

【doc】update completion.c comments

chenyingchun0312 3 years ago
parent
commit
5e02709c55
1 changed files with 4 additions and 4 deletions
  1. 4 4
      components/drivers/src/completion.c

+ 4 - 4
components/drivers/src/completion.c

@@ -39,15 +39,15 @@ RTM_EXPORT(rt_completion_init);
  *
  *
  * @param completion is a pointer to a completion object.
  * @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.
  *                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
  *                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.
  *                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.
  *         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_err_t rt_completion_wait(struct rt_completion *completion,
                             rt_int32_t            timeout)
                             rt_int32_t            timeout)
@@ -117,7 +117,7 @@ __exit:
 RTM_EXPORT(rt_completion_wait);
 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.
  * @param completion is a pointer to a completion object.
  */
  */