Merge pull request #50203 from SirQuartz/docs

Add multiple descriptions to several classes
This commit is contained in:
Rémi Verschelde 2021-07-06 14:10:33 +02:00 committed by GitHub
commit d31cf83bb3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 10 additions and 0 deletions

View file

@ -547,6 +547,7 @@
<return type="void"> <return type="void">
</return> </return>
<description> <description>
Minimizes the bottom panel.
</description> </description>
</method> </method>
<method name="make_bottom_panel_item_visible"> <method name="make_bottom_panel_item_visible">
@ -555,6 +556,7 @@
<argument index="0" name="item" type="Control"> <argument index="0" name="item" type="Control">
</argument> </argument>
<description> <description>
Makes a specific item in the bottom panel visible.
</description> </description>
</method> </method>
<method name="queue_save_layout"> <method name="queue_save_layout">

View file

@ -169,6 +169,7 @@
The caret's column position inside the [LineEdit]. When set, the text may scroll to accommodate it. The caret's column position inside the [LineEdit]. When set, the text may scroll to accommodate it.
</member> </member>
<member name="caret_force_displayed" type="bool" setter="set_caret_force_displayed" getter="is_caret_force_displayed" default="false"> <member name="caret_force_displayed" type="bool" setter="set_caret_force_displayed" getter="is_caret_force_displayed" default="false">
If [code]true[/code], the [LineEdit] will always show the caret, even if focus is lost.
</member> </member>
<member name="caret_mid_grapheme" type="bool" setter="set_caret_mid_grapheme_enabled" getter="is_caret_mid_grapheme_enabled" default="false"> <member name="caret_mid_grapheme" type="bool" setter="set_caret_mid_grapheme_enabled" getter="is_caret_mid_grapheme_enabled" default="false">
Allow moving caret, selecting and removing the individual composite character components. Allow moving caret, selecting and removing the individual composite character components.

View file

@ -13,6 +13,7 @@
<members> <members>
<member name="borderless" type="bool" setter="set_flag" getter="get_flag" override="true" default="true" /> <member name="borderless" type="bool" setter="set_flag" getter="get_flag" override="true" default="true" />
<member name="close_on_parent_focus" type="bool" setter="set_close_on_parent_focus" getter="get_close_on_parent_focus" default="true"> <member name="close_on_parent_focus" type="bool" setter="set_close_on_parent_focus" getter="get_close_on_parent_focus" default="true">
If [code]true[/code], the [Popup] will close when its parent is focused.
</member> </member>
<member name="transient" type="bool" setter="set_transient" getter="is_transient" override="true" default="true" /> <member name="transient" type="bool" setter="set_transient" getter="is_transient" override="true" default="true" />
<member name="unresizable" type="bool" setter="set_flag" getter="get_flag" override="true" default="true" /> <member name="unresizable" type="bool" setter="set_flag" getter="get_flag" override="true" default="true" />

View file

@ -14,6 +14,7 @@
<return type="void"> <return type="void">
</return> </return>
<description> <description>
A virtual method that is called whenever backspace is triggered.
</description> </description>
</method> </method>
<method name="add_gutter"> <method name="add_gutter">
@ -28,6 +29,7 @@
<return type="void"> <return type="void">
</return> </return>
<description> <description>
Causes the [TextEdit] to perform a backspace.
</description> </description>
</method> </method>
<method name="center_viewport_to_cursor"> <method name="center_viewport_to_cursor">
@ -172,6 +174,7 @@
<argument index="0" name="line" type="int"> <argument index="0" name="line" type="int">
</argument> </argument>
<description> <description>
Returns the indent level of a specific line.
</description> </description>
</method> </method>
<method name="get_line" qualifiers="const"> <method name="get_line" qualifiers="const">
@ -312,6 +315,7 @@
<return type="int"> <return type="int">
</return> </return>
<description> <description>
Returns the [TextEdit]'s' tab size.
</description> </description>
</method> </method>
<method name="get_visible_line_count" qualifiers="const"> <method name="get_visible_line_count" qualifiers="const">
@ -667,6 +671,7 @@
<argument index="0" name="size" type="int"> <argument index="0" name="size" type="int">
</argument> </argument>
<description> <description>
Sets the tab size for the [TextEdit] to use.
</description> </description>
</method> </method>
<method name="undo"> <method name="undo">

View file

@ -294,6 +294,7 @@
<argument index="0" name="item" type="Object"> <argument index="0" name="item" type="Object">
</argument> </argument>
<description> <description>
Causes the [Tree] to jump to the specified item.
</description> </description>
</method> </method>
<method name="set_column_clip_content"> <method name="set_column_clip_content">