Skip to content

Commit 27ce443

Browse files
author
James Wang
committed
accept Amanda Butler's review. change to "This function always spins to get the exact number of microseconds, which potentially affects power (such as preventing deep sleep) and multithread performance. You can avoid it by using Thread::wait()."
1 parent 0462799 commit 27ce443

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

platform/mbed_wait_api.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,9 @@ extern "C" {
5555
* @param s number of seconds to wait
5656
*
5757
* @note
58-
* This func always spin to get an exact number of microseconds, potentially
59-
* impacting power(like can't deep sleep) and multi-thread performance.
60-
* You can avoided by Thread::wait().
58+
* This function always spins to get the exact number of microseconds,
59+
* which potentially affects power (such as preventing deep sleep) and multithread performance.
60+
* You can avoid it by using Thread::wait().
6161
*/
6262
void wait(float s);
6363

@@ -66,9 +66,9 @@ void wait(float s);
6666
* @param ms the whole number of milliseconds to wait
6767
*
6868
* @note
69-
* This func always spin to get an exact number of microseconds, potentially
70-
* impacting power(like can't deep sleep) and multi-thread performance.
71-
* You can avoided by Thread::wait().
69+
* This function always spins to get the exact number of microseconds,
70+
* which potentially affects power (such as preventing deep sleep) and multithread performance.
71+
* You can avoid it by using Thread::wait().
7272
*/
7373
void wait_ms(int ms);
7474

@@ -77,8 +77,8 @@ void wait_ms(int ms);
7777
* @param us the whole number of microseconds to wait
7878
*
7979
* @note
80-
* This func always spin to get an exact number of microseconds, potentially
81-
* impacting power(like can't deep sleep) and multi-thread performance.
80+
* This function always spins to get the exact number of microseconds,
81+
* which potentially affects power (such as preventing deep sleep) and multithread performance.
8282
*/
8383
void wait_us(int us);
8484

0 commit comments

Comments
 (0)