Rewrite the methods section of the Thread class

This commit is contained in:
Roger Smith 2017-09-10 18:31:41 +12:00
parent c78739adab
commit 05b3bec70d
1 changed files with 3 additions and 3 deletions

View File

@ -52272,14 +52272,14 @@
<return type="String">
</return>
<description>
Return the id of the thread, uniquely identifying it among all threads.
Returns the current [Thread]\ s id, uniquely identifying it among all threads.
</description>
</method>
<method name="is_active" qualifiers="const">
<return type="bool">
</return>
<description>
Whether this thread is currently active, an active Thread cannot start work on a new method but can be joined with [method wait_to_finish].
Returns true if this [Thread] is currently active. An active [Thread] cannot start work on a new method but can be joined with [method wait_to_finish].
</description>
</method>
<method name="start">
@ -52294,7 +52294,7 @@
<argument index="3" name="priority" type="int" default="1">
</argument>
<description>
Start a new [Thread], it will run "method" on object "instance" using "userdata" as an argument and running with "priority", one of PRIORITY_* enum.
Starts a new [Thread] that runs "method" on object "instance" with "userdata" passed as an argument. The "priority" of the [Thread] can be changed by passing a PRIORITY_* enum.
Returns OK on success, or ERR_CANT_CREATE on failure.
</description>
</method>