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,7 +8,9 @@ BoxContainer
============
**Inherits:** :ref:`Container<class_Container>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
**Inherited By:** :ref:`VBoxContainer<class_VBoxContainer>`, :ref:`HBoxContainer<class_HBoxContainer>`, :ref:`ColorPicker<class_ColorPicker>`
**Category:** Core
Brief Description
@@ -16,6 +18,13 @@ Brief Description
Base class for box containers.
Properties
----------
+-----------------------------------------------+------------------------------------------------+
| :ref:`AlignMode<enum_BoxContainer_AlignMode>` | :ref:`alignment<class_BoxContainer_alignment>` |
+-----------------------------------------------+------------------------------------------------+
Methods
-------
@@ -28,13 +37,12 @@ Enumerations
.. _enum_BoxContainer_AlignMode:
enum **AlignMode**
enum **AlignMode**:
- **ALIGN_BEGIN** = **0** --- Aligns children with the beginning of the container.
- **ALIGN_CENTER** = **1** --- Aligns children with the center of the container.
- **ALIGN_END** = **2** --- Aligns children with the end of the container.
Description
-----------
@@ -45,16 +53,22 @@ Property Descriptions
.. _class_BoxContainer_alignment:
- :ref:`AlignMode<enum_BoxContainer_AlignMode>` **alignment** - The alignment of the container's children (must be one of ALIGN_BEGIN, ALIGN_CENTER, or ALIGN_END).
- :ref:`AlignMode<enum_BoxContainer_AlignMode>` **alignment**
+----------+----------------------+
| *Setter* | set_alignment(value) |
+----------+----------------------+
| *Getter* | get_alignment() |
+----------+----------------------+
The alignment of the container's children (must be one of ALIGN_BEGIN, ALIGN_CENTER, or ALIGN_END).
Method Descriptions
-------------------
.. _class_BoxContainer_add_spacer:
.. _class_BoxContainer_add_spacer:
- void **add_spacer** **(** :ref:`bool<class_bool>` begin **)**
Adds a control to the box as a spacer. If ``true``, *begin* will insert the spacer control in front of other children.