docs(xml): Added XML documentation to Transport and SocketTasks

Author: TwoTenPvP

MLAPI/Transports/MultiplexTransportAdapter.cs

@@ -4,6 +4,9 @@
 
 namespace MLAPI.Transports.Multiplex
 {
+    /// <summary>
+    /// Multiplex transport adapter.
+    /// </summary>
     public class MultiplexTransportAdapter : Transport
     {
         /// <summary>
@@ -39,6 +42,7 @@ public enum ConnectionIdSpreadMethod
             Spread
         }
 
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
         public ConnectionIdSpreadMethod SpreadMethod = ConnectionIdSpreadMethod.MakeRoomLastBits;
         public Transport[] Transports = new Transport[0];
         public override ulong ServerClientId => 0;
@@ -322,5 +326,7 @@ public byte GetFirstSupportedTransportIndex()
 
             return 0;
         }
+
+#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
     }
 }

MLAPI/Transports/Tasks/SocketTask.cs

@@ -3,11 +3,22 @@
 
 namespace MLAPI.Transports.Tasks
 {
+    /// <summary>
+    /// Represents one or more socket tasks.
+    /// </summary>
     public class SocketTasks
     {
+        /// <summary>
+        /// Gets or sets the underlying SocketTasks.
+        /// </summary>
+        /// <value>The tasks.</value>
         public SocketTask[] Tasks { get; set; }
 
-        public bool IsDone 
+        /// <summary>
+        /// Gets a value indicating whether this all tasks is done.
+        /// </summary>
+        /// <value><c>true</c> if is done; otherwise, <c>false</c>.</value>
+        public bool IsDone
         {
             get
             {
@@ -23,6 +34,10 @@ public bool IsDone
             }
         }
 
+        /// <summary>
+        /// Gets a value indicating whether all tasks were sucessful.
+        /// </summary>
+        /// <value><c>true</c> if success; otherwise, <c>false</c>.</value>
         public bool Success
         {
             get
@@ -39,6 +54,10 @@ public bool Success
             }
         }
 
+        /// <summary>
+        /// Gets a value indicating whether any tasks were successful.
+        /// </summary>
+        /// <value><c>true</c> if any success; otherwise, <c>false</c>.</value>
         public bool AnySuccess
         {
             get
@@ -55,6 +74,10 @@ public bool AnySuccess
             }
         }
 
+        /// <summary>
+        /// Gets a value indicating whether any tasks are done.
+        /// </summary>
+        /// <value><c>true</c> if any done; otherwise, <c>false</c>.</value>
         public bool AnyDone
         {
             get
@@ -72,19 +95,54 @@ public bool AnyDone
         }
     }
 
+    /// <summary>
+    /// A single socket task.
+    /// </summary>
     public class SocketTask
     {
         // Used for states
+        /// <summary>
+        /// Gets or sets a value indicating whether this <see cref="T:MLAPI.Transports.Tasks.SocketTask"/> is done.
+        /// </summary>
+        /// <value><c>true</c> if is done; otherwise, <c>false</c>.</value>
         public bool IsDone { get; set; }
+        /// <summary>
+        /// Gets or sets a value indicating whether this <see cref="T:MLAPI.Transports.Tasks.SocketTask"/> is success.
+        /// </summary>
+        /// <value><c>true</c> if success; otherwise, <c>false</c>.</value>
         public bool Success { get; set; }
 
         // These are all set by the transport
+        /// <summary>
+        /// Gets or sets the transport exception.
+        /// </summary>
+        /// <value>The transport exception.</value>
         public Exception TransportException { get; set; }
+        /// <summary>
+        /// Gets or sets the socket error.
+        /// </summary>
+        /// <value>The socket error.</value>
         public SocketError SocketError { get; set; }
+        /// <summary>
+        /// Gets or sets the transport code.
+        /// </summary>
+        /// <value>The transport code.</value>
         public int TransportCode { get; set; }
+        /// <summary>
+        /// Gets or sets the message.
+        /// </summary>
+        /// <value>The message.</value>
         public string Message { get; set; }
+        /// <summary>
+        /// Gets or sets the state.
+        /// </summary>
+        /// <value>The state.</value>
         public object State { get; set; }
 
+        /// <summary>
+        /// Gets a done task.
+        /// </summary>
+        /// <value>The done.</value>
         public static SocketTask Done => new SocketTask()
         {
             IsDone = true,
@@ -96,6 +154,10 @@ public class SocketTask
             TransportException = null
         };
 
+        /// <summary>
+        /// Gets a faulty task.
+        /// </summary>
+        /// <value>The fault.</value>
         public static SocketTask Fault => new SocketTask()
         {
             IsDone = true,
@@ -107,6 +169,10 @@ public class SocketTask
             TransportException = null
         };
 
+        /// <summary>
+        /// Gets a working task.
+        /// </summary>
+        /// <value>The working.</value>
         public static SocketTask Working => new SocketTask()
         {
             IsDone = false,
@@ -118,6 +184,10 @@ public class SocketTask
             TransportException = null
         };
 
+        /// <summary>
+        /// Converts to a SocketTasks.
+        /// </summary>
+        /// <returns>The tasks.</returns>
         public SocketTasks AsTasks()
         {
             return new SocketTasks()

MLAPI/Transports/Transport.cs

@@ -64,6 +64,9 @@ public abstract class Transport : MonoBehaviour
             }
         };
 
+        /// <summary>
+        /// Delegate for transport events.
+        /// </summary>
         public delegate void TransportEventDelegate(NetEventType type, ulong clientId, string channelName, ArraySegment<byte> payload, float receiveTime);
 
         /// <summary>
@@ -105,7 +108,7 @@ public abstract class Transport : MonoBehaviour
         /// </summary>
         /// <param name="clientId">The clientId to disconnect</param>
         public abstract void DisconnectRemoteClient(ulong clientId);
-        
+
         /// <summary>
         /// Disconnects the local client from the server
         /// </summary>
@@ -117,7 +120,7 @@ public abstract class Transport : MonoBehaviour
         /// <param name="clientId">The clientId to get the rtt from</param>
         /// <returns>Returns the round trip time in milliseconds </returns>
         public abstract ulong GetCurrentRtt(ulong clientId);
-        
+
         /// <summary>
         /// Shuts down the transport
         /// </summary>