diff options
| author | Marcus Brummer <mbrlabs7@gmail.com> | 2021-03-03 18:27:09 +0100 |
|---|---|---|
| committer | Marcus Brummer <mbrlabs7@gmail.com> | 2021-03-03 18:41:49 +0100 |
| commit | 46bbeb2b601787c3f2a1deb358c3a56e9198f5a2 (patch) | |
| tree | 726659b0d8ef0fc6e95915f5692cbc2124cca253 | |
| parent | 864caf571164dea655a7c1f9d9b423195653dee2 (diff) | |
Documented that mutexes are implemented recursively
| -rw-r--r-- | doc/classes/Mutex.xml | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/classes/Mutex.xml b/doc/classes/Mutex.xml index f5f6308401..336d7f1cf2 100644 --- a/doc/classes/Mutex.xml +++ b/doc/classes/Mutex.xml @@ -15,6 +15,7 @@ </return> <description> Locks this [Mutex], blocks until it is unlocked by the current owner. + [b]Note:[/b] This function returns without blocking if the thread already has ownership of the mutex. </description> </method> <method name="try_lock"> @@ -22,6 +23,7 @@ </return> <description> Tries locking this [Mutex], but does not block. Returns [constant OK] on success, [constant ERR_BUSY] otherwise. + [b]Note:[/b] This function returns [constant OK] if the thread already has ownership of the mutex. </description> </method> <method name="unlock"> @@ -29,6 +31,7 @@ </return> <description> Unlocks this [Mutex], leaving it to other threads. + [b]Note:[/b] If a thread called [method lock] or [method try_lock] multiple times while already having ownership of the mutex, it must also call [method unlock] the same number of times in order to unlock it correctly. </description> </method> </methods> |