浏览代码

Merge pull request #11144 from deliciousfudge/thread-docs

Rewrite the methods section of the Thread class

[ci skip]
Rémi Verschelde 8 年之前
父节点
当前提交
d6fa5e302c
共有 1 个文件被更改,包括 3 次插入3 次删除
  1. 3 3
      doc/base/classes.xml

+ 3 - 3
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>