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

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

8
doc/classes/PacketPeer.xml
View File

@@ -30,7 +30,7 @@
</method>
<method name="get_var">
<return type="Variant" />
<argument index="0" name="allow_objects" type="bool" default="false" />
<param index="0" name="allow_objects" type="bool" default="false" />
<description>
Gets a Variant. If [code]allow_objects[/code] is [code]true[/code], decoding objects is allowed.
[b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution.
@@ -38,15 +38,15 @@
</method>
<method name="put_packet">
<return type="int" enum="Error" />
<argument index="0" name="buffer" type="PackedByteArray" />
<param index="0" name="buffer" type="PackedByteArray" />
<description>
Sends a raw packet.
</description>
</method>
<method name="put_var">
<return type="int" enum="Error" />
<argument index="0" name="var" type="Variant" />
<argument index="1" name="full_objects" type="bool" default="false" />
<param index="0" name="var" type="Variant" />
<param index="1" name="full_objects" type="bool" default="false" />
<description>
Sends a [Variant] as a packet. If [code]full_objects[/code] is [code]true[/code], encoding objects is allowed (and can potentially include code).
</description>