godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-11-04 12:00:25 +00:00
Code Releases Wiki Activity

Doc: Add "required" qualifier to methods

Browse Source
This commit is contained in:
Haoyu Qiu
2025-06-05 11:11:08 +08:00
parent 445a51834e
commit 1ca5bc2d04
37 changed files with 758 additions and 1012 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
modules/webrtc/doc_classes/WebRTCDataChannelExtension.xml
View File

@@ -7,42 +7,42 @@
<tutorials>
</tutorials>
<methods>
<method name="_close" qualifiers="virtual">
<method name="_close" qualifiers="virtual required">
<return type="void" />
<description>
</description>
</method>
<method name="_get_available_packet_count" qualifiers="virtual const">
<method name="_get_available_packet_count" qualifiers="virtual required const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_buffered_amount" qualifiers="virtual const">
<method name="_get_buffered_amount" qualifiers="virtual required const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_id" qualifiers="virtual const">
<method name="_get_id" qualifiers="virtual required const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_label" qualifiers="virtual const">
<method name="_get_label" qualifiers="virtual required const">
<return type="String" />
<description>
</description>
</method>
<method name="_get_max_packet_life_time" qualifiers="virtual const">
<method name="_get_max_packet_life_time" qualifiers="virtual required const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_max_packet_size" qualifiers="virtual const">
<method name="_get_max_packet_size" qualifiers="virtual required const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_max_retransmits" qualifiers="virtual const">
<method name="_get_max_retransmits" qualifiers="virtual required const">
<return type="int" />
<description>
</description>
@@ -54,32 +54,32 @@
<description>
</description>
</method>
<method name="_get_protocol" qualifiers="virtual const">
<method name="_get_protocol" qualifiers="virtual required const">
<return type="String" />
<description>
</description>
</method>
<method name="_get_ready_state" qualifiers="virtual const">
<method name="_get_ready_state" qualifiers="virtual required const">
<return type="int" enum="WebRTCDataChannel.ChannelState" />
<description>
</description>
</method>
<method name="_get_write_mode" qualifiers="virtual const">
<method name="_get_write_mode" qualifiers="virtual required const">
<return type="int" enum="WebRTCDataChannel.WriteMode" />
<description>
</description>
</method>
<method name="_is_negotiated" qualifiers="virtual const">
<method name="_is_negotiated" qualifiers="virtual required const">
<return type="bool" />
<description>
</description>
</method>
<method name="_is_ordered" qualifiers="virtual const">
<method name="_is_ordered" qualifiers="virtual required const">
<return type="bool" />
<description>
</description>
</method>
<method name="_poll" qualifiers="virtual">
<method name="_poll" qualifiers="virtual required">
<return type="int" enum="Error" />
<description>
</description>
@@ -91,13 +91,13 @@
<description>
</description>
</method>
<method name="_set_write_mode" qualifiers="virtual">
<method name="_set_write_mode" qualifiers="virtual required">
<return type="void" />
<param index="0" name="p_write_mode" type="int" enum="WebRTCDataChannel.WriteMode" />
<description>
</description>
</method>
<method name="_was_string_packet" qualifiers="virtual const">
<method name="_was_string_packet" qualifiers="virtual required const">
<return type="bool" />
<description>
</description>

22
modules/webrtc/doc_classes/WebRTCPeerConnectionExtension.xml
View File

@@ -7,7 +7,7 @@
<tutorials>
</tutorials>
<methods>
<method name="_add_ice_candidate" qualifiers="virtual">
<method name="_add_ice_candidate" qualifiers="virtual required">
<return type="int" enum="Error" />
<param index="0" name="p_sdp_mid_name" type="String" />
<param index="1" name="p_sdp_mline_index" type="int" />
@@ -15,57 +15,57 @@
<description>
</description>
</method>
<method name="_close" qualifiers="virtual">
<method name="_close" qualifiers="virtual required">
<return type="void" />
<description>
</description>
</method>
<method name="_create_data_channel" qualifiers="virtual">
<method name="_create_data_channel" qualifiers="virtual required">
<return type="WebRTCDataChannel" />
<param index="0" name="p_label" type="String" />
<param index="1" name="p_config" type="Dictionary" />
<description>
</description>
</method>
<method name="_create_offer" qualifiers="virtual">
<method name="_create_offer" qualifiers="virtual required">
<return type="int" enum="Error" />
<description>
</description>
</method>
<method name="_get_connection_state" qualifiers="virtual const">
<method name="_get_connection_state" qualifiers="virtual required const">
<return type="int" enum="WebRTCPeerConnection.ConnectionState" />
<description>
</description>
</method>
<method name="_get_gathering_state" qualifiers="virtual const">
<method name="_get_gathering_state" qualifiers="virtual required const">
<return type="int" enum="WebRTCPeerConnection.GatheringState" />
<description>
</description>
</method>
<method name="_get_signaling_state" qualifiers="virtual const">
<method name="_get_signaling_state" qualifiers="virtual required const">
<return type="int" enum="WebRTCPeerConnection.SignalingState" />
<description>
</description>
</method>
<method name="_initialize" qualifiers="virtual">
<method name="_initialize" qualifiers="virtual required">
<return type="int" enum="Error" />
<param index="0" name="p_config" type="Dictionary" />
<description>
</description>
</method>
<method name="_poll" qualifiers="virtual">
<method name="_poll" qualifiers="virtual required">
<return type="int" enum="Error" />
<description>
</description>
</method>
<method name="_set_local_description" qualifiers="virtual">
<method name="_set_local_description" qualifiers="virtual required">
<return type="int" enum="Error" />
<param index="0" name="p_type" type="String" />
<param index="1" name="p_sdp" type="String" />
<description>
</description>
</method>
<method name="_set_remote_description" qualifiers="virtual">
<method name="_set_remote_description" qualifiers="virtual required">
<return type="int" enum="Error" />
<param index="0" name="p_type" type="String" />
<param index="1" name="p_sdp" type="String" />