diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2023-01-27 15:40:43 +0100 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2023-01-27 15:40:43 +0100 |
| commit | f0e3c3f4c398f25ad5d9f9133c0ff6162e6716ad (patch) | |
| tree | 3e8d948be734a26d884cea35bc3caa8f78eaf71f /doc/classes | |
| parent | 518b9e5801a19229805fe837d7d0cf92920ad413 (diff) | |
| parent | f630940591f66cc98fb52f2873e8c9f1eb1ee056 (diff) | |
Merge pull request #72168 from RandomShaper/sensible_lock_return
Booleanize various sync primitives' wait & locking methods
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/Mutex.xml | 4 | ||||
| -rw-r--r-- | doc/classes/Semaphore.xml | 4 |
2 files changed, 4 insertions, 4 deletions
diff --git a/doc/classes/Mutex.xml b/doc/classes/Mutex.xml index 74f29bdc48..78694ce813 100644 --- a/doc/classes/Mutex.xml +++ b/doc/classes/Mutex.xml @@ -18,9 +18,9 @@ </description> </method> <method name="try_lock"> - <return type="int" enum="Error" /> + <return type="bool" /> <description> - Tries locking this [Mutex], but does not block. Returns [constant OK] on success, [constant ERR_BUSY] otherwise. + Tries locking this [Mutex], but does not block. Returns [code]true[/code] on success, [code]false[/code] otherwise. [b]Note:[/b] This function returns [constant OK] if the thread already has ownership of the mutex. </description> </method> diff --git a/doc/classes/Semaphore.xml b/doc/classes/Semaphore.xml index 6b2007363e..d1d126c5cb 100644 --- a/doc/classes/Semaphore.xml +++ b/doc/classes/Semaphore.xml @@ -17,9 +17,9 @@ </description> </method> <method name="try_wait"> - <return type="int" enum="Error" /> + <return type="bool" /> <description> - Like [method wait], but won't block, so if the value is zero, fails immediately and returns [constant ERR_BUSY]. If non-zero, it returns [constant OK] to report success. + Like [method wait], but won't block, so if the value is zero, fails immediately and returns [code]false[/code]. If non-zero, it returns [code]true[/code] to report success. </description> </method> <method name="wait"> |