godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-06 10:11:57 +03:00
Code Issues Packages Projects Releases Wiki Activity

doc: Use self-closing tags for return and argument

Browse Source 
For the time being we don't support writing a description for those, preferring
having all details in the method's description.

Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.

(cherry picked from commit 7adf4cc9b5)
This commit is contained in:
Rémi Verschelde
2021-07-30 15:28:05 +02:00
parent a43365bd58
commit f5836b40d4
356 changed files with 10841 additions and 21682 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
doc/classes/LineEdit.xml
View File

@@ -29,76 +29,61 @@
</tutorials>
<methods>
<method name="append_at_cursor">
<return type="void">
</return>
<argument index="0" name="text" type="String">
</argument>
<return type="void" />
<argument index="0" name="text" type="String" />
<description>
Adds [code]text[/code] after the cursor. If the resulting value is longer than [member max_length], nothing happens.
</description>
</method>
<method name="clear">
<return type="void">
</return>
<return type="void" />
<description>
Erases the [LineEdit]'s [member text].
</description>
</method>
<method name="delete_char_at_cursor">
<return type="void">
</return>
<return type="void" />
<description>
Deletes one character at the cursor's current position (equivalent to pressing the [code]Delete[/code] key).
</description>
</method>
<method name="delete_text">
<return type="void">
</return>
<argument index="0" name="from_column" type="int">
</argument>
<argument index="1" name="to_column" type="int">
</argument>
<return type="void" />
<argument index="0" name="from_column" type="int" />
<argument index="1" name="to_column" type="int" />
<description>
Deletes a section of the [member text] going from position [code]from_column[/code] to [code]to_column[/code]. Both parameters should be within the text's length.
</description>
</method>
<method name="deselect">
<return type="void">
</return>
<return type="void" />
<description>
Clears the current selection.
</description>
</method>
<method name="get_menu" qualifiers="const">
<return type="PopupMenu">
</return>
<return type="PopupMenu" />
<description>
Returns the [PopupMenu] of this [LineEdit]. By default, this menu is displayed when right-clicking on the [LineEdit].
</description>
</method>
<method name="get_scroll_offset" qualifiers="const">
<return type="int">
</return>
<return type="int" />
<description>
Returns the scroll offset due to [member caret_position], as a number of characters.
</description>
</method>
<method name="menu_option">
<return type="void">
</return>
<argument index="0" name="option" type="int">
</argument>
<return type="void" />
<argument index="0" name="option" type="int" />
<description>
Executes a given action as defined in the [enum MenuItems] enum.
</description>
</method>
<method name="select">
<return type="void">
</return>
<argument index="0" name="from" type="int" default="0">
</argument>
<argument index="1" name="to" type="int" default="-1">
</argument>
<return type="void" />
<argument index="0" name="from" type="int" default="0" />
<argument index="1" name="to" type="int" default="-1" />
<description>
Selects characters inside [LineEdit] between [code]from[/code] and [code]to[/code]. By default, [code]from[/code] is at the beginning and [code]to[/code] at the end.
[codeblock]
@@ -110,8 +95,7 @@
</description>
</method>
<method name="select_all">
<return type="void">
</return>
<return type="void" />
<description>
Selects the whole [String].
</description>
@@ -189,22 +173,19 @@
</members>
<signals>
<signal name="text_change_rejected">
<argument index="0" name="rejected_substring" type="String">
</argument>
<argument index="0" name="rejected_substring" type="String" />
<description>
Emitted when appending text that overflows the [member max_length]. The appended text is truncated to fit [member max_length], and the part that couldn't fit is passed as the [code]rejected_substring[/code] argument.
</description>
</signal>
<signal name="text_changed">
<argument index="0" name="new_text" type="String">
</argument>
<argument index="0" name="new_text" type="String" />
<description>
Emitted when the text changes.
</description>
</signal>
<signal name="text_entered">
<argument index="0" name="new_text" type="String">
</argument>
<argument index="0" name="new_text" type="String" />
<description>
Emitted when the user presses [constant KEY_ENTER] on the [LineEdit].
</description>