diff options
| author | Max Hilbrunner <mhilbrunner@users.noreply.github.com> | 2017-12-22 16:46:09 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-12-22 16:46:09 +0100 |
| commit | b7d945124e17677abb2232e96b14c8be8871a82c (patch) | |
| tree | adbfed0bdafbe34edcb4c44c58f2fc12760e1322 /doc/classes | |
| parent | 43190b8935fc6355a66660ab541e4777d611a210 (diff) | |
[DOCS] Small fixes for Mutex
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/Mutex.xml | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/classes/Mutex.xml b/doc/classes/Mutex.xml index 4b845c05ad..74d59b2dd3 100644 --- a/doc/classes/Mutex.xml +++ b/doc/classes/Mutex.xml @@ -4,7 +4,7 @@ A synchronization Mutex. </brief_description> <description> - A synchronization Mutex. Element used in multi-threadding. Basically a binary [Semaphore]. Guarantees that only one thread has this lock, can be used to protect a critical section. + A synchronization Mutex. Element used to synchronize multiple [Thread]s. Basically a binary [Semaphore]. Guarantees that only one thread can ever acquire this lock at a time. Can be used to protect a critical section. Be careful to avoid deadlocks. </description> <tutorials> </tutorials> @@ -22,14 +22,14 @@ <return type="int" enum="Error"> </return> <description> - Try locking this [code]Mutex[/code], does not block. Returns [OK] on success else [ERR_BUSY]. + Try locking this [code]Mutex[/code], does not block. Returns [OK] on success, [ERR_BUSY] otherwise. </description> </method> <method name="unlock"> <return type="void"> </return> <description> - Unlock this [code]Mutex[/code], leaving it to others threads. + Unlock this [code]Mutex[/code], leaving it to other threads. </description> </method> </methods> |