Diff: platform/mbed_wait_api.h

Revision:

168:b9e159c1930a

Parent:

158:1c57384330a6

Child:

170:e95d10626187

--- a/platform/mbed_wait_api.h	Fri May 11 16:51:14 2018 +0100
+++ b/platform/mbed_wait_api.h	Thu May 24 15:35:55 2018 +0100
@@ -53,18 +53,32 @@
  *  the accuracy of single precision floating point).
  *
  *  @param s number of seconds to wait
+ * 
+ *  @note
+ *    If the RTOS is present, 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().
  */
 void wait(float s);
 
 /** Waits a number of milliseconds.
  *
  *  @param ms the whole number of milliseconds to wait
+ * 
+ *  @note
+ *    If the RTOS is present, 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().
  */
 void wait_ms(int ms);
 
 /** Waits a number of microseconds.
  *
  *  @param us the whole number of microseconds to wait
+ * 
+ *  @note
+ *    If the RTOS is present, this function always spins to get the exact number of microseconds, 
+ *    which potentially affects power (such as preventing deep sleep) and multithread performance.
  */
 void wait_us(int us);