diff options
| author | Pedro J. Estébanez <pedrojrulez@gmail.com> | 2023-01-27 11:04:41 +0100 |
|---|---|---|
| committer | Pedro J. Estébanez <pedrojrulez@gmail.com> | 2023-01-27 11:15:30 +0100 |
| commit | f630940591f66cc98fb52f2873e8c9f1eb1ee056 (patch) | |
| tree | 5876b0217b3c782698ea3650cdd32c6706d9fa1a /doc/classes | |
| parent | 9f74f0f6c5e5c98b18f4f0ad95092a88d064f616 (diff) | |
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"> |