From 2d810e8cd948f1e25e514986dc6f9a7cb7c52026 Mon Sep 17 00:00:00 2001
From: Fabio Alessandrelli <fabio.alessandrelli@gmail.com>
Date: Wed, 8 Sep 2021 01:50:22 +0200
Subject: [Net/Docs] Update extensions documentation.

---
 .../doc_classes/WebRTCDataChannelExtension.xml     | 106 +++++++++++++++++++++
 .../webrtc/doc_classes/WebRTCMultiplayerPeer.xml   |   4 -
 .../doc_classes/WebRTCPeerConnectionExtension.xml  |  71 ++++++++++++++
 3 files changed, 177 insertions(+), 4 deletions(-)
 create mode 100644 modules/webrtc/doc_classes/WebRTCDataChannelExtension.xml
 create mode 100644 modules/webrtc/doc_classes/WebRTCPeerConnectionExtension.xml

(limited to 'modules/webrtc/doc_classes')

diff --git a/modules/webrtc/doc_classes/WebRTCDataChannelExtension.xml b/modules/webrtc/doc_classes/WebRTCDataChannelExtension.xml
new file mode 100644
index 0000000000..26a4391b83
--- /dev/null
+++ b/modules/webrtc/doc_classes/WebRTCDataChannelExtension.xml
@@ -0,0 +1,106 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="WebRTCDataChannelExtension" inherits="WebRTCDataChannel" version="4.0">
+	<brief_description>
+	</brief_description>
+	<description>
+	</description>
+	<tutorials>
+	</tutorials>
+	<methods>
+		<method name="_close" qualifiers="virtual">
+			<return type="void" />
+			<description>
+			</description>
+		</method>
+		<method name="_get_available_packet_count" qualifiers="virtual const">
+			<return type="int" />
+			<description>
+			</description>
+		</method>
+		<method name="_get_buffered_amount" qualifiers="virtual const">
+			<return type="int" />
+			<description>
+			</description>
+		</method>
+		<method name="_get_id" qualifiers="virtual const">
+			<return type="int" />
+			<description>
+			</description>
+		</method>
+		<method name="_get_label" qualifiers="virtual const">
+			<return type="String" />
+			<description>
+			</description>
+		</method>
+		<method name="_get_max_packet_life_time" qualifiers="virtual const">
+			<return type="int" />
+			<description>
+			</description>
+		</method>
+		<method name="_get_max_packet_size" qualifiers="virtual const">
+			<return type="int" />
+			<description>
+			</description>
+		</method>
+		<method name="_get_max_retransmits" qualifiers="virtual const">
+			<return type="int" />
+			<description>
+			</description>
+		</method>
+		<method name="_get_packet" qualifiers="virtual">
+			<return type="int" />
+			<argument index="0" name="r_buffer" type="const void*" />
+			<argument index="1" name="r_buffer_size" type="int32_t*" />
+			<description>
+			</description>
+		</method>
+		<method name="_get_protocol" qualifiers="virtual const">
+			<return type="String" />
+			<description>
+			</description>
+		</method>
+		<method name="_get_ready_state" qualifiers="virtual const">
+			<return type="int" />
+			<description>
+			</description>
+		</method>
+		<method name="_get_write_mode" qualifiers="virtual const">
+			<return type="int" />
+			<description>
+			</description>
+		</method>
+		<method name="_is_negotiated" qualifiers="virtual const">
+			<return type="bool" />
+			<description>
+			</description>
+		</method>
+		<method name="_is_ordered" qualifiers="virtual const">
+			<return type="bool" />
+			<description>
+			</description>
+		</method>
+		<method name="_poll" qualifiers="virtual">
+			<return type="int" />
+			<description>
+			</description>
+		</method>
+		<method name="_put_packet" qualifiers="virtual">
+			<return type="int" />
+			<argument index="0" name="p_buffer" type="const void*" />
+			<argument index="1" name="p_buffer_size" type="int" />
+			<description>
+			</description>
+		</method>
+		<method name="_set_write_mode" qualifiers="virtual">
+			<return type="void" />
+			<argument index="0" name="p_write_mode" type="int" />
+			<description>
+			</description>
+		</method>
+		<method name="_was_string_packet" qualifiers="virtual const">
+			<return type="bool" />
+			<description>
+			</description>
+		</method>
+	</methods>
+</class>
diff --git a/modules/webrtc/doc_classes/WebRTCMultiplayerPeer.xml b/modules/webrtc/doc_classes/WebRTCMultiplayerPeer.xml
index 9040d510c0..1fb20f1377 100644
--- a/modules/webrtc/doc_classes/WebRTCMultiplayerPeer.xml
+++ b/modules/webrtc/doc_classes/WebRTCMultiplayerPeer.xml
@@ -67,8 +67,4 @@
 			</description>
 		</method>
 	</methods>
-	<members>
-		<member name="refuse_new_connections" type="bool" setter="set_refuse_new_connections" getter="is_refusing_new_connections" override="true" default="false" />
-		<member name="transfer_mode" type="int" setter="set_transfer_mode" getter="get_transfer_mode" override="true" enum="TransferMode" default="2" />
-	</members>
 </class>
diff --git a/modules/webrtc/doc_classes/WebRTCPeerConnectionExtension.xml b/modules/webrtc/doc_classes/WebRTCPeerConnectionExtension.xml
new file mode 100644
index 0000000000..d296fcd6e7
--- /dev/null
+++ b/modules/webrtc/doc_classes/WebRTCPeerConnectionExtension.xml
@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="WebRTCPeerConnectionExtension" inherits="WebRTCPeerConnection" version="4.0">
+	<brief_description>
+	</brief_description>
+	<description>
+	</description>
+	<tutorials>
+	</tutorials>
+	<methods>
+		<method name="_add_ice_candidate" qualifiers="virtual">
+			<return type="int" />
+			<argument index="0" name="p_sdp_mid_name" type="String" />
+			<argument index="1" name="p_sdp_mline_index" type="int" />
+			<argument index="2" name="p_sdp_name" type="String" />
+			<description>
+			</description>
+		</method>
+		<method name="_close" qualifiers="virtual">
+			<return type="void" />
+			<description>
+			</description>
+		</method>
+		<method name="_create_data_channel" qualifiers="virtual">
+			<return type="Object" />
+			<argument index="0" name="p_label" type="String" />
+			<argument index="1" name="p_config" type="Dictionary" />
+			<description>
+			</description>
+		</method>
+		<method name="_create_offer" qualifiers="virtual">
+			<return type="int" />
+			<description>
+			</description>
+		</method>
+		<method name="_get_connection_state" qualifiers="virtual const">
+			<return type="int" />
+			<description>
+			</description>
+		</method>
+		<method name="_initialize" qualifiers="virtual">
+			<return type="int" />
+			<argument index="0" name="p_config" type="Dictionary" />
+			<description>
+			</description>
+		</method>
+		<method name="_poll" qualifiers="virtual">
+			<return type="int" />
+			<description>
+			</description>
+		</method>
+		<method name="_set_local_description" qualifiers="virtual">
+			<return type="int" />
+			<argument index="0" name="p_type" type="String" />
+			<argument index="1" name="p_sdp" type="String" />
+			<description>
+			</description>
+		</method>
+		<method name="_set_remote_description" qualifiers="virtual">
+			<return type="int" />
+			<argument index="0" name="p_type" type="String" />
+			<argument index="1" name="p_sdp" type="String" />
+			<description>
+			</description>
+		</method>
+		<method name="make_default">
+			<return type="void" />
+			<description>
+			</description>
+		</method>
+	</methods>
+</class>
-- 
cgit v1.2.3