Added XML comments and cleaned up minor things

Author: TwoTenPvP

MLAPI/Data/FixedQueue.cs

@@ -17,6 +17,11 @@ public sealed class FixedQueue<T>
         /// </summary>
         public int Count { get => queueCount; }
 
+        /// <summary>
+        /// Gets the element at a given virtual index
+        /// </summary>
+        /// <param name="index">The virtual index to get the item from</param>
+        /// <returns>The element at the virtual index</returns>
         public T this[int index]
         {
             get
@@ -66,8 +71,8 @@ public T Dequeue()
         /// <summary>
         /// Gets the element at a given virtual index
         /// </summary>
-        /// <param name="index"></param>
-        /// <returns></returns>
+        /// <param name="index">The virtual index to get the item from</param>
+        /// <returns>The element at the virtual index</returns>
         public T ElementAt(int index) => queue[(queueStart + index) % queue.Length];
     }
 }

MLAPI/Data/HashCode.cs

@@ -2,6 +2,9 @@
 
 namespace MLAPI.Data
 {
+    /// <summary>
+    /// Provides extension methods for getting hashes
+    /// </summary>
     public static class HashCode
     {
         private const uint FNV_offset_basis32 = 2166136261;
@@ -87,7 +90,7 @@ public static ulong GetStableHash64(this string txt)
         /// https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function
         /// </summary>
         /// <returns>The stable hash32.</returns>
-        /// <param name="txt">Text.</param>
+        /// <param name="bytes">Text.</param>
         public static ushort GetStableHash16(this byte[] bytes)
         {
             uint hash32 = bytes.GetStableHash32();
@@ -104,7 +107,7 @@ public static ushort GetStableHash16(this byte[] bytes)
         /// https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function
         /// </summary>
         /// <returns>The stable hash32.</returns>
-        /// <param name="txt">Text.</param>
+        /// <param name="bytes">Text.</param>
         public static uint GetStableHash32(this byte[] bytes)
         {
             unchecked
@@ -129,7 +132,7 @@ public static uint GetStableHash32(this byte[] bytes)
         /// https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function
         /// </summary>
         /// <returns>The stable hash32.</returns>
-        /// <param name="txt">Text.</param>
+        /// <param name="bytes">Text.</param>
         public static ulong GetStableHash64(this byte[] bytes)
         {
             unchecked

MLAPI/Data/NetworkConfig.cs

@@ -154,6 +154,10 @@ public class NetworkConfig
         /// </summary>
         public AttributeMessageMode AttributeMessageMode = AttributeMessageMode.Disabled;
 
+        /// <summary>
+        /// Returns a base64 encoded version of the config
+        /// </summary>
+        /// <returns></returns>
         public string ToBase64()
         {
             NetworkConfig config = this;
@@ -212,7 +216,12 @@ public string ToBase64()
                 return Convert.ToBase64String(writer.Finalize());
             }
         }
-
+        
+        /// <summary>
+        /// Sets the NetworkConfig data with that from a base64 encoded version
+        /// </summary>
+        /// <param name="base64">The base64 encoded version</param>
+        /// <param name="createDummyObject">Wheter or not to create dummy objects for NetworkedPrefabs</param>
         public void FromBase64(string base64, bool createDummyObject = false)
         {
             NetworkConfig config = this;

MLAPI/Data/NetworkProfiler/NetworkProfiler.cs

@@ -4,14 +4,27 @@
 
 namespace MLAPI.Data.NetworkProfiler
 {
+    /// <summary>
+    /// NetworkProfiler for profiling network traffic
+    /// </summary>
     public static class NetworkProfiler
     {
+        /// <summary>
+        /// The ticks that has been recorded
+        /// </summary>
         public static FixedQueue<ProfilerTick> Ticks { get; private set; }
+        /// <summary>
+        /// Wheter or not the profiler is recording data
+        /// </summary>
         public static bool isRunning { get; private set; }
         private static int tickHistory = 1024;
         private static int EventIdCounter = 0;
         private static ProfilerTick CurrentTick;
 
+        /// <summary>
+        /// Starts recording data for the Profiler
+        /// </summary>
+        /// <param name="historyLength">The amount of ticks to keep in memory</param>
         public static void Start(int historyLength)
         {
             if (isRunning)
@@ -23,13 +36,21 @@ public static void Start(int historyLength)
             isRunning = true;
         }
 
+        /// <summary>
+        /// Stops recording data
+        /// </summary>
         public static void Stop()
         {
             Ticks = null; //leave to GC
             CurrentTick = null; //leave to GC
             isRunning = false;
         }
 
+        /// <summary>
+        /// Stops recording data and fills the buffer with the recorded ticks and returns the length;
+        /// </summary>
+        /// <param name="tickBuffer">The buffer to fill with the ticks</param>
+        /// <returns>The number of ticks recorded</returns>
         public static int Stop(ref ProfilerTick[] tickBuffer)
         {
             if (!isRunning)
@@ -44,6 +65,11 @@ public static int Stop(ref ProfilerTick[] tickBuffer)
             return iteration;
         }
 
+        /// <summary>
+        /// Stops recording data and fills the buffer with the recorded ticks and returns the length;
+        /// </summary>
+        /// <param name="tickBuffer">The buffer to fill with the ticks</param>
+        /// <returns>The number of ticks recorded</returns>
         public static int Stop(ref List<ProfilerTick> tickBuffer)
         {
             if (!isRunning)

MLAPI/Data/NetworkProfiler/ProfilerTickData.cs

@@ -3,14 +3,32 @@
 
 namespace MLAPI.Data.NetworkProfiler
 {
+    /// <summary>
+    /// The type of Tick
+    /// </summary>
     public enum TickType
     {
+        /// <summary>
+        /// Event tick. During EventTick SyncedVars are flushed etc
+        /// </summary>
         Event,
+        /// <summary>
+        /// Receive tick. During ReceiveTick data is received from the transport
+        /// </summary>
         Receive,
+        /// <summary>
+        /// Send tick. During Send data is sent from Transport queue
+        /// </summary>
         Send
     }
+    /// <summary>
+    /// A tick in used for the Profiler
+    /// </summary>
     public class ProfilerTick
     {
+        /// <summary>
+        /// The events that occured during this tick
+        /// </summary>
         [BinaryIgnore]
         public readonly List<TickEvent> Events = new List<TickEvent>();
         private TickEvent[] events;
@@ -54,9 +72,21 @@ internal void StartEvent(TickType type, uint bytes, string channelName, string m
             Events.Add(tickEvent);
         }
 
+        /// <summary>
+        /// The type of tick
+        /// </summary>
         public TickType Type;
+        /// <summary>
+        /// The frame the tick executed on
+        /// </summary>
         public int Frame;
+        /// <summary>
+        /// The id of the tick
+        /// </summary>
         public int EventId;
+        /// <summary>
+        /// The amount of bytes that were sent and / or recieved during this tick
+        /// </summary>
         public uint Bytes
         {
             get
@@ -68,12 +98,30 @@ public uint Bytes
         }
     }
 
+    /// <summary>
+    /// A event that can occur during a Event
+    /// </summary>
     public class TickEvent
     {
+        /// <summary>
+        /// The type of evenmt
+        /// </summary>
         public TickType EventType;
+        /// <summary>
+        /// The amount of bytes sent or received
+        /// </summary>
         public uint Bytes;
+        /// <summary>
+        /// The name of the channel
+        /// </summary>
         public string ChannelName;
+        /// <summary>
+        /// The message type
+        /// </summary>
         public string MessageType;
+        /// <summary>
+        /// Wheter or not the event is closed
+        /// </summary>
         public bool Closed;
     }
 }

MLAPI/Data/Transports/UNET/RelayTransport.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 System.Net;
@@ -199,10 +200,7 @@ public static bool QueueMessageForSending(int hostId, int connectionId, int chan
             return NetworkTransport.QueueMessageForSending(hostId, relayConnectionId, channelId, buffer, size, out error);
         }
 
-        public static bool SendQueuedMessages(int hostId, int connectionId, out byte error)
-        {
-            return NetworkTransport.SendQueuedMessages(hostId, relayConnectionId, out error);
-        }
+        public static bool SendQueuedMessages(int hostId, int connectionId, out byte error) => NetworkTransport.SendQueuedMessages(hostId, relayConnectionId, out error);
 
         public static NetworkEventType ReceiveFromHost(int hostId, out int connectionId, out int channelId, byte[] buffer, int bufferSize, out int receivedSize, out byte error)
         {
@@ -330,3 +328,4 @@ public InvalidConfigException() { }
         public InvalidConfigException(string issue) : base(issue) { }
     }
 }
+#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member