diff options
| author | Roger Smith <nz.rogersmith@gmail.com> | 2017-09-10 18:31:41 +1200 |
|---|---|---|
| committer | Roger Smith <nz.rogersmith@gmail.com> | 2017-09-12 15:33:55 +1200 |
| commit | 05b3bec70d38c85a83ddaf4a3c97b7ea9c0b392a (patch) | |
| tree | 9939507653549a1b7d4fc8be26d89ff4bb2c2532 /doc | |
| parent | c78739adab54097edd7aeda706c7ef4423717f88 (diff) | |
Rewrite the methods section of the Thread class
Diffstat (limited to 'doc')
| -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 9f14f6cecf..dc4f4918b5 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -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> |