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

Improve docs for Thread

Browse source 
An attempt to improve the documentation for Thread
- Adds documentation on how and when the `wait_to_finish` should be used
- Adds a note on what to be careful about when using `wait_to_finish`

(cherry picked from commit 9e2882a989)
This commit is contained in:
Zak 2021-03-04 15:27:14 +01:00 committed by Rémi Verschelde
parent cc04b4ceba
commit fb17ac885a
No known key found for this signature in database
GPG key ID: C3336907360768E1
1 changed files with 2 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/classes/Thread.xml
View file

@ -40,6 +40,8 @@
<return type="Variant" /> <return type="Variant" />
<description> <description>
Joins the [Thread] and waits for it to finish. Returns what the method called returned. 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> </description>
</method> </method>
</methods> </methods>