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

62
doc/classes/OptionButton.xml
View File

@@ -13,24 +13,24 @@
<methods>
<method name="add_icon_item">
<return type="void" />
<argument index="0" name="texture" type="Texture2D" />
<argument index="1" name="label" type="String" />
<argument index="2" name="id" type="int" default="-1" />
<param index="0" name="texture" type="Texture2D" />
<param index="1" name="label" type="String" />
<param index="2" name="id" type="int" default="-1" />
<description>
Adds an item, with a [code]texture[/code] icon, text [code]label[/code] and (optionally) [code]id[/code]. If no [code]id[/code] is passed, the item index will be used as the item's ID. New items are appended at the end.
</description>
</method>
<method name="add_item">
<return type="void" />
<argument index="0" name="label" type="String" />
<argument index="1" name="id" type="int" default="-1" />
<param index="0" name="label" type="String" />
<param index="1" name="id" type="int" default="-1" />
<description>
Adds an item, with text [code]label[/code] and (optionally) [code]id[/code]. If no [code]id[/code] is passed, the item index will be used as the item's ID. New items are appended at the end.
</description>
</method>
<method name="add_separator">
<return type="void" />
<argument index="0" name="text" type="String" default="&quot;&quot;" />
<param index="0" name="text" type="String" default="&quot;&quot;" />
<description>
Adds a separator to the list of items. Separators help to group items, and can optionally be given a [code]text[/code] header. A separator also gets an index assigned, and is appended at the end of the item list.
</description>
@@ -43,42 +43,42 @@
</method>
<method name="get_item_icon" qualifiers="const">
<return type="Texture2D" />
<argument index="0" name="idx" type="int" />
<param index="0" name="idx" type="int" />
<description>
Returns the icon of the item at index [code]idx[/code].
</description>
</method>
<method name="get_item_id" qualifiers="const">
<return type="int" />
<argument index="0" name="idx" type="int" />
<param index="0" name="idx" type="int" />
<description>
Returns the ID of the item at index [code]idx[/code].
</description>
</method>
<method name="get_item_index" qualifiers="const">
<return type="int" />
<argument index="0" name="id" type="int" />
<param index="0" name="id" type="int" />
<description>
Returns the index of the item with the given [code]id[/code].
</description>
</method>
<method name="get_item_metadata" qualifiers="const">
<return type="Variant" />
<argument index="0" name="idx" type="int" />
<param index="0" name="idx" type="int" />
<description>
Retrieves the metadata of an item. Metadata may be any type and can be used to store extra information about an item, such as an external string ID.
</description>
</method>
<method name="get_item_text" qualifiers="const">
<return type="String" />
<argument index="0" name="idx" type="int" />
<param index="0" name="idx" type="int" />
<description>
Returns the text of the item at index [code]idx[/code].
</description>
</method>
<method name="get_item_tooltip" qualifiers="const">
<return type="String" />
<argument index="0" name="idx" type="int" />
<param index="0" name="idx" type="int" />
<description>
Returns the tooltip of the item at index [code]idx[/code].
</description>
@@ -92,7 +92,7 @@
</method>
<method name="get_selectable_item" qualifiers="const">
<return type="int" />
<argument index="0" name="from_last" type="bool" default="false" />
<param index="0" name="from_last" type="bool" default="false" />
<description>
</description>
</method>
@@ -115,27 +115,27 @@
</method>
<method name="is_item_disabled" qualifiers="const">
<return type="bool" />
<argument index="0" name="idx" type="int" />
<param index="0" name="idx" type="int" />
<description>
Returns [code]true[/code] if the item at index [code]idx[/code] is disabled.
</description>
</method>
<method name="is_item_separator" qualifiers="const">
<return type="bool" />
<argument index="0" name="idx" type="int" />
<param index="0" name="idx" type="int" />
<description>
</description>
</method>
<method name="remove_item">
<return type="void" />
<argument index="0" name="idx" type="int" />
<param index="0" name="idx" type="int" />
<description>
Removes the item at index [code]idx[/code].
</description>
</method>
<method name="select">
<return type="void" />
<argument index="0" name="idx" type="int" />
<param index="0" name="idx" type="int" />
<description>
Selects an item by index and makes it the current item. This will work even if the item is disabled.
Passing [code]-1[/code] as the index deselects any currently selected item.
@@ -143,8 +143,8 @@
</method>
<method name="set_item_disabled">
<return type="void" />
<argument index="0" name="idx" type="int" />
<argument index="1" name="disabled" type="bool" />
<param index="0" name="idx" type="int" />
<param index="1" name="disabled" type="bool" />
<description>
Sets whether the item at index [code]idx[/code] is disabled.
Disabled items are drawn differently in the dropdown and are not selectable by the user. If the current selected item is set as disabled, it will remain selected.
@@ -152,40 +152,40 @@
</method>
<method name="set_item_icon">
<return type="void" />
<argument index="0" name="idx" type="int" />
<argument index="1" name="texture" type="Texture2D" />
<param index="0" name="idx" type="int" />
<param index="1" name="texture" type="Texture2D" />
<description>
Sets the icon of the item at index [code]idx[/code].
</description>
</method>
<method name="set_item_id">
<return type="void" />
<argument index="0" name="idx" type="int" />
<argument index="1" name="id" type="int" />
<param index="0" name="idx" type="int" />
<param index="1" name="id" type="int" />
<description>
Sets the ID of the item at index [code]idx[/code].
</description>
</method>
<method name="set_item_metadata">
<return type="void" />
<argument index="0" name="idx" type="int" />
<argument index="1" name="metadata" type="Variant" />
<param index="0" name="idx" type="int" />
<param index="1" name="metadata" type="Variant" />
<description>
Sets the metadata of an item. Metadata may be of any type and can be used to store extra information about an item, such as an external string ID.
</description>
</method>
<method name="set_item_text">
<return type="void" />
<argument index="0" name="idx" type="int" />
<argument index="1" name="text" type="String" />
<param index="0" name="idx" type="int" />
<param index="1" name="text" type="String" />
<description>
Sets the text of the item at index [code]idx[/code].
</description>
</method>
<method name="set_item_tooltip">
<return type="void" />
<argument index="0" name="idx" type="int" />
<argument index="1" name="tooltip" type="String" />
<param index="0" name="idx" type="int" />
<param index="1" name="tooltip" type="String" />
<description>
Sets the tooltip of the item at index [code]idx[/code].
</description>
@@ -208,13 +208,13 @@
</members>
<signals>
<signal name="item_focused">
<argument index="0" name="index" type="int" />
<param index="0" name="index" type="int" />
<description>
Emitted when the user navigates to an item using the [code]ui_up[/code] or [code]ui_down[/code] actions. The index of the item selected is passed as argument.
</description>
</signal>
<signal name="item_selected">
<argument index="0" name="index" type="int" />
<param index="0" name="index" type="int" />
<description>
Emitted when the current item has been changed by the user. The index of the item selected is passed as argument.
</description>