From f6a441438eb265dab5133e02d1050a9a9977a77f Mon Sep 17 00:00:00 2001
From: Chris Langsenkamp <chris@clevertech.net>
Date: Mon, 29 Jul 2019 12:55:38 -0400
Subject: [PATCH] NetworkClient

---
 Assets/Mirror/Runtime/NetworkClient.cs | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/Assets/Mirror/Runtime/NetworkClient.cs b/Assets/Mirror/Runtime/NetworkClient.cs
index 7acc79712..b8a834b96 100644
--- a/Assets/Mirror/Runtime/NetworkClient.cs
+++ b/Assets/Mirror/Runtime/NetworkClient.cs
@@ -22,6 +22,10 @@ public enum ConnectState
     /// </summary>
     public class NetworkClient
     {
+        /// <summary>
+        /// Obsolete: Use NetworkClient directly.
+        /// <para>Singleton isn't needed anymore, all functions are static now. For example: NetworkClient.Send(message) instead of NetworkClient.singleton.Send(message).</para>
+        /// </summary>
         [EditorBrowsable(EditorBrowsableState.Never), Obsolete("Use NetworkClient directly. Singleton isn't needed anymore, all functions are static now. For example: NetworkClient.Send(message) instead of NetworkClient.singleton.Send(message).")]
         public static NetworkClient singleton = new NetworkClient();
 
@@ -218,6 +222,9 @@ static void RemoveTransportHandlers()
             Transport.activeTransport.OnClientError.RemoveListener(OnError);
         }
 
+        /// <summary>
+        /// Obsolete: Use SendMessage<T> instead with no message id instead
+        /// </summary>
         [EditorBrowsable(EditorBrowsableState.Never), Obsolete("Use SendMessage<T> instead with no message id instead")]
         public static bool Send(short msgType, MessageBase msg)
         {
@@ -326,6 +333,9 @@ void GenerateError(byte error)
         }
         */
 
+        /// <summary>
+        /// Obsolete: Use NetworkTime.rtt instead
+        /// </summary>
         [EditorBrowsable(EditorBrowsableState.Never), Obsolete("Use NetworkTime.rtt instead")]
         public static float GetRTT()
         {
@@ -364,6 +374,9 @@ internal static void RegisterSystemHandlers(bool localClient)
             RegisterHandler<SyncEventMessage>(ClientScene.OnSyncEventMessage);
         }
 
+        /// <summary>
+        /// Obsolete: Use RegisterHandler<T> instead
+        /// </summary>
         [EditorBrowsable(EditorBrowsableState.Never), Obsolete("Use RegisterHandler<T> instead")]
         public static void RegisterHandler(int msgType, NetworkMessageDelegate handler)
         {
@@ -374,6 +387,9 @@ public static void RegisterHandler(int msgType, NetworkMessageDelegate handler)
             handlers[msgType] = handler;
         }
 
+        /// <summary>
+        /// Obsolete: Use RegisterHandler<T> instead
+        /// </summary>
         [EditorBrowsable(EditorBrowsableState.Never), Obsolete("Use RegisterHandler<T> instead")]
         public static void RegisterHandler(MsgType msgType, NetworkMessageDelegate handler)
         {
@@ -396,12 +412,18 @@ public static void RegisterHandler(MsgType msgType, NetworkMessageDelegate handl
             handlers[msgType] = MessagePacker.MessageHandler<T>(handler);
         }
 
+        /// <summary>
+        /// Obsolete: Use UnregisterHandler<T> instead
+        /// </summary>
         [EditorBrowsable(EditorBrowsableState.Never), Obsolete("Use UnregisterHandler<T> instead")]
         public static void UnregisterHandler(int msgType)
         {
             handlers.Remove(msgType);
         }
 
+        /// <summary>
+        /// Obsolete: Use UnregisterHandler<T> instead
+        /// </summary>
         [EditorBrowsable(EditorBrowsableState.Never), Obsolete("Use UnregisterHandler<T> instead")]
         public static void UnregisterHandler(MsgType msgType)
         {
@@ -430,6 +452,9 @@ public static void Shutdown()
             connectState = ConnectState.None;
         }
 
+        /// <summary>
+        /// Obsolete: Call NetworkClient.Shutdown() instead. There is only one client.
+        /// </summary>
         [EditorBrowsable(EditorBrowsableState.Never), Obsolete("Call NetworkClient.Shutdown() instead. There is only one client.")]
         public static void ShutdownAll()
         {