hertog/godot-module-template
Template
2
1
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

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

12
modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml
View file

@ -12,17 +12,17 @@
<methods>
<method name="get_peer" qualifiers="const">
<return type="WebSocketPeer" />
<argument index="0" name="peer_id" type="int" />
<param 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" />
<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" />
<param index="0" name="input_buffer_size_kb" type="int" />
<param index="1" name="input_max_packets" type="int" />
<param index="2" name="output_buffer_size_kb" type="int" />
<param 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.
@ -33,7 +33,7 @@
</methods>
<signals>
<signal name="peer_packet">
<argument index="0" name="peer_source" type="int" />
<param 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.