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

Rename the argument tag to param in XML documentation

Browse Source
This commit is contained in:
Yuri Sizov
2022-08-06 21:11:48 +03:00
parent 35c1eae8d7
commit c5d7115038
432 changed files with 10529 additions and 10529 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/classes/AcceptDialog.xml
View File

@@ -11,9 +11,9 @@
<methods>
<method name="add_button">
<return type="Button" />
<argument index="0" name="text" type="String" />
<argument index="1" name="right" type="bool" default="false" />
<argument index="2" name="action" type="String" default="&quot;&quot;" />
<param index="0" name="text" type="String" />
<param index="1" name="right" type="bool" default="false" />
<param index="2" name="action" type="String" default="&quot;&quot;" />
<description>
Adds a button with label [code]text[/code] and a custom [code]action[/code] to the dialog and returns the created button. [code]action[/code] will be passed to the [signal custom_action] signal when pressed.
If [code]true[/code], [code]right[/code] will place the button to the right of any sibling buttons.
@@ -22,7 +22,7 @@
</method>
<method name="add_cancel_button">
<return type="Button" />
<argument index="0" name="name" type="String" />
<param index="0" name="name" type="String" />
<description>
Adds a button with label [code]name[/code] and a cancel action to the dialog and returns the created button.
You can use [method remove_button] method to remove a button created with this method from the dialog.
@@ -44,14 +44,14 @@
</method>
<method name="register_text_enter">
<return type="void" />
<argument index="0" name="line_edit" type="Control" />
<param index="0" name="line_edit" type="Control" />
<description>
Registers a [LineEdit] in the dialog. When the enter key is pressed, the dialog will be accepted.
</description>
</method>
<method name="remove_button">
<return type="void" />
<argument index="0" name="button" type="Control" />
<param index="0" name="button" type="Control" />
<description>
Removes the [code]button[/code] from the dialog. Does NOT free the [code]button[/code]. The [code]button[/code] must be a [Button] added with [method add_button] or [method add_cancel_button] method. After removal, pressing the [code]button[/code] will no longer emit this dialog's [signal custom_action] or [signal cancelled] signals.
</description>
@@ -92,7 +92,7 @@
</description>
</signal>
<signal name="custom_action">
<argument index="0" name="action" type="StringName" />
<param index="0" name="action" type="StringName" />
<description>
Emitted when a custom button is pressed. See [method add_button].
</description>