asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #14946 from mhilbrunner/patch-9

Browse source 
[DOCS] Small fixes for Semaphore

[ci skip]
This commit is contained in:
Noshyaar 2017-12-22 23:07:08 +07:00 committed by GitHub
commit 32d8b99bc3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/classes/Semaphore.xml
View file

@ -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>