disable and comment naming rule violation checks

0xFA11 · 0xFA11 · commit 3c36a5fed0f6 · 2021-03-29T19:36:48.000+01:00
diff --git a/com.unity.multiplayer.mlapi/Editor/MLAPIProfilerModule.cs b/com.unity.multiplayer.mlapi/Editor/MLAPIProfilerModule.cs
@@ -17,6 +17,7 @@ internal static class MLAPIProfilerModule
         private const string k_OperationModuleName = "MLAPI Operations";
         private const string k_MessageModuleName = "MLAPI Messages";
 
+#pragma warning disable IDE1006 // disable naming rule violation check
         /// <summary>
         /// This needs to be in synced with the internal dynamic module structure to provide our own counters
         /// </summary>
@@ -46,6 +47,7 @@ private class MLAPIModules
             // Note: These fields are named this way for internal serialization
             public List<MLAPIProfilerModuleData> Modules;
         }
+#pragma warning restore IDE1006 // restore naming rule violation check
 
         private static List<MLAPIProfilerCounter> CreateRPCCounters() => new List<MLAPIProfilerCounter>()
         {
diff --git a/com.unity.multiplayer.mlapi/Runtime/Core/NetworkBehaviour.cs b/com.unity.multiplayer.mlapi/Runtime/Core/NetworkBehaviour.cs
@@ -25,7 +25,7 @@ namespace MLAPI
     /// </summary>
     public abstract class NetworkBehaviour : MonoBehaviour
     {
-#pragma warning disable IDE1006
+#pragma warning disable IDE1006 // disable naming rule violation check
         [Browsable(false)]
         [EditorBrowsable(EditorBrowsableState.Never)]
 #if UNITY_2020_2_OR_NEWER
@@ -35,15 +35,15 @@ internal enum __NExec
         [Obsolete("Please do not use, will no longer be exposed in the future versions (framework internal)")]
         public enum __NExec
 #endif
-#pragma warning restore IDE1006
+#pragma warning restore IDE1006 // restore naming rule violation check
         {
             None = 0,
             Server = 1,
             Client = 2
         }
 
 #pragma warning disable 414
-#pragma warning disable IDE1006
+#pragma warning disable IDE1006 // disable naming rule violation check
         [NonSerialized]
         [Browsable(false)]
         [EditorBrowsable(EditorBrowsableState.Never)]
@@ -56,9 +56,9 @@ public enum __NExec
         public __NExec __nexec = __NExec.None;
 #endif
 #pragma warning restore 414
-#pragma warning restore IDE1006
+#pragma warning restore IDE1006 // restore naming rule violation check
 
-#pragma warning disable IDE1006
+#pragma warning disable IDE1006 // disable naming rule violation check
         [Browsable(false)]
         [EditorBrowsable(EditorBrowsableState.Never)]
 #if UNITY_2020_2_OR_NEWER
@@ -68,7 +68,7 @@ internal NetworkSerializer __beginSendServerRpc(ServerRpcParams serverRpcParams,
         [Obsolete("Please do not use, will no longer be exposed in the future versions (framework internal)")]
         public NetworkSerializer __beginSendServerRpc(ServerRpcParams serverRpcParams, RpcDelivery rpcDelivery)
 #endif
-#pragma warning restore IDE1006
+#pragma warning restore IDE1006 // restore naming rule violation check
         {
             PooledNetworkWriter writer;
 
@@ -103,7 +103,7 @@ public NetworkSerializer __beginSendServerRpc(ServerRpcParams serverRpcParams, R
             return writer.Serializer;
         }
 
-#pragma warning disable IDE1006
+#pragma warning disable IDE1006 // disable naming rule violation check
         [Browsable(false)]
         [EditorBrowsable(EditorBrowsableState.Never)]
 #if UNITY_2020_2_OR_NEWER
@@ -113,7 +113,7 @@ internal void __endSendServerRpc(NetworkSerializer serializer, ServerRpcParams s
         [Obsolete("Please do not use, will no longer be exposed in the future versions (framework internal)")]
         public void __endSendServerRpc(NetworkSerializer serializer, ServerRpcParams serverRpcParams, RpcDelivery rpcDelivery)
 #endif
-#pragma warning restore IDE1006
+#pragma warning restore IDE1006 // restore naming rule violation check
         {
             if (serializer == null)
             {
@@ -131,7 +131,7 @@ public void __endSendServerRpc(NetworkSerializer serializer, ServerRpcParams ser
             }
         }
 
-#pragma warning disable IDE1006
+#pragma warning disable IDE1006 // disable naming rule violation check
         [Browsable(false)]
         [EditorBrowsable(EditorBrowsableState.Never)]
 #if UNITY_2020_2_OR_NEWER
@@ -141,7 +141,7 @@ internal NetworkSerializer __beginSendClientRpc(ClientRpcParams clientRpcParams,
         [Obsolete("Please do not use, will no longer be exposed in the future versions (framework internal)")]
         public NetworkSerializer __beginSendClientRpc(ClientRpcParams clientRpcParams, RpcDelivery rpcDelivery)
 #endif
-#pragma warning restore IDE1006
+#pragma warning restore IDE1006 // restore naming rule violation check
         {
             PooledNetworkWriter writer;
 
@@ -208,7 +208,7 @@ public NetworkSerializer __beginSendClientRpc(ClientRpcParams clientRpcParams, R
             return writer.Serializer;
         }
 
-#pragma warning disable IDE1006
+#pragma warning disable IDE1006 // disable naming rule violation check
         [Browsable(false)]
         [EditorBrowsable(EditorBrowsableState.Never)]
 #if UNITY_2020_2_OR_NEWER
@@ -218,7 +218,7 @@ internal void __endSendClientRpc(NetworkSerializer serializer, ClientRpcParams c
         [Obsolete("Please do not use, will no longer be exposed in the future versions (framework internal)")]
         public void __endSendClientRpc(NetworkSerializer serializer, ClientRpcParams clientRpcParams, RpcDelivery rpcDelivery)
 #endif
-#pragma warning restore IDE1006
+#pragma warning restore IDE1006 // restore naming rule violation check
         {
             if (serializer == null)
             {
diff --git a/com.unity.multiplayer.mlapi/Runtime/Core/NetworkManager.cs b/com.unity.multiplayer.mlapi/Runtime/Core/NetworkManager.cs
@@ -31,7 +31,7 @@ namespace MLAPI
     [AddComponentMenu("MLAPI/NetworkManager", -100)]
     public class NetworkManager : MonoBehaviour, INetworkUpdateSystem, IProfilableTransportProvider
     {
-#pragma warning disable IDE1006
+#pragma warning disable IDE1006 // disable naming rule violation check
         [Browsable(false)]
         [EditorBrowsable(EditorBrowsableState.Never)]
         [DebuggerBrowsable(DebuggerBrowsableState.Never)]
@@ -42,7 +42,7 @@ public class NetworkManager : MonoBehaviour, INetworkUpdateSystem, IProfilableTr
         [Obsolete("Please do not use, will no longer be exposed in the future versions (framework internal)")]
         public static readonly Dictionary<uint, Action<NetworkBehaviour, NetworkSerializer, __RpcParams>> __ntable = new Dictionary<uint, Action<NetworkBehaviour, NetworkSerializer, __RpcParams>>();
 #endif
-#pragma warning restore IDE1006
+#pragma warning restore IDE1006 // restore naming rule violation check
 
 #if DEVELOPMENT_BUILD || UNITY_EDITOR
         private static ProfilerMarker s_EventTick = new ProfilerMarker($"{nameof(NetworkManager)}.EventTick");
diff --git a/com.unity.multiplayer.mlapi/Runtime/Messaging/RpcParams.cs b/com.unity.multiplayer.mlapi/Runtime/Messaging/RpcParams.cs
@@ -38,15 +38,15 @@ public struct ClientRpcParams
         public ClientRpcReceiveParams Receive;
     }
 
-#pragma warning disable IDE1006
+#pragma warning disable IDE1006 // disable naming rule violation check
 #if UNITY_2020_2_OR_NEWER
     // RuntimeAccessModifiersILPP will make this `public`
     internal struct __RpcParams
 #else
     [Obsolete("Please do not use, will no longer be exposed in the future versions (framework internal)")]
     public struct __RpcParams
 #endif
-#pragma warning restore IDE1006
+#pragma warning restore IDE1006 // restore naming rule violation check
     {
         public ServerRpcParams Server;
         public ClientRpcParams Client;
diff --git a/com.unity.multiplayer.mlapi/Runtime/Transports/NetworkTransport.cs b/com.unity.multiplayer.mlapi/Runtime/Transports/NetworkTransport.cs
@@ -85,9 +85,9 @@ public TransportChannel[] MLAPI_CHANNELS
         /// <summary>
         /// The channels the MLAPI will use when sending internal messages.
         /// </summary>
-#pragma warning disable IDE1006
+#pragma warning disable IDE1006 // disable naming rule violation check
         private readonly TransportChannel[] MLAPI_INTERNAL_CHANNELS =
-#pragma warning restore IDE1006
+#pragma warning restore IDE1006 // restore naming rule violation check
         {
             new TransportChannel(NetworkChannel.Internal, NetworkDelivery.ReliableFragmentedSequenced),
             new TransportChannel(NetworkChannel.ReliableRpc, NetworkDelivery.ReliableSequenced),

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ internal static class MLAPIProfilerModule`
`17`	`17`	`private const string k_OperationModuleName = "MLAPI Operations";`
`18`	`18`	`private const string k_MessageModuleName = "MLAPI Messages";`
`19`	`19`
	`20`	`+#pragma warning disable IDE1006 // disable naming rule violation check`
`20`	`21`	`/// <summary>`
`21`	`22`	`/// This needs to be in synced with the internal dynamic module structure to provide our own counters`
`22`	`23`	`/// </summary>`
`@@ -46,6 +47,7 @@ private class MLAPIModules`
`46`	`47`	`// Note: These fields are named this way for internal serialization`
`47`	`48`	`public List<MLAPIProfilerModuleData> Modules;`
`48`	`49`	`}`
	`50`	`+#pragma warning restore IDE1006 // restore naming rule violation check`
`49`	`51`
`50`	`52`	`private static List<MLAPIProfilerCounter> CreateRPCCounters() => new List<MLAPIProfilerCounter>()`
`51`	`53`	`{`