summaryrefslogtreecommitdiff
path: root/doc/classes/Thread.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/Thread.xml')
-rw-r--r--doc/classes/Thread.xml2
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/classes/Thread.xml b/doc/classes/Thread.xml
index b553aad518..9c9119c664 100644
--- a/doc/classes/Thread.xml
+++ b/doc/classes/Thread.xml
@@ -40,6 +40,8 @@
<return type="Variant" />
<description>
Joins the [Thread] and waits for it to finish. Returns what the method called returned.
+ Should either be used when you want to retrieve the value returned from the method called by the [Thread] or before freeing the instance that contains the [Thread].
+ [b]Note:[/b] After the [Thread] finishes joining it will be disposed. If you want to use it again you will have to create a new instance of it.
</description>
</method>
</methods>