Browse Source

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`
Zak 4 years ago
parent
commit
9e2882a989
1 changed files with 2 additions and 0 deletions
  1. 2 0
      doc/classes/Thread.xml

+ 2 - 0
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>