Skip to content

Commit 4c69419

Browse files
author
James Wang
committed
mbed_wait_api: add comments to warn the func will lock deep sleep
1 parent df47efc commit 4c69419

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

platform/mbed_wait_api.h

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,18 +53,27 @@ extern "C" {
5353
* the accuracy of single precision floating point).
5454
*
5555
* @param s number of seconds to wait
56+
*
57+
* @note
58+
* This func will lock the deep sleep, if you want device entry deep sleep mode, please use Thread::wait()
5659
*/
5760
void wait(float s);
5861

5962
/** Waits a number of milliseconds.
6063
*
6164
* @param ms the whole number of milliseconds to wait
65+
*
66+
* @note
67+
* This func will lock the deep sleep, if you want device entry deep sleep mode, please use Thread::wait()
6268
*/
6369
void wait_ms(int ms);
6470

6571
/** Waits a number of microseconds.
6672
*
6773
* @param us the whole number of microseconds to wait
74+
*
75+
* @note
76+
* This func will lock the deep sleep.
6877
*/
6978
void wait_us(int us);
7079

0 commit comments

Comments
 (0)