godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/StreamPeerExtension.xml

49 lines
1.6 KiB
XML
Raw Normal View History

[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 13:18:53 +00:00
<class name="StreamPeerExtension" inherits="StreamPeer" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="_get_available_bytes" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_data" qualifiers="virtual">
<return type="int" />
<argument index="0" name="r_buffer" type="uint8_t*" />
<argument index="1" name="r_bytes" type="int" />
<argument index="2" name="r_received" type="int32_t*" />
<description>
</description>
</method>
<method name="_get_partial_data" qualifiers="virtual">
<return type="int" />
<argument index="0" name="r_buffer" type="uint8_t*" />
<argument index="1" name="r_bytes" type="int" />
<argument index="2" name="r_received" type="int32_t*" />
<description>
</description>
</method>
<method name="_put_data" qualifiers="virtual">
<return type="int" />
Fix const pointers types in docs and extension API. The GDVIRTUAL_NATIVE_PTR did not declare the correct GDNativeConstPtr template, resulting in "void*" being used as it's type info in both the documentation and the extension API dump.
2021-09-29 12:27:57 +00:00
<argument index="0" name="p_data" type="const uint8_t*" />
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
<argument index="1" name="p_bytes" type="int" />
<argument index="2" name="r_sent" type="int32_t*" />
<description>
</description>
</method>
<method name="_put_partial_data" qualifiers="virtual">
<return type="int" />
Fix const pointers types in docs and extension API. The GDVIRTUAL_NATIVE_PTR did not declare the correct GDNativeConstPtr template, resulting in "void*" being used as it's type info in both the documentation and the extension API dump.
2021-09-29 12:27:57 +00:00
<argument index="0" name="p_data" type="const uint8_t*" />
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
<argument index="1" name="p_bytes" type="int" />
<argument index="2" name="r_sent" type="int32_t*" />
<description>
</description>
</method>
</methods>
</class>