diff options
| author | Max Hilbrunner <mhilbrunner@users.noreply.github.com> | 2021-09-16 02:20:00 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-16 02:20:00 +0200 |
| commit | 4317d3a4a26bb9ebaca7b788452f06f6688d8625 (patch) | |
| tree | d3504b07856faa9630758e7ccb2846c0fae6c60f | |
| parent | 4737b7bbb4a06e988d7906437834b136066b594b (diff) | |
| parent | 46bbeb2b601787c3f2a1deb358c3a56e9198f5a2 (diff) | |
Merge pull request #46625 from mbrlabs/docs-mutex-lock
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 f97b2344a5..0e6b1e3e44 100644 --- a/doc/classes/Mutex.xml +++ b/doc/classes/Mutex.xml @@ -14,18 +14,21 @@ <return type="void" /> <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"> <return type="int" enum="Error" /> <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"> <return type="void" /> <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> |