summaryrefslogtreecommitdiff
path: root/doc/classes/Mutex.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/Mutex.xml')
-rw-r--r--doc/classes/Mutex.xml13
1 files changed, 5 insertions, 8 deletions
diff --git a/doc/classes/Mutex.xml b/doc/classes/Mutex.xml
index 2de1f71867..f97b2344a5 100644
--- a/doc/classes/Mutex.xml
+++ b/doc/classes/Mutex.xml
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
-<class name="Mutex" inherits="Reference" version="4.0">
+<class name="Mutex" inherits="RefCounted" version="4.0">
<brief_description>
A synchronization mutex (mutual exclusion).
</brief_description>
@@ -7,26 +7,23 @@
A synchronization mutex (mutual exclusion). This is used to synchronize multiple [Thread]s, and is equivalent to a binary [Semaphore]. It guarantees that only one thread can ever acquire the lock at a time. A mutex can be used to protect a critical section; however, be careful to avoid deadlocks.
</description>
<tutorials>
- <link>https://docs.godotengine.org/en/latest/tutorials/threads/using_multiple_threads.html</link>
+ <link title="Using multiple threads">https://docs.godotengine.org/en/latest/tutorials/threads/using_multiple_threads.html</link>
</tutorials>
<methods>
<method name="lock">
- <return type="void">
- </return>
+ <return type="void" />
<description>
Locks this [Mutex], blocks until it is unlocked by the current owner.
</description>
</method>
<method name="try_lock">
- <return type="int" enum="Error">
- </return>
+ <return type="int" enum="Error" />
<description>
Tries locking this [Mutex], but does not block. Returns [constant OK] on success, [constant ERR_BUSY] otherwise.
</description>
</method>
<method name="unlock">
- <return type="void">
- </return>
+ <return type="void" />
<description>
Unlocks this [Mutex], leaving it to other threads.
</description>