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

Merge pull request #11144 from deliciousfudge/thread-docs

Browse source 
Rewrite the methods section of the Thread class

[ci skip]
This commit is contained in:
Rémi Verschelde 2017-09-12 14:59:14 +02:00 committed by GitHub
commit d6fa5e302c
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/base/classes.xml
View file

@ -52439,14 +52439,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">
@ -52461,7 +52461,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>