File tree Expand file tree Collapse file tree 1 file changed +12
-2
lines changed Expand file tree Collapse file tree 1 file changed +12
-2
lines changed Original file line number Diff line number Diff line change @@ -215,8 +215,13 @@ namespace codal
215
215
*
216
216
* @param milliseconds the amount of time, in ms, to wait for. This number cannot be negative.
217
217
*
218
- * @return MICROBIT_OK on success, MICROBIT_INVALID_PARAMETER milliseconds is less than zero.
218
+ * @code
219
+ * uBit.sleep(20); //sleep for 20ms
220
+ * @endcode
219
221
*
222
+ * @note This operation is currently limited by the rate of the system timer, therefore
223
+ * the granularity of the sleep operation is limited to 4 ms, unless the rate of
224
+ * the system timer is modified.
220
225
*/
221
226
void sleep (uint32_t milliseconds);
222
227
@@ -289,8 +294,13 @@ namespace codal
289
294
*
290
295
* @param milliseconds the amount of time, in ms, to wait for. This number cannot be negative.
291
296
*
292
- * @return MICROBIT_OK on success, MICROBIT_INVALID_PARAMETER milliseconds is less than zero.
297
+ * @code
298
+ * uBit.sleep(20); //sleep for 20ms
299
+ * @endcode
293
300
*
301
+ * @note This operation is currently limited by the rate of the system timer, therefore
302
+ * the granularity of the sleep operation is limited to 4 ms, unless the rate of
303
+ * the system timer is modified.
294
304
*/
295
305
inline void MicroBit::sleep (uint32_t milliseconds)
296
306
{
You can’t perform that action at this time.
0 commit comments