noahbackus/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

doc: Use self-closing tags for return and argument

Browse Source 
For the time being we don't support writing a description for those, preferring
having all details in the method's description.

Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
This commit is contained in:
Rémi Verschelde
2021-07-30 15:28:05 +02:00
parent a1c19b9a1e
commit 7adf4cc9b5
408 changed files with 14025 additions and 28050 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
modules/websocket/doc_classes/WebSocketServer.xml
View File

@@ -12,61 +12,46 @@
</tutorials>
<methods>
<method name="disconnect_peer">
<return type="void">
</return>
<argument index="0" name="id" type="int">
</argument>
<argument index="1" name="code" type="int" default="1000">
</argument>
<argument index="2" name="reason" type="String" default="&quot;&quot;">
</argument>
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="code" type="int" default="1000" />
<argument index="2" name="reason" type="String" default="&quot;&quot;" />
<description>
Disconnects the peer identified by [code]id[/code] from the server. See [method WebSocketPeer.close] for more information.
</description>
</method>
<method name="get_peer_address" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="id" type="int">
</argument>
<return type="String" />
<argument index="0" name="id" type="int" />
<description>
Returns the IP address of the given peer.
</description>
</method>
<method name="get_peer_port" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="id" type="int">
</argument>
<return type="int" />
<argument index="0" name="id" type="int" />
<description>
Returns the remote port of the given peer.
</description>
</method>
<method name="has_peer" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="id" type="int">
</argument>
<return type="bool" />
<argument index="0" name="id" type="int" />
<description>
Returns [code]true[/code] if a peer with the given ID is connected.
</description>
</method>
<method name="is_listening" qualifiers="const">
<return type="bool">
</return>
<return type="bool" />
<description>
Returns [code]true[/code] if the server is actively listening on a port.
</description>
</method>
<method name="listen">
<return type="int" enum="Error">
</return>
<argument index="0" name="port" type="int">
</argument>
<argument index="1" name="protocols" type="PackedStringArray" default="PackedStringArray()">
</argument>
<argument index="2" name="gd_mp_api" type="bool" default="false">
</argument>
<return type="int" enum="Error" />
<argument index="0" name="port" type="int" />
<argument index="1" name="protocols" type="PackedStringArray" default="PackedStringArray()" />
<argument index="2" name="gd_mp_api" type="bool" default="false" />
<description>
Starts listening on the given port.
You can specify the desired subprotocols via the "protocols" array. If the list empty (default), no sub-protocol will be requested.
@@ -75,8 +60,7 @@
</description>
</method>
<method name="stop">
<return type="void">
</return>
<return type="void" />
<description>
Stops the server and clear its state.
</description>
@@ -101,40 +85,31 @@
</members>
<signals>
<signal name="client_close_request">
<argument index="0" name="id" type="int">
</argument>
<argument index="1" name="code" type="int">
</argument>
<argument index="2" name="reason" type="String">
</argument>
<argument index="0" name="id" type="int" />
<argument index="1" name="code" type="int" />
<argument index="2" name="reason" type="String" />
<description>
Emitted when a client requests a clean close. You should keep polling until you get a [signal client_disconnected] signal with the same [code]id[/code] to achieve the clean close. See [method WebSocketPeer.close] for more details.
</description>
</signal>
<signal name="client_connected">
<argument index="0" name="id" type="int">
</argument>
<argument index="1" name="protocol" type="String">
</argument>
<argument index="2" name="resource_name" type="String">
</argument>
<argument index="0" name="id" type="int" />
<argument index="1" name="protocol" type="String" />
<argument index="2" name="resource_name" type="String" />
<description>
Emitted when a new client connects. "protocol" will be the sub-protocol agreed with the client, and "resource_name" will be the resource name of the URI the peer used.
"resource_name" is a path (at the very least a single forward slash) and potentially a query string.
</description>
</signal>
<signal name="client_disconnected">
<argument index="0" name="id" type="int">
</argument>
<argument index="1" name="was_clean_close" type="bool">
</argument>
<argument index="0" name="id" type="int" />
<argument index="1" name="was_clean_close" type="bool" />
<description>
Emitted when a client disconnects. [code]was_clean_close[/code] will be [code]true[/code] if the connection was shutdown cleanly.
</description>
</signal>
<signal name="data_received">
<argument index="0" name="id" type="int">
</argument>
<argument index="0" name="id" type="int" />
<description>
Emitted when a new message is received.
[b]Note:[/b] This signal is [i]not[/i] emitted when used as high-level multiplayer peer.