nick/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-03-03 20:55:48 +00: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

20
modules/websocket/doc_classes/WebSocketClient.xml
View File

@@ -15,10 +15,10 @@
<methods>
<method name="connect_to_url">
<return type="int" enum="Error" />
<argument index="0" name="url" type="String" />
<argument index="1" name="protocols" type="PackedStringArray" default="PackedStringArray()" />
<argument index="2" name="gd_mp_api" type="bool" default="false" />
<argument index="3" name="custom_headers" type="PackedStringArray" default="PackedStringArray()" />
<param index="0" name="url" type="String" />
<param index="1" name="protocols" type="PackedStringArray" default="PackedStringArray()" />
<param index="2" name="gd_mp_api" type="bool" default="false" />
<param index="3" name="custom_headers" type="PackedStringArray" default="PackedStringArray()" />
<description>
Connects to the given URL requesting one of the given [code]protocols[/code] as sub-protocol. If the list empty (default), no sub-protocol will be requested.
If [code]true[/code] is passed as [code]gd_mp_api[/code], the client will behave like a multiplayer peer for the [MultiplayerAPI], connections to non-Godot servers will not work, and [signal data_received] will not be emitted.
@@ -30,8 +30,8 @@
</method>
<method name="disconnect_from_host">
<return type="void" />
<argument index="0" name="code" type="int" default="1000" />
<argument index="1" name="reason" type="String" default="&quot;&quot;" />
<param index="0" name="code" type="int" default="1000" />
<param index="1" name="reason" type="String" default="&quot;&quot;" />
<description>
Disconnects this client from the connected host. See [method WebSocketPeer.close] for more information.
</description>
@@ -61,7 +61,7 @@
</members>
<signals>
<signal name="connection_closed">
<argument index="0" name="was_clean_close" type="bool" />
<param index="0" name="was_clean_close" type="bool" />
<description>
Emitted when the connection to the server is closed. [code]was_clean_close[/code] will be [code]true[/code] if the connection was shutdown cleanly.
</description>
@@ -72,7 +72,7 @@
</description>
</signal>
<signal name="connection_established">
<argument index="0" name="protocol" type="String" />
<param index="0" name="protocol" type="String" />
<description>
Emitted when a connection with the server is established, [code]protocol[/code] will contain the sub-protocol agreed with the server.
</description>
@@ -84,8 +84,8 @@
</description>
</signal>
<signal name="server_close_request">
<argument index="0" name="code" type="int" />
<argument index="1" name="reason" type="String" />
<param index="0" name="code" type="int" />
<param index="1" name="reason" type="String" />
<description>
Emitted when the server requests a clean close. You should keep polling until you get a [signal connection_closed] signal to achieve the clean close. See [method WebSocketPeer.close] for more details.
</description>