Document websocket module, further document enet

4 files changed, 4 insertions, 177 deletions

diff --git a/doc/classes/WebSocketClient.xml b/doc/classes/WebSocketClient.xml
deleted file mode 100644
index 496baa578..000000000
--- a/doc/classes/WebSocketClient.xml
+++ /dev/null
@@ -1,57 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<class name="WebSocketClient" inherits="WebSocketMultiplayerPeer" category="Core" version="3.1">
-	<brief_description>
-	</brief_description>
-	<description>
-	</description>
-	<tutorials>
-	</tutorials>
-	<demos>
-	</demos>
-	<methods>
-		<method name="connect_to_url">
-			<return type="int" enum="Error">
-			</return>
-			<argument index="0" name="url" type="String">
-			</argument>
-			<argument index="1" name="protocols" type="PoolStringArray" default="PoolStringArray(  )">
-			</argument>
-			<argument index="2" name="gd_mp_api" type="bool" default="false">
-			</argument>
-			<description>
-			</description>
-		</method>
-		<method name="disconnect_from_host">
-			<return type="void">
-			</return>
-			<description>
-			</description>
-		</method>
-	</methods>
-	<members>
-		<member name="verify_ssl" type="bool" setter="set_verify_ssl_enabled" getter="is_verify_ssl_enabled">
-		</member>
-	</members>
-	<signals>
-		<signal name="connection_closed">
-			<description>
-			</description>
-		</signal>
-		<signal name="connection_error">
-			<description>
-			</description>
-		</signal>
-		<signal name="connection_established">
-			<argument index="0" name="protocol" type="String">
-			</argument>
-			<description>
-			</description>
-		</signal>
-		<signal name="data_received">
-			<description>
-			</description>
-		</signal>
-	</signals>
-	<constants>
-	</constants>
-</class>
diff --git a/doc/classes/WebSocketPeer.xml b/doc/classes/WebSocketPeer.xml
deleted file mode 100644
index 276249e65..000000000
--- a/doc/classes/WebSocketPeer.xml
+++ /dev/null
@@ -1,51 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<class name="WebSocketPeer" inherits="PacketPeer" category="Core" version="3.1">
-	<brief_description>
-	</brief_description>
-	<description>
-	</description>
-	<tutorials>
-	</tutorials>
-	<demos>
-	</demos>
-	<methods>
-		<method name="close">
-			<return type="void">
-			</return>
-			<description>
-			</description>
-		</method>
-		<method name="get_write_mode" qualifiers="const">
-			<return type="int" enum="WebSocketPeer.WriteMode">
-			</return>
-			<description>
-			</description>
-		</method>
-		<method name="is_connected_to_host" qualifiers="const">
-			<return type="bool">
-			</return>
-			<description>
-			</description>
-		</method>
-		<method name="set_write_mode">
-			<return type="void">
-			</return>
-			<argument index="0" name="mode" type="int" enum="WebSocketPeer.WriteMode">
-			</argument>
-			<description>
-			</description>
-		</method>
-		<method name="was_string_packet" qualifiers="const">
-			<return type="bool">
-			</return>
-			<description>
-			</description>
-		</method>
-	</methods>
-	<constants>
-		<constant name="WRITE_MODE_TEXT" value="0" enum="WriteMode">
-		</constant>
-		<constant name="WRITE_MODE_BINARY" value="1" enum="WriteMode">
-		</constant>
-	</constants>
-</class>
diff --git a/doc/classes/WebSocketServer.xml b/doc/classes/WebSocketServer.xml
deleted file mode 100644
index 9a7108952..000000000
--- a/doc/classes/WebSocketServer.xml
+++ /dev/null
@@ -1,69 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<class name="WebSocketServer" inherits="WebSocketMultiplayerPeer" category="Core" version="3.1">
-	<brief_description>
-	</brief_description>
-	<description>
-	</description>
-	<tutorials>
-	</tutorials>
-	<demos>
-	</demos>
-	<methods>
-		<method name="has_peer" qualifiers="const">
-			<return type="bool">
-			</return>
-			<argument index="0" name="id" type="int">
-			</argument>
-			<description>
-			</description>
-		</method>
-		<method name="is_listening" qualifiers="const">
-			<return type="bool">
-			</return>
-			<description>
-			</description>
-		</method>
-		<method name="listen">
-			<return type="int" enum="Error">
-			</return>
-			<argument index="0" name="port" type="int">
-			</argument>
-			<argument index="1" name="protocols" type="PoolStringArray" default="PoolStringArray(  )">
-			</argument>
-			<argument index="2" name="gd_mp_api" type="bool" default="false">
-			</argument>
-			<description>
-			</description>
-		</method>
-		<method name="stop">
-			<return type="void">
-			</return>
-			<description>
-			</description>
-		</method>
-	</methods>
-	<signals>
-		<signal name="client_connected">
-			<argument index="0" name="id" type="int">
-			</argument>
-			<argument index="1" name="protocol" type="String">
-			</argument>
-			<description>
-			</description>
-		</signal>
-		<signal name="client_disconnected">
-			<argument index="0" name="id" type="int">
-			</argument>
-			<description>
-			</description>
-		</signal>
-		<signal name="data_received">
-			<argument index="0" name="id" type="int">
-			</argument>
-			<description>
-			</description>
-		</signal>
-	</signals>
-	<constants>
-	</constants>
-</class>
diff --git a/doc/classes/WebSocketMultiplayerPeer.xml b/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml
index a1014350f..1a841f85e 100644
--- a/doc/classes/WebSocketMultiplayerPeer.xml
+++ b/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml
@@ -1,8 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="WebSocketMultiplayerPeer" inherits="NetworkedMultiplayerPeer" category="Core" version="3.1">
 	<brief_description>
+		Base class for WebSocket server and client.
 	</brief_description>
 	<description>
+		Base class for WebSocket server and client, allowing them to be used as network peer for the [MultiplayerAPI].
 	</description>
 	<tutorials>
 	</tutorials>
@@ -15,6 +17,7 @@
 			<argument index="0" name="peer_id" type="int">
 			</argument>
 			<description>
+				Returns the [WebSocketPeer] associated to the given [code]peer_id[/code].
 			</description>
 		</method>
 	</methods>
@@ -23,6 +26,7 @@
 			<argument index="0" name="peer_source" type="int">
 			</argument>
 			<description>
+				Emitted when a packet is received from a peer. Note: this signal is only emitted when the client or server is configured to use Godot multiplayer API.
 			</description>
 		</signal>
 	</signals>