Added XML comments

Author: TwoTenPvP

MLAPI/Data/Transports/ChannelType.cs

@@ -1,17 +1,53 @@
 namespace MLAPI.Data
 {
+    /// <summary>
+    /// Delivery methods
+    /// </summary>
     public enum ChannelType
     {
+        /// <summary>
+        /// Unreliable message
+        /// </summary>
         Unreliable,
+        /// <summary>
+        /// Unreliable with fragmentation support
+        /// </summary>
         UnreliableFragmented,
+        /// <summary>
+        /// Unreliable with sequencing
+        /// </summary>
         UnreliableSequenced,
+        /// <summary>
+        /// Reliable message
+        /// </summary>
         Reliable,
+        /// <summary>
+        /// Reliable with fragmentation support
+        /// </summary>
         ReliableFragmented,
+        /// <summary>
+        /// Reliable message where messages are guaranteed to be in the right order
+        /// </summary>
         ReliableSequenced,
+        /// <summary>
+        /// A unreliable state update message
+        /// </summary>
         StateUpdate,
+        /// <summary>
+        /// A reliable state update message
+        /// </summary>
         ReliableStateUpdate,
+        /// <summary>
+        /// A reliable message with high priority
+        /// </summary>
         AllCostDelivery,
+        /// <summary>
+        /// Unreliable message with fragmentation where older messages are dropped
+        /// </summary>
         UnreliableFragmentedSequenced,
+        /// <summary>
+        /// A reliable message with guaranteed order with fragmentation support
+        /// </summary>
         ReliableFragmentedSequenced
     }
 }

MLAPI/Data/Transports/DefaultTransport.cs

@@ -1,9 +1,21 @@
 namespace MLAPI.Data.Transports
 {
+    /// <summary>
+    /// Supported built in transport
+    /// </summary>
     public enum DefaultTransport
     {
+        /// <summary>
+        /// Unity's UNET transport
+        /// </summary>
         UNET,
+        /// <summary>
+        /// LiteNetLib transport
+        /// </summary>
         LiteNetLib,
+        /// <summary>
+        /// A custom transport
+        /// </summary>
         Custom
     }
 }

MLAPI/Data/Transports/IUDPTransport.cs

@@ -1,23 +1,110 @@
 namespace MLAPI.Data
 {
+    /// <summary>
+    /// A UDP transport
+    /// </summary>
     public interface IUDPTransport
     {
+        /// <summary>
+        /// The channelType the Internal library will use
+        /// </summary>
         ChannelType InternalChannel { get; }
+        /// <summary>
+        /// The clientId to use when you want to send to the server from client
+        /// </summary>
         uint ServerNetId { get; }
+        /// <summary>
+        /// A dummy clientId to represent the host client
+        /// </summary>
         uint HostDummyId { get; }
+        /// <summary>
+        /// A invalid clientId to represent a clientId of server
+        /// </summary>
         uint InvalidDummyId { get; }
+        /// <summary>
+        /// Queues a message for sending.
+        /// </summary>
+        /// <param name="clientId">The clientId to send to</param>
+        /// <param name="dataBuffer">The buffer to read from</param>
+        /// <param name="dataSize">The amount of data to send from the buffer</param>
+        /// <param name="channelId">The channelId to send on</param>
+        /// <param name="skipQueue">Wheter or not Send will have to be called for this message to be sent</param>
+        /// <param name="error">Error byte. Does nothhing</param>
         void QueueMessageForSending(uint clientId, ref byte[] dataBuffer, int dataSize, int channelId, bool skipQueue, out byte error);
+        /// <summary>
+        /// Sends queued messages for a specific clientId
+        /// </summary>
+        /// <param name="clientId">The clientId to send</param>
+        /// <param name="error">Error byte. Does nothhing</param>
         void SendQueue(uint clientId, out byte error);
+        /// <summary>
+        /// Polls for incomming events
+        /// </summary>
+        /// <param name="clientId">The clientId this event is for</param>
+        /// <param name="channelId">The channelId this message comes from</param>
+        /// <param name="data">The data buffer, if any</param>
+        /// <param name="bufferSize">The size of the buffer</param>
+        /// <param name="receivedSize">The amount of bytes we received</param>
+        /// <param name="error">Error byte. Does nothhing</param>
+        /// <returns>Returns the event type</returns>
         NetEventType PollReceive(out uint clientId, out int channelId, ref byte[] data, int bufferSize, out int receivedSize, out byte error);
+        /// <summary>
+        /// Adds a channel with a specific type
+        /// </summary>
+        /// <param name="type">The channelType</param>
+        /// <param name="settings">The settings object used by the transport</param>
+        /// <returns>Returns a unique id for the channel</returns>
         int AddChannel(ChannelType type, object settings);
+        /// <summary>
+        /// Connects client to server
+        /// </summary>
+        /// <param name="address">The address to connect to</param>
+        /// <param name="port">The port to connect to</param>
+        /// <param name="settings">The settings object to use for the transport</param>
+        /// <param name="error">Error byte. Does nothhing</param>
         void Connect(string address, int port, object settings, out byte error);
+        /// <summary>
+        /// Starts to listen for incomming clients.
+        /// </summary>
+        /// <param name="settings">The settings object for the transport</param>
         void RegisterServerListenSocket(object settings);
+        /// <summary>
+        /// Disconnects a client from the server
+        /// </summary>
+        /// <param name="clientId">The clientId to disconnect</param>
         void DisconnectClient(uint clientId);
+        /// <summary>
+        /// Disconnects client from the server
+        /// </summary>
         void DisconnectFromServer();
+        /// <summary>
+        /// Gets the round trip time for a specific client
+        /// </summary>
+        /// <param name="clientId">The clientId to get the rtt from</param>
+        /// <param name="error">Error byte. Does nothhing</param>
+        /// <returns>Returns the event type</returns>
         int GetCurrentRTT(uint clientId, out byte error);
+        /// <summary>
+        /// Gets a delay in miliseconds based on a timestamp
+        /// </summary>
+        /// <param name="clientId">The clientId to get the delay for</param>
+        /// <param name="remoteTimestamp">The timestamp</param>
+        /// <param name="error">Error byte. Does nothhing</param>
+        /// <returns>Returns the delay in miliseconds</returns>
         int GetRemoteDelayTimeMS(uint clientId, int remoteTimestamp, out byte error);
+        /// <summary>
+        /// Gets a timestamp to be used for calculating latency
+        /// </summary>
+        /// <returns>The timestamp</returns>
         int GetNetworkTimestamp();
+        /// <summary>
+        /// Inits the transport and returns a settings object to be used for listening, connecting and registering channels
+        /// </summary>
+        /// <returns>The settings object</returns>
         object GetSettings();
+        /// <summary>
+        /// Shuts down the transport
+        /// </summary>
         void Shutdown();
     }
 }

MLAPI/Data/Transports/LiteNetLib/LiteNetLibTransport.cs

@@ -1,4 +1,5 @@
-using LiteNetLib;
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+using LiteNetLib;
 using LiteNetLib.Utils;
 using MLAPI.MonoBehaviours.Core;
 using System.Collections.Generic;
@@ -230,3 +231,4 @@ public void OnNetworkLatencyUpdate(NetPeer peer, int latency)
         }
     }
 }
+#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member

MLAPI/Data/Transports/NetEventType.cs

@@ -1,10 +1,25 @@
 namespace MLAPI.Data
 {
+    /// <summary>
+    /// Represents a netEvent when polling
+    /// </summary>
     public enum NetEventType
     {
+        /// <summary>
+        /// New data is received
+        /// </summary>
         Data,
+        /// <summary>
+        /// A client is connected, or client connected to server
+        /// </summary>
         Connect,
+        /// <summary>
+        /// A client disconnected, or client disconnected from server
+        /// </summary>
         Disconnect,
+        /// <summary>
+        /// No new event
+        /// </summary>
         Nothing
     }
 }

MLAPI/Data/Transports/UNET/NetId.cs

@@ -70,13 +70,11 @@ public uint GetClientId()
         {
             return HostId | (uint)((ConnectionId & 0xFF) << 8) | (uint)(((ConnectionId >> 8) & 0xFF) << 16) | (uint)(Meta << 24);
         }
-        // Rider generated vvv
         /// <summary>
-        /// Determines whether the specified <see cref="object"/> is equal to the current <see cref="T:MLAPI.Data.NetId"/>.
+        /// Checks if two NetId's are equal
         /// </summary>
-        /// <param name="obj">The <see cref="object"/> to compare with the current <see cref="T:MLAPI.Data.NetId"/>.</param>
-        /// <returns><c>true</c> if the specified <see cref="object"/> is equal to the current <see cref="T:MLAPI.Data.NetId"/>;
-        /// otherwise, <c>false</c>.</returns>
+        /// <param name="obj">NetId to compare to</param>
+        /// <returns>Wheter or not the two NetIds are equal</returns>
         public override bool Equals (object obj)
         {
             if (obj == null || GetType() != obj.GetType())
@@ -85,34 +83,30 @@ public override bool Equals (object obj)
             NetId key = (NetId)obj;
             return (HostId == key.HostId) && (ConnectionId == key.ConnectionId);
         }
-        // Rider generated vvv
         /// <summary>
-        /// Serves as a hash function for a <see cref="T:MLAPI.Data.NetId"/> object.
+        /// Returns a hash code for the instance
         /// </summary>
-        /// <returns>A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a
-        /// hash table.</returns>
+        /// <returns>Returns a hash code for the instance</returns>
         public override int GetHashCode()
         {
             return (int)GetClientId();
         }
-        // Rider generated vvv
         /// <summary>
-        /// Determines whether a specified instance of <see cref="MLAPI.Data.NetId"/> is equal to another specified <see cref="MLAPI.Data.NetId"/>.
+        /// Checks if two NetId's are equal
         /// </summary>
-        /// <param name="client1">The first <see cref="MLAPI.Data.NetId"/> to compare.</param>
-        /// <param name="client2">The second <see cref="MLAPI.Data.NetId"/> to compare.</param>
-        /// <returns><c>true</c> if <c>client1</c> and <c>client2</c> are equal; otherwise, <c>false</c>.</returns>
+        /// <param name="client1">First netId</param>
+        /// <param name="client2">Second netId</param>
+        /// <returns>Wheter or not the two NetIds are equal</returns>
         public static bool operator ==(NetId client1, NetId client2)
         {
             return (client1.HostId == client2.HostId && client1.ConnectionId == client2.ConnectionId) || (client1.IsHost() == client2.IsHost());
         }
-        // Rider generated vvv
         /// <summary>
-        /// Determines whether a specified instance of <see cref="MLAPI.Data.NetId"/> is not equal to another specified <see cref="MLAPI.Data.NetId"/>.
+        /// Checks if two NetId's are not equal
         /// </summary>
-        /// <param name="client1">The first <see cref="MLAPI.Data.NetId"/> to compare.</param>
-        /// <param name="client2">The second <see cref="MLAPI.Data.NetId"/> to compare.</param>
-        /// <returns><c>true</c> if <c>client1</c> and <c>client2</c> are not equal; otherwise, <c>false</c>.</returns>
+        /// <param name="client1">First netId</param>
+        /// <param name="client2">Second netId</param>
+        /// <returns>Wheter or not the two NetIds are not equal</returns>
         public static bool operator !=(NetId client1, NetId client2)
         {
             return !(client1 == client2);

MLAPI/Data/Transports/UNET/UnetTransport.cs

@@ -1,4 +1,5 @@
-using MLAPI.MonoBehaviours.Core;
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+using MLAPI.MonoBehaviours.Core;
 using System;
 using System.Collections.Generic;
 using UnityEngine.Networking;
@@ -181,3 +182,4 @@ public void Connect(string address, int port, object settings, out byte error)
         }
     }
 }
+#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member