diff options
| author | Yuri Sizov <yuris@humnom.net> | 2022-08-06 21:11:48 +0300 |
|---|---|---|
| committer | Yuri Sizov <yuris@humnom.net> | 2022-08-08 22:34:31 +0300 |
| commit | c5d7115038de5f83cb83e08748615a84fc26bee2 (patch) | |
| tree | 13b9b42aac25f7769428ef91f637e260b768f25d /modules/websocket/doc_classes/WebSocketPeer.xml | |
| parent | 35c1eae8d70eb6ae49495339b95f89bcd084c3f2 (diff) | |
| download | redot-engine-c5d7115038de5f83cb83e08748615a84fc26bee2.tar.gz | |
Rename the argument tag to param in XML documentation
Diffstat (limited to 'modules/websocket/doc_classes/WebSocketPeer.xml')
| -rw-r--r-- | modules/websocket/doc_classes/WebSocketPeer.xml | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/modules/websocket/doc_classes/WebSocketPeer.xml b/modules/websocket/doc_classes/WebSocketPeer.xml index 6466654517..43b765d2fe 100644 --- a/modules/websocket/doc_classes/WebSocketPeer.xml +++ b/modules/websocket/doc_classes/WebSocketPeer.xml @@ -12,8 +12,8 @@ <methods> <method name="close"> <return type="void" /> - <argument index="0" name="code" type="int" default="1000" /> - <argument index="1" name="reason" type="String" default="""" /> + <param index="0" name="code" type="int" default="1000" /> + <param index="1" name="reason" type="String" default="""" /> <description> Closes this WebSocket connection. [code]code[/code] is the status code for the closure (see RFC 6455 section 7.4 for a list of valid status codes). [code]reason[/code] is the human readable reason for closing the connection (can be any UTF-8 string that's smaller than 123 bytes). [b]Note:[/b] To achieve a clean close, you will need to keep polling until either [signal WebSocketClient.connection_closed] or [signal WebSocketServer.client_disconnected] is received. @@ -54,7 +54,7 @@ </method> <method name="set_no_delay"> <return type="void" /> - <argument index="0" name="enabled" type="bool" /> + <param index="0" name="enabled" type="bool" /> <description> Disable Nagle's algorithm on the underling TCP socket (default). See [method StreamPeerTCP.set_no_delay] for more information. [b]Note:[/b] Not available in the HTML5 export. @@ -62,7 +62,7 @@ </method> <method name="set_write_mode"> <return type="void" /> - <argument index="0" name="mode" type="int" enum="WebSocketPeer.WriteMode" /> + <param index="0" name="mode" type="int" enum="WebSocketPeer.WriteMode" /> <description> Sets the socket to use the given [enum WriteMode]. </description> |