diff options
| author | Max Hilbrunner <mhilbrunner@users.noreply.github.com> | 2017-12-22 16:55:18 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-12-22 16:55:18 +0100 |
| commit | 1cae77cc66ed71751203af453615a11a9bf08874 (patch) | |
| tree | 0d83bd68c6e56d741a073419b868791845cb967e /doc/classes | |
| parent | f0f838a10afd5dca54ca611908f30d566fc24913 (diff) | |
[DOCS] Small fixes for Semaphore
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/Semaphore.xml | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/classes/Semaphore.xml b/doc/classes/Semaphore.xml index d8deb9651a..c8206ff2c2 100644 --- a/doc/classes/Semaphore.xml +++ b/doc/classes/Semaphore.xml @@ -4,7 +4,7 @@ A synchronization Semaphore. </brief_description> <description> - A synchronization Semaphore. Element used in multi-threadding. Initialized to zero on creation. + A synchronization Semaphore. Element used to synchronize multiple [Thread]s. Initialized to zero on creation. Be careful to avoid deadlocks. For a binary version, see [Mutex]. </description> <tutorials> </tutorials> @@ -15,14 +15,14 @@ <return type="int" enum="Error"> </return> <description> - Lowers the [code]Semaphore[/code], allowing one more thread in. + Lowers the [code]Semaphore[/code], allowing one more thread in. Returns [OK] on success, [ERR_BUSY] otherwise. </description> </method> <method name="wait"> <return type="int" enum="Error"> </return> <description> - Tries to wait for the [code]Semaphore[/code], if its value is zero, blocks until non-zero. + Tries to wait for the [code]Semaphore[/code], if its value is zero, blocks until non-zero. Returns [OK] on success, [ERR_BUSY] otherwise. </description> </method> </methods> |