maxmustermann/godot
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[DOCS] Small fixes for Mutex

Browse source
This commit is contained in:
Max Hilbrunner 2017-12-22 16:46:09 +01:00 committed by GitHub
parent 43190b8935
commit b7d945124e
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/Mutex.xml
View file

@ -4,7 +4,7 @@
A synchronization Mutex. A synchronization Mutex.
</brief_description> </brief_description>
<description> <description>
A synchronization Mutex. Element used in multi-threadding. Basically a binary [Semaphore]. Guarantees that only one thread has this lock, can be used to protect a critical section. A synchronization Mutex. Element used to synchronize multiple [Thread]s. Basically a binary [Semaphore]. Guarantees that only one thread can ever acquire this lock at a time. Can be used to protect a critical section. Be careful to avoid deadlocks.
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
@ -22,14 +22,14 @@
<return type="int" enum="Error"> <return type="int" enum="Error">
</return> </return>
<description> <description>
Try locking this [code]Mutex[/code], does not block. Returns [OK] on success else [ERR_BUSY]. Try locking this [code]Mutex[/code], does not block. Returns [OK] on success, [ERR_BUSY] otherwise.
</description> </description>
</method> </method>
<method name="unlock"> <method name="unlock">
<return type="void"> <return type="void">
</return> </return>
<description> <description>
Unlock this [code]Mutex[/code], leaving it to others threads. Unlock this [code]Mutex[/code], leaving it to other threads.
</description> </description>
</method> </method>
</methods> </methods>