mirror of https://github.com/ARMmbed/mbed-os.git
mbed_wait_api: add comments to warn the func will lock deep sleep
parent
df47efc4ca
commit
4c69419e2e
|
@ -53,18 +53,27 @@ extern "C" {
|
|||
* the accuracy of single precision floating point).
|
||||
*
|
||||
* @param s number of seconds to wait
|
||||
*
|
||||
* @note
|
||||
* This func will lock the deep sleep, if you want device entry deep sleep mode, please use Thread::wait()
|
||||
*/
|
||||
void wait(float s);
|
||||
|
||||
/** Waits a number of milliseconds.
|
||||
*
|
||||
* @param ms the whole number of milliseconds to wait
|
||||
*
|
||||
* @note
|
||||
* This func will lock the deep sleep, if you want device entry deep sleep mode, please use Thread::wait()
|
||||
*/
|
||||
void wait_ms(int ms);
|
||||
|
||||
/** Waits a number of microseconds.
|
||||
*
|
||||
* @param us the whole number of microseconds to wait
|
||||
*
|
||||
* @note
|
||||
* This func will lock the deep sleep.
|
||||
*/
|
||||
void wait_us(int us);
|
||||
|
||||
|
|
Loading…
Reference in New Issue