diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2017-09-12 14:59:14 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-09-12 14:59:14 +0200 |
| commit | d6fa5e302cefe91f6adff5e3131f622bb5de1f39 (patch) | |
| tree | f0de41b90ffa2211ef3797e58ed761e03d9613ad /doc/base | |
| parent | 286e95c94866f66c4210b33c07df0c15da5b7319 (diff) | |
| parent | 05b3bec70d38c85a83ddaf4a3c97b7ea9c0b392a (diff) | |
Merge pull request #11144 from deliciousfudge/thread-docs
Rewrite the methods section of the Thread class
[ci skip]
Diffstat (limited to 'doc/base')
| -rw-r--r-- | doc/base/classes.xml | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 2a0d6287d8..e3af2ff8ee 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -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> |