classref: Add property overview and setter/getter like in editor docs

Output from godotengine/godot#22013.
Fixes #1729.
This commit is contained in:
Rémi Verschelde
2018-09-13 11:06:52 +02:00
parent f9caa4be29
commit ab3f908221
578 changed files with 33831 additions and 6706 deletions

View File

@@ -8,6 +8,7 @@ Thread
======
**Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
@@ -33,13 +34,12 @@ Enumerations
.. _enum_Thread_Priority:
enum **Priority**
enum **Priority**:
- **PRIORITY_LOW** = **0**
- **PRIORITY_NORMAL** = **1**
- **PRIORITY_HIGH** = **2**
Description
-----------
@@ -48,19 +48,19 @@ A unit of execution in a process. Can run methods on :ref:`Object<class_Object>`
Method Descriptions
-------------------
.. _class_Thread_get_id:
.. _class_Thread_get_id:
- :ref:`String<class_String>` **get_id** **(** **)** const
Returns the current ``Thread``\ s id, uniquely identifying it among all threads.
.. _class_Thread_is_active:
.. _class_Thread_is_active:
- :ref:`bool<class_bool>` **is_active** **(** **)** const
Returns true if this ``Thread`` is currently active. An active ``Thread`` cannot start work on a new method but can be joined with :ref:`wait_to_finish<class_Thread_wait_to_finish>`.
.. _class_Thread_start:
.. _class_Thread_start:
- :ref:`Error<enum_@GlobalScope_Error>` **start** **(** :ref:`Object<class_Object>` instance, :ref:`String<class_String>` method, :ref:`Variant<class_Variant>` userdata=null, :ref:`int<class_int>` priority=1 **)**
@@ -68,10 +68,9 @@ Starts a new ``Thread`` that runs "method" on object "instance" with "userdata"
Returns OK on success, or ERR_CANT_CREATE on failure.
.. _class_Thread_wait_to_finish:
.. _class_Thread_wait_to_finish:
- :ref:`Variant<class_Variant>` **wait_to_finish** **(** **)**
Joins the ``Thread`` and waits for it to finish. Returns what the method called returned.