diff options
| author | Zak <zakscomputers@hotmail.com> | 2021-03-04 15:27:14 +0100 |
|---|---|---|
| committer | Zak <zakscomputers@hotmail.com> | 2021-03-04 16:56:54 +0100 |
| commit | 9e2882a98982e4d0a8550feca468b87120515bd2 (patch) | |
| tree | dccaec05091a81e95b4f92d209254d693d958639 | |
| parent | 4c10d31bc42f0d01d1b6a8042413a8886d19f987 (diff) | |
Improve docs for Thread
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`
| -rw-r--r-- | doc/classes/Thread.xml | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/classes/Thread.xml b/doc/classes/Thread.xml index 88f46e3937..9c3aaca403 100644 --- a/doc/classes/Thread.xml +++ b/doc/classes/Thread.xml @@ -48,6 +48,8 @@ </return> <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> |