Mirrors_Framework/rt-thread
1
0
Fork 0
mirror of https://github.com/RT-Thread/rt-thread.git synced 2026-09-22 03:09:16 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

【doc】format drivers/src/completion.c

Browse Source
This commit is contained in:
chenyingchun0312
2021-08-16 13:10:26 +08:00
parent 96f773ffa9
commit 7f2aaa210c
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
components/drivers/src/completion.c
+5 -5
View File
@@ -17,7 +17,7 @@
/** /**
* @brief initialize the completion object * @brief initialize the completion object
* *
* @param completion the point of completion object * @param completion the point of completion object
*/ */
void rt_completion_init(struct rt_completion *completion) void rt_completion_init(struct rt_completion *completion)
@@ -34,14 +34,14 @@ RTM_EXPORT(rt_completion_init);
/** /**
* @brief waitting for the completion done * @brief waitting for the completion done
* NOTE: We should not use this api when * NOTE: We should not use this api when
* *
* @param completion the point of completion object * @param completion the point of completion object
* @param timeout is a timeout period (unit: an OS tick). If the completion is unavailable, the thread will wait for * @param timeout is a timeout period (unit: an OS tick). If the completion is unavailable, the thread will wait for
* the completion up to the amount of time specified by the argument. * the completion 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.
*/ */
@@ -114,7 +114,7 @@ RTM_EXPORT(rt_completion_wait);
/** /**
* @brief indicate the completion has done * @brief indicate the completion has done
* *
* @param completion the point of completion object * @param completion the point of completion object
*/ */
void rt_completion_done(struct rt_completion *completion) void rt_completion_done(struct rt_completion *completion)