Merge pull request #11144 from deliciousfudge/thread-docs
Rewrite the methods section of the Thread class [ci skip]
This commit is contained in:
commit
d6fa5e302c
1 changed files with 3 additions and 3 deletions
|
@ -52439,14 +52439,14 @@
|
||||||
<return type="String">
|
<return type="String">
|
||||||
</return>
|
</return>
|
||||||
<description>
|
<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>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="is_active" qualifiers="const">
|
<method name="is_active" qualifiers="const">
|
||||||
<return type="bool">
|
<return type="bool">
|
||||||
</return>
|
</return>
|
||||||
<description>
|
<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>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="start">
|
<method name="start">
|
||||||
|
@ -52461,7 +52461,7 @@
|
||||||
<argument index="3" name="priority" type="int" default="1">
|
<argument index="3" name="priority" type="int" default="1">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<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.
|
Returns OK on success, or ERR_CANT_CREATE on failure.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
|
|
Loading…
Reference in a new issue