Skip to content

Commit c75222f

Browse files
author
Amanda Butler
authored
Deprecate Wait.md
Replace content with deprecation warning.
1 parent 6e0a63d commit c75222f

File tree

1 file changed

+1
-18
lines changed

1 file changed

+1
-18
lines changed

docs/api/platform/Wait.md

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,3 @@
11
# Wait
22

3-
Wait functions provide simple wait capabilities. The OS scheduler puts the current thread in `waiting state`, allowing another thread to execute. Even better: If there are no other threads in `ready state`, it can put the whole microcontroller to `sleep`, saving energy.
4-
5-
## Avoiding OS delay
6-
7-
When you call wait, your board's CPU will sleep in the RTOS for the whole number of milliseconds and then spin as necessary to make up the remaining fraction of a millisecond. However, it blocks the platform deep sleep for the entire duration.
8-
9-
## Wait function reference
10-
11-
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/development/mbed-os-api-doxy/mbed__wait__api_8h_source.html)
12-
13-
## Example
14-
15-
[![View code](https://www.mbed.com/embed/?url=https://os.mbed.com/teams/mbed_example/code/wait_ex_1/)](https://os.mbed.com/teams/mbed_example/code/wait_ex_1/file/4f0543415053/main.cpp)
16-
17-
## Related content
18-
19-
- [RTOS](rtos.html) overview.
20-
- [Application flow control tutorial](../tutorials/application-flow-control.html).
3+
<span class="warnings">**Warning:** This API has been deprecated. In its place, please use [explicit sleep functions](../apis/power-management-sleep.html).</span>

0 commit comments

Comments
 (0)