diff options
Diffstat (limited to 'doc/classes/Mutex.xml')
| -rw-r--r-- | doc/classes/Mutex.xml | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/classes/Mutex.xml b/doc/classes/Mutex.xml index 2f41e100fc..793696321b 100644 --- a/doc/classes/Mutex.xml +++ b/doc/classes/Mutex.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Mutex" inherits="Reference" category="Core" version="3.2"> <brief_description> - A synchronization Mutex. + A synchronization mutex (mutual exclusion). </brief_description> <description> - 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. + A synchronization mutex (mutual exclusion). This is used to synchronize multiple [Thread]s, and is equivalent to a binary [Semaphore]. It guarantees that only one thread can ever acquire the lock at a time. A mutex can be used to protect a critical section; however, be careful to avoid deadlocks. </description> <tutorials> </tutorials> @@ -13,21 +13,21 @@ <return type="void"> </return> <description> - Lock this [Mutex], blocks until it is unlocked by the current owner. + Locks this [Mutex], blocks until it is unlocked by the current owner. </description> </method> <method name="try_lock"> <return type="int" enum="Error"> </return> <description> - Try locking this [Mutex], does not block. Returns [constant OK] on success, [constant ERR_BUSY] otherwise. + Tries locking this [Mutex], but does not block. Returns [constant OK] on success, [constant ERR_BUSY] otherwise. </description> </method> <method name="unlock"> <return type="void"> </return> <description> - Unlock this [Mutex], leaving it to other threads. + Unlocks this [Mutex], leaving it to other threads. </description> </method> </methods> |