godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-05 06:11:29 +03:00
Code Issues Packages Projects Releases 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.

(cherry picked from commit 7adf4cc9b5)
This commit is contained in:
Rémi Verschelde
2021-07-30 15:28:05 +02:00
parent a43365bd58
commit f5836b40d4
356 changed files with 10841 additions and 21682 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml
View File

@@ -10,25 +10,18 @@
</tutorials>
<methods>
<method name="get_peer" qualifiers="const">
<return type="WebSocketPeer">
</return>
<argument index="0" name="peer_id" type="int">
</argument>
<return type="WebSocketPeer" />
<argument index="0" name="peer_id" type="int" />
<description>
Returns the [WebSocketPeer] associated to the given [code]peer_id[/code].
</description>
</method>
<method name="set_buffers">
<return type="int" enum="Error">
</return>
<argument index="0" name="input_buffer_size_kb" type="int">
</argument>
<argument index="1" name="input_max_packets" type="int">
</argument>
<argument index="2" name="output_buffer_size_kb" type="int">
</argument>
<argument index="3" name="output_max_packets" type="int">
</argument>
<return type="int" enum="Error" />
<argument index="0" name="input_buffer_size_kb" type="int" />
<argument index="1" name="input_max_packets" type="int" />
<argument index="2" name="output_buffer_size_kb" type="int" />
<argument index="3" name="output_max_packets" type="int" />
<description>
Configures the buffer sizes for this WebSocket peer. Default values can be specified in the Project Settings under [code]network/limits[/code]. For server, values are meant per connected peer.
The first two parameters define the size and queued packets limits of the input buffer, the last two of the output buffer.
@@ -43,8 +36,7 @@
</members>
<signals>
<signal name="peer_packet">
<argument index="0" name="peer_source" type="int">
</argument>
<argument index="0" name="peer_source" type="int" />
<description>
Emitted when a packet is received from a peer.
[b]Note:[/b] This signal is only emitted when the client or server is configured to use Godot multiplayer API.