Skip to content

Commit 609bf84

Browse files
author
Amanda Butler
authored
Merge pull request #806 from fkjagodzinski/docs_update-platformmutex
PlatformMutex docs update
2 parents 567dc7f + f6004c0 commit 609bf84

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/api/platform/PlatformMutex.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,25 @@
22

33
<span class="images">![](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/class_platform_mutex.png)<span>PlatformMutex class hierarchy</span></span>
44

5-
The PlarformMutex class provides mutex stub functions in the absence of RTOS. This class enables you to use driver/application code when the RTOS is not present.
5+
You can use the PlatformMutex class to synchronize the execution of threads.
6+
7+
The Mbed OS drivers use the PlatformMutex class instead of [Mutex](mutex.html). This enables the use of drivers when the Mbed OS is compiled without the RTOS. For examples, please see [AnalogIn](analogin.html), [BusOut](busout.html), [Serial](serial.html), [SPI](spi.html) and [I2C](i2c.html).
8+
9+
<span class="notes">**Note:** For the standard use of RTOS mutexes, please see [Mutex](mutex.html).</span>
610

711
### PlatformMutex class reference
812

913
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/class_platform_mutex.html)
1014

1115
### PlatformMutex example
1216

13-
The code below demonstrates usage of PlatformMutex.
14-
1517
[![View code](https://www.mbed.com/embed/?url=https://os.mbed.com/teams/mbed_example/code/mbed-os-example-platform-mutex/)](https://os.mbed.com/teams/mbed_example/code/mbed-os-example-platform-mutex/file/2084d9e90526/main.cpp)
1618

17-
Mbed OS uses the PlatformMutex class instead of the RTOS mutex for all drivers. For example, please see [AnalogIn](analogin.html), [BusOut](busout.html), [SPI](spi.html), [Serial](serial.html) and [I2C](i2c.html).
18-
1919
### Related content
2020

21+
- [Mutex](mutex.html).
2122
- [AnalogIn](analogin.html).
2223
- [BusOut](busout.html).
23-
- [SPI](spi.html).
2424
- [Serial](serial.html).
25+
- [SPI](spi.html).
2526
- [I2C](i2c.html).

0 commit comments

Comments
 (0)