Skip to content

Commit

Permalink
[doc] Use "param" instead of "code" to refer to parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
@asmaloney @YuriSizov
asmaloney authored and YuriSizov committed Aug 11, 2022
1 parent e9e9e92 commit 2d54c36
Show file tree
Hide file tree
Showing 27 changed files with 373 additions and 373 deletions.
8 changes: 4 additions & 4 deletions doc/classes/TCPServer.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@
<param index="0" name="port" type="int" />
<param index="1" name="bind_address" type="String" default="&quot;*&quot;" />
<description>
Listen on the [code]port[/code] binding to [code]bind_address[/code].
If [code]bind_address[/code] is set as [code]"*"[/code] (default), the server will listen on all available addresses (both IPv4 and IPv6).
If [code]bind_address[/code] is set as [code]"0.0.0.0"[/code] (for IPv4) or [code]"::"[/code] (for IPv6), the server will listen on all available addresses matching that IP type.
If [code]bind_address[/code] is set to any valid address (e.g. [code]"192.168.1.101"[/code], [code]"::1"[/code], etc), the server will only listen on the interface with that addresses (or fail if no interface with the given address exists).
Listen on the [param port] binding to [param bind_address].
If [param bind_address] is set as [code]"*"[/code] (default), the server will listen on all available addresses (both IPv4 and IPv6).
If [param bind_address] is set as [code]"0.0.0.0"[/code] (for IPv4) or [code]"::"[/code] (for IPv6), the server will listen on all available addresses matching that IP type.
If [param bind_address] is set to any valid address (e.g. [code]"192.168.1.101"[/code], [code]"::1"[/code], etc), the server will only listen on the interface with that addresses (or fail if no interface with the given address exists).
</description>
</method>
<method name="stop">
Expand Down
26 changes: 13 additions & 13 deletions doc/classes/TabBar.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,21 +40,21 @@
<return type="Texture2D" />
<param index="0" name="tab_idx" type="int" />
<description>
Returns the [Texture2D] for the right button of the tab at index [code]tab_idx[/code] or [code]null[/code] if the button has no [Texture2D].
Returns the [Texture2D] for the right button of the tab at index [param tab_idx] or [code]null[/code] if the button has no [Texture2D].
</description>
</method>
<method name="get_tab_icon" qualifiers="const">
<return type="Texture2D" />
<param index="0" name="tab_idx" type="int" />
<description>
Returns the [Texture2D] for the tab at index [code]tab_idx[/code] or [code]null[/code] if the tab has no [Texture2D].
Returns the [Texture2D] for the tab at index [param tab_idx] or [code]null[/code] if the tab has no [Texture2D].
</description>
</method>
<method name="get_tab_idx_at_point" qualifiers="const">
<return type="int" />
<param index="0" name="point" type="Vector2" />
<description>
Returns the index of the tab at local coordinates [code]point[/code]. Returns [code]-1[/code] if the point is outside the control boundaries or if there's no tab at the queried position.
Returns the index of the tab at local coordinates [param point]. Returns [code]-1[/code] if the point is outside the control boundaries or if there's no tab at the queried position.
</description>
</method>
<method name="get_tab_language" qualifiers="const">
Expand Down Expand Up @@ -88,68 +88,68 @@
<return type="String" />
<param index="0" name="tab_idx" type="int" />
<description>
Returns the title of the tab at index [code]tab_idx[/code].
Returns the title of the tab at index [param tab_idx].
</description>
</method>
<method name="is_tab_disabled" qualifiers="const">
<return type="bool" />
<param index="0" name="tab_idx" type="int" />
<description>
Returns [code]true[/code] if the tab at index [code]tab_idx[/code] is disabled.
Returns [code]true[/code] if the tab at index [param tab_idx] is disabled.
</description>
</method>
<method name="is_tab_hidden" qualifiers="const">
<return type="bool" />
<param index="0" name="tab_idx" type="int" />
<description>
Returns [code]true[/code] if the tab at index [code]tab_idx[/code] is hidden.
Returns [code]true[/code] if the tab at index [param tab_idx] is hidden.
</description>
</method>
<method name="move_tab">
<return type="void" />
<param index="0" name="from" type="int" />
<param index="1" name="to" type="int" />
<description>
Moves a tab from [code]from[/code] to [code]to[/code].
Moves a tab from [param from] to [param to].
</description>
</method>
<method name="remove_tab">
<return type="void" />
<param index="0" name="tab_idx" type="int" />
<description>
Removes the tab at index [code]tab_idx[/code].
Removes the tab at index [param tab_idx].
</description>
</method>
<method name="set_tab_button_icon">
<return type="void" />
<param index="0" name="tab_idx" type="int" />
<param index="1" name="icon" type="Texture2D" />
<description>
Sets an [code]icon[/code] for the button of the tab at index [code]tab_idx[/code] (located to the right, before the close button), making it visible and clickable (See [signal tab_button_pressed]). Giving it a [code]null[/code] value will hide the button.
Sets an [param icon] for the button of the tab at index [param tab_idx] (located to the right, before the close button), making it visible and clickable (See [signal tab_button_pressed]). Giving it a [code]null[/code] value will hide the button.
</description>
</method>
<method name="set_tab_disabled">
<return type="void" />
<param index="0" name="tab_idx" type="int" />
<param index="1" name="disabled" type="bool" />
<description>
If [code]disabled[/code] is [code]true[/code], disables the tab at index [code]tab_idx[/code], making it non-interactable.
If [param disabled] is [code]true[/code], disables the tab at index [param tab_idx], making it non-interactable.
</description>
</method>
<method name="set_tab_hidden">
<return type="void" />
<param index="0" name="tab_idx" type="int" />
<param index="1" name="hidden" type="bool" />
<description>
If [code]hidden[/code] is [code]true[/code], hides the tab at index [code]tab_idx[/code], making it disappear from the tab area.
If [param hidden] is [code]true[/code], hides the tab at index [param tab_idx], making it disappear from the tab area.
</description>
</method>
<method name="set_tab_icon">
<return type="void" />
<param index="0" name="tab_idx" type="int" />
<param index="1" name="icon" type="Texture2D" />
<description>
Sets an [code]icon[/code] for the tab at index [code]tab_idx[/code].
Sets an [param icon] for the tab at index [param tab_idx].
</description>
</method>
<method name="set_tab_language">
Expand All @@ -173,7 +173,7 @@
<param index="0" name="tab_idx" type="int" />
<param index="1" name="title" type="String" />
<description>
Sets a [code]title[/code] for the tab at index [code]tab_idx[/code].
Sets a [param title] for the tab at index [param tab_idx].
</description>
</method>
</methods>
Expand Down
26 changes: 13 additions & 13 deletions doc/classes/TabContainer.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,14 @@
<return type="Texture2D" />
<param index="0" name="tab_idx" type="int" />
<description>
Returns the button icon from the tab at index [code]tab_idx[/code].
Returns the button icon from the tab at index [param tab_idx].
</description>
</method>
<method name="get_tab_control" qualifiers="const">
<return type="Control" />
<param index="0" name="tab_idx" type="int" />
<description>
Returns the [Control] node from the tab at index [code]tab_idx[/code].
Returns the [Control] node from the tab at index [param tab_idx].
</description>
</method>
<method name="get_tab_count" qualifiers="const">
Expand All @@ -55,42 +55,42 @@
<return type="Texture2D" />
<param index="0" name="tab_idx" type="int" />
<description>
Returns the [Texture2D] for the tab at index [code]tab_idx[/code] or [code]null[/code] if the tab has no [Texture2D].
Returns the [Texture2D] for the tab at index [param tab_idx] or [code]null[/code] if the tab has no [Texture2D].
</description>
</method>
<method name="get_tab_idx_at_point" qualifiers="const">
<return type="int" />
<param index="0" name="point" type="Vector2" />
<description>
Returns the index of the tab at local coordinates [code]point[/code]. Returns [code]-1[/code] if the point is outside the control boundaries or if there's no tab at the queried position.
Returns the index of the tab at local coordinates [param point]. Returns [code]-1[/code] if the point is outside the control boundaries or if there's no tab at the queried position.
</description>
</method>
<method name="get_tab_idx_from_control" qualifiers="const">
<return type="int" />
<param index="0" name="control" type="Control" />
<description>
Returns the index of the tab tied to the given [code]control[/code]. The control must be a child of the [TabContainer].
Returns the index of the tab tied to the given [param control]. The control must be a child of the [TabContainer].
</description>
</method>
<method name="get_tab_title" qualifiers="const">
<return type="String" />
<param index="0" name="tab_idx" type="int" />
<description>
Returns the title of the tab at index [code]tab_idx[/code]. Tab titles default to the name of the indexed child node, but this can be overridden with [method set_tab_title].
Returns the title of the tab at index [param tab_idx]. Tab titles default to the name of the indexed child node, but this can be overridden with [method set_tab_title].
</description>
</method>
<method name="is_tab_disabled" qualifiers="const">
<return type="bool" />
<param index="0" name="tab_idx" type="int" />
<description>
Returns [code]true[/code] if the tab at index [code]tab_idx[/code] is disabled.
Returns [code]true[/code] if the tab at index [param tab_idx] is disabled.
</description>
</method>
<method name="is_tab_hidden" qualifiers="const">
<return type="bool" />
<param index="0" name="tab_idx" type="int" />
<description>
Returns [code]true[/code] if the tab at index [code]tab_idx[/code] is hidden.
Returns [code]true[/code] if the tab at index [param tab_idx] is hidden.
</description>
</method>
<method name="set_popup">
Expand All @@ -105,39 +105,39 @@
<param index="0" name="tab_idx" type="int" />
<param index="1" name="icon" type="Texture2D" />
<description>
Sets the button icon from the tab at index [code]tab_idx[/code].
Sets the button icon from the tab at index [param tab_idx].
</description>
</method>
<method name="set_tab_disabled">
<return type="void" />
<param index="0" name="tab_idx" type="int" />
<param index="1" name="disabled" type="bool" />
<description>
If [code]disabled[/code] is [code]true[/code], disables the tab at index [code]tab_idx[/code], making it non-interactable.
If [param disabled] is [code]true[/code], disables the tab at index [param tab_idx], making it non-interactable.
</description>
</method>
<method name="set_tab_hidden">
<return type="void" />
<param index="0" name="tab_idx" type="int" />
<param index="1" name="hidden" type="bool" />
<description>
If [code]hidden[/code] is [code]true[/code], hides the tab at index [code]tab_idx[/code], making it disappear from the tab area.
If [param hidden] is [code]true[/code], hides the tab at index [param tab_idx], making it disappear from the tab area.
</description>
</method>
<method name="set_tab_icon">
<return type="void" />
<param index="0" name="tab_idx" type="int" />
<param index="1" name="icon" type="Texture2D" />
<description>
Sets an icon for the tab at index [code]tab_idx[/code].
Sets an icon for the tab at index [param tab_idx].
</description>
</method>
<method name="set_tab_title">
<return type="void" />
<param index="0" name="tab_idx" type="int" />
<param index="1" name="title" type="String" />
<description>
Sets a custom title for the tab at index [code]tab_idx[/code] (tab titles default to the name of the indexed child node). Set it back to the child's name to make the tab default to it again.
Sets a custom title for the tab at index [param tab_idx] (tab titles default to the name of the indexed child node). Set it back to the child's name to make the tab default to it again.
</description>
</method>
</methods>
Expand Down
Loading

0 comments on commit 2d54c36

Please sign in to comment.