summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorMax Hilbrunner <mhilbrunner@users.noreply.github.com>2021-09-09 14:10:35 +0200
committerGitHub <noreply@github.com>2021-09-09 14:10:35 +0200
commit7b846e3f010afdd1567ac15a1d07b0dba9160660 (patch)
tree5e1ee6c5377f4d69f8abe6fff18cc64a2a566d76 /doc/classes
parent43a9a9f6803da19c813f2bd9604cab75b444709c (diff)
parent9e2882a98982e4d0a8550feca468b87120515bd2 (diff)
Merge pull request #46656 from zaksnet/improve-thread-docs
Improve documentation for Thread
Diffstat (limited to 'doc/classes')
-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>