fix: pvp-151-1

Fixing some stragglers.

Author: NoelStephensUnity

com.unity.netcode.gameobjects/Tests/Runtime/NetworkVariable/NetworkVariableTestsHelperTypes.cs

@@ -129,49 +129,49 @@ internal struct TemplatedValueOnlyReferencedByNetworkVariableSubclass<T> : INetw
         public T Value;
     }
 
-    public enum ByteEnum : byte
+    internal enum ByteEnum : byte
     {
         A,
         B,
         C = byte.MaxValue
     }
-    public enum SByteEnum : sbyte
+    internal enum SByteEnum : sbyte
     {
         A,
         B,
         C = sbyte.MaxValue
     }
-    public enum ShortEnum : short
+    internal enum ShortEnum : short
     {
         A,
         B,
         C = short.MaxValue
     }
-    public enum UShortEnum : ushort
+    internal enum UShortEnum : ushort
     {
         A,
         B,
         C = ushort.MaxValue
     }
-    public enum IntEnum : int
+    internal enum IntEnum : int
     {
         A,
         B,
         C = int.MaxValue
     }
-    public enum UIntEnum : uint
+    internal enum UIntEnum : uint
     {
         A,
         B,
         C = uint.MaxValue
     }
-    public enum LongEnum : long
+    internal enum LongEnum : long
     {
         A,
         B,
         C = long.MaxValue
     }
-    public enum ULongEnum : ulong
+    internal enum ULongEnum : ulong
     {
         A,
         B,

com.unity.netcode.gameobjects/Tests/Runtime/TestHelpers/ConditionalPredicate.cs

@@ -10,6 +10,9 @@ public class ConditionalPredicateBase : IConditionalPredicate
     {
         private bool m_TimedOut;
 
+        /// <summary>
+        /// Will be set to <see cref="true"/> if timed out.
+        /// </summary>
         public bool TimedOut { get { return m_TimedOut; } }
 
         /// <summary>
@@ -59,6 +62,7 @@ public interface IConditionalPredicate
         /// <summary>
         /// Test the conditions of the test to be reached
         /// </summary>
+        /// <returns><see cref="true"/> or <see cref="false"/></returns>
         bool HasConditionBeenReached();
 
         /// <summary>
@@ -67,9 +71,10 @@ public interface IConditionalPredicate
         void Started();
 
         /// <summary>
-        /// Wait for condition has finished:
+        /// Wait for condition has finished: <br />
         /// Condition(s) met or timed out
         /// </summary>
+        /// <param name="timedOut"><see cref="true"/> or <see cref="false"/></param>
         void Finished(bool timedOut);
 
     }

com.unity.netcode.gameobjects/Tests/Runtime/TestHelpers/MessageHooksConditional.cs

@@ -67,7 +67,9 @@ protected override void OnFinished()
             base.OnFinished();
         }
 
-        /// <inheritdoc/>
+        /// <summary>
+        /// Resets the instance.
+        /// </summary>
         public void Reset()
         {
             foreach (var entry in m_MessageHookEntries)

com.unity.netcode.gameobjects/Tests/Runtime/TestHelpers/NetcodeIntegrationTest.cs

@@ -52,7 +52,13 @@ public abstract class NetcodeIntegrationTest
         /// </summary>
         public enum SceneManagementState
         {
+            /// <summary>
+            /// Scene management is enabled.
+            /// </summary>
             SceneManagementEnabled,
+            /// <summary>
+            /// Scene management is disabled.
+            /// </summary>
             SceneManagementDisabled
         }
 
@@ -115,8 +121,8 @@ public static void DeregisterNetworkObject(NetworkObject networkObject)
         /// Overloaded version of <see cref="DeregisterNetworkObject"/>. <br />
         /// Used by <see cref="ObjectNameIdentifier"/> to de-register a spawned <see cref="NetworkObject"/> instance.
         /// </summary>
-        /// <param name="networkObject">The <see cref="NetworkManager"/>'s assigned client identifier.</param>
-        /// <param name="networkObject">The <see cref="NetworkObject"/> being de-registered for a test in progress.</param>
+        /// <param name="localClientId">The client instance identifier of the spawned <see cref="NetworkObject"/> instance.
+        /// <param name="networkObjectId">The <see cref="NetworkObject.NetworkObjectId"/> of the spawned instance.</param>
         public static void DeregisterNetworkObject(ulong localClientId, ulong networkObjectId)
         {
             if (s_GlobalNetworkObjects.ContainsKey(localClientId) && s_GlobalNetworkObjects[localClientId].ContainsKey(networkObjectId))
@@ -1029,7 +1035,7 @@ protected void SetTimeTravelSimulatedDropRate(float dropRatePercent)
         /// <summary>
         /// When using time travel, you can use this method to simulate packet jitter conditions.
         /// </summary>
-        /// <param name="dropRatePercent">The amount of packet jitter to be applied while time traveling.</param>
+        /// <param name="jitterSeconds">The amount of packet jitter to be applied while time traveling.</param>
         protected void SetTimeTravelSimulatedLatencyJitter(float jitterSeconds)
         {
             ((MockTransport)GetAuthorityNetworkManager().NetworkConfig.NetworkTransport).LatencyJitter = jitterSeconds;
@@ -1715,6 +1721,8 @@ protected void EnableMessageLogging()
         /// Note: For more complex tests, <see cref="ConditionalPredicateBase"/> and the overloaded
         /// version of this method
         /// </summary>
+        /// <param name="checkForCondition">the conditional function to determine if the condition has been reached.</param>
+        /// <param name="timeOutHelper">the <see cref="TimeoutHelper"/> used to handle timing out the wait condition.</param>
         /// <returns><see cref="IEnumerator"/></returns>
         public static IEnumerator WaitForConditionOrTimeOut(Func<bool> checkForCondition, TimeoutHelper timeOutHelper = null)
         {
@@ -1752,6 +1760,8 @@ public static IEnumerator WaitForConditionOrTimeOut(Func<bool> checkForCondition
         /// Waits for the function condition to return true or it will time out. Uses time travel to simulate this
         /// for the given number of frames, simulating delta times at the application frame rate.
         /// </summary>
+        /// <param name="checkForCondition">the conditional function to determine if the condition has been reached.</param>
+        /// <param name="maxTries">the maximum times to check for the condition (default is 60).</param>
         /// <returns><see cref="true"/> or <see cref="false"/></returns>
         public bool WaitForConditionOrTimeOutWithTimeTravel(Func<bool> checkForCondition, int maxTries = 60)
         {
@@ -1790,6 +1800,8 @@ public bool WaitForConditionOrTimeOutWithTimeTravel(Func<bool> checkForCondition
         /// This version accepts an IConditionalPredicate implementation to provide
         /// more flexibility for checking complex conditional cases.
         /// </summary>
+        /// <param name="conditionalPredicate">An <see cref="IConditionalPredicate"/> implementation used to determine if the condition(s) has/have been met.</param>
+        /// <param name="timeOutHelper">the <see cref="TimeoutHelper"/> used to handle timing out the wait condition.</param>
         /// <returns><see cref="IEnumerator"/></returns>
         public static IEnumerator WaitForConditionOrTimeOut(IConditionalPredicate conditionalPredicate, TimeoutHelper timeOutHelper = null)
         {
@@ -2028,6 +2040,9 @@ protected GameObject CreateNetworkObjectPrefab(string baseName)
         /// <summary>
         /// Overloaded method <see cref="SpawnObject(NetworkObject, NetworkManager, bool)"/>
         /// </summary>
+        /// <param name="prefabGameObject">the prefab <see cref="GameObject"/> to spawn</param>
+        /// <param name="owner">the owner of the instance</param>
+        /// <param name="destroyWithScene">default is false</param>
         /// <returns>The <see cref="GameObject"/> of the newly spawned <see cref="NetworkObject"/>.</returns>
         protected GameObject SpawnObject(GameObject prefabGameObject, NetworkManager owner, bool destroyWithScene = false)
         {
@@ -2039,6 +2054,9 @@ protected GameObject SpawnObject(GameObject prefabGameObject, NetworkManager own
         /// <summary>
         /// Overloaded method <see cref="SpawnObject(NetworkObject, NetworkManager, bool)"/>
         /// </summary>
+        /// <param name="prefabGameObject">the prefab <see cref="GameObject"/> to spawn</param>
+        /// <param name="owner">the owner of the instance</param>
+        /// <param name="destroyWithScene">default is false</param>
         /// <returns>The <see cref="GameObject"/> of the newly spawned player's <see cref="NetworkObject"/>.</returns>
         protected GameObject SpawnPlayerObject(GameObject prefabGameObject, NetworkManager owner, bool destroyWithScene = false)
         {
@@ -2050,9 +2068,10 @@ protected GameObject SpawnPlayerObject(GameObject prefabGameObject, NetworkManag
         /// <summary>
         /// Spawn a NetworkObject prefab instance
         /// </summary>
-        /// <param name="prefabNetworkObject">the prefab NetworkObject to spawn</param>
+        /// <param name="prefabNetworkObject">the prefab <see cref="NetworkObject"/> to spawn</param>
         /// <param name="owner">the owner of the instance</param>
         /// <param name="destroyWithScene">default is false</param>
+        /// <param name="isPlayerObject">when <see cref="true"/>, the object will be spawned as the <see cref="NetworkManager.LocalClientId"/> owned player.</param>
         /// <returns>GameObject instance spawned</returns>
         private GameObject SpawnObject(NetworkObject prefabNetworkObject, NetworkManager owner, bool destroyWithScene = false, bool isPlayerObject = false)
         {
@@ -2109,8 +2128,12 @@ private GameObject SpawnObject(NetworkObject prefabNetworkObject, NetworkManager
         }
 
         /// <summary>
-        /// Overloaded method <see cref="SpawnObjects(NetworkObject, NetworkManager, int, bool)"/>
+        /// Overloaded method <see cref="SpawnObjects(NetworkObject, NetworkManager, int, bool)"/>.
         /// </summary>
+        /// <param name="prefabGameObject">the prefab <see cref="GameObject"/> to spawn</param>
+        /// <param name="owner">the owner of the instance</param>
+        /// <param name="count">number of instances to create and spawn</param>
+        /// <param name="destroyWithScene">default is false</param>
         /// <returns>A <see cref="List{T}"/> of <see cref="GameObject"/>s spawned.</returns>
         protected List<GameObject> SpawnObjects(GameObject prefabGameObject, NetworkManager owner, int count, bool destroyWithScene = false)
         {
@@ -2123,7 +2146,7 @@ protected List<GameObject> SpawnObjects(GameObject prefabGameObject, NetworkMana
         /// Will spawn (x) number of prefab NetworkObjects
         /// <see cref="SpawnObject(NetworkObject, NetworkManager, bool)"/>
         /// </summary>
-        /// <param name="prefabNetworkObject">the prefab NetworkObject to spawn</param>
+        /// <param name="prefabNetworkObject">the prefab <see cref="NetworkObject"/> to spawn</param>
         /// <param name="owner">the owner of the instance</param>
         /// <param name="count">number of instances to create and spawn</param>
         /// <param name="destroyWithScene">default is false</param>
@@ -2220,6 +2243,11 @@ private void InitializeTestConfiguration(NetworkTopologyTypes networkTopologyTyp
         /// Just a helper function to avoid having to write the entire assert just to check if you
         /// timed out.
         /// </summary>
+        /// <remarks>
+        /// If no <see cref="TimeoutHelper"/> is provided, then the <see cref="s_GlobalTimeoutHelper"/> will be used.
+        /// </remarks>
+        /// <param name="timeOutErrorMessage">The error message to log if a time out has occurred.</param>
+        /// <param name="assignedTimeoutHelper">Optional <see cref="TimeoutHelper"/> instance used during a conditional wait.</param>
         protected void AssertOnTimeout(string timeOutErrorMessage, TimeoutHelper assignedTimeoutHelper = null)
         {
             var timeoutHelper = assignedTimeoutHelper ?? s_GlobalTimeoutHelper;
@@ -2299,6 +2327,8 @@ private IEnumerator WaitForTickAndFrames(NetworkManager networkManager, int tick
         /// <summary>
         /// Yields until specified amount of network ticks and the expected number of frames has been passed.
         /// </summary>
+        /// <param name="networkManager">The relative <see cref="NetworkManager"/> waiting for a specific tick.</param>
+        /// <param name="count">How many ticks to wait for.</param>
         /// <returns><see cref="IEnumerator"/></returns>
         protected IEnumerator WaitForTicks(NetworkManager networkManager, int count)
         {

com.unity.netcode.gameobjects/Tests/Runtime/TestHelpers/NetcodeIntegrationTestHelpers.cs

@@ -175,6 +175,8 @@ public static void CleanUpHandlers()
         /// If deriving from <see cref="NetcodeIntegrationTest"/> or using <see cref="Destroy"/> then you
         /// typically won't need to call this.
         /// </summary>
+        /// <param name="networkManager">The <see cref="NetworkManager"/> registering handlers.</param>
+        /// <param name="serverSideSceneManager">When <see cref="true"/>, the <see cref="NetworkManager"/> will register as the scene manager handler.</param>
         public static void RegisterHandlers(NetworkManager networkManager, bool serverSideSceneManager = false)
         {
             SceneManagerValidationAndTestRunnerInitialization(networkManager);
@@ -546,6 +548,7 @@ internal static bool Start(bool host, bool startServer, NetworkManager server, N
         /// <param name="server">The Server NetworkManager</param>
         /// <param name="clients">The Clients NetworkManager</param>
         /// <param name="callback">called immediately after server is started and before client(s) are started</param>
+        /// <param name="startServer">true to start it false to not start it.</param>
         /// <returns><see cref="true"/> if all instances started successfully, <see cref="false"/> otherwise</returns>
         public static bool Start(bool host, NetworkManager server, NetworkManager[] clients, BeforeClientStartCallback callback = null, bool startServer = true)
         {
@@ -608,8 +611,12 @@ public static bool Start(bool host, NetworkManager server, NetworkManager[] clie
         /// <summary>
         /// Used to return a value of type T from a wait condition
         /// </summary>
+        /// <typeparam name="T">The type to wrap.</typeparam>
         public class ResultWrapper<T>
         {
+            /// <summary>
+            /// The result wrapped.
+            /// </summary>
             public T Result;
         }
 
@@ -850,6 +857,7 @@ public static IEnumerator WaitForClientConnectedToServer(NetworkManager server,
         /// Waits on the server side for 1 client to be connected
         /// </summary>
         /// <param name="server">The server</param>
+        /// <param name="clientCount">The number of clients.</param>
         /// <param name="result">The result. If null, it will automatically assert</param>
         /// <param name="timeout">Maximum time in seconds to wait for connection. Defaults to DefaultTimeout</param>
         /// <returns><see cref="IEnumerator"/></returns>

com.unity.netcode.gameobjects/Tests/Runtime/TestHelpers/NetcodeLogAssert.cs

@@ -132,7 +132,7 @@ public void LogWasNotReceived(LogType type, string message)
         /// Assert if a log message was logged with the expectation it would not be. (RegEx version)
         /// </summary>
         /// <param name="type"><see cref="LogType"/> to check for.</param>
-        /// <param name="message"><see cref="Regex"/> containing the message pattern to search for.</param>
+        /// <param name="messageRegex"><see cref="Regex"/> containing the message pattern to search for.</param>
         public void LogWasNotReceived(LogType type, Regex messageRegex)
         {
             lock (m_Lock)
@@ -177,7 +177,7 @@ public void LogWasReceived(LogType type, string message)
         /// Assert if a log message was not logged with the expectation that it would be. (RegEx version)
         /// </summary>
         /// <param name="type"><see cref="LogType"/> to check for.</param>
-        /// <param name="message"><see cref="Regex"/> containing the message pattern to search for.</param>
+        /// <param name="messageRegex"><see cref="Regex"/> containing the message pattern to search for.</param>
         public void LogWasReceived(LogType type, Regex messageRegex)
         {
             lock (m_Lock)

com.unity.netcode.gameobjects/Tests/Runtime/TestHelpers/NetworkManagerHelper.cs

@@ -38,16 +38,32 @@ public static class NetworkManagerHelper
         /// All <see cref="NetworkObject"/> instances instantiated under the assigned <see cref="NetworkManager"/>.
         /// </summary>
         public static Dictionary<Guid, NetworkObject> InstantiatedNetworkObjects = new Dictionary<Guid, NetworkObject>();
+
+        /// <summary>
+        /// The operation mode configured.
+        /// </summary>
         public static NetworkManagerOperatingMode CurrentNetworkManagerMode;
 
         /// <summary>
         /// This provides the ability to start NetworkManager in various modes
         /// </summary>
         public enum NetworkManagerOperatingMode
         {
+            /// <summary>
+            /// None
+            /// </summary>
             None,
+            /// <summary>
+            /// Host mode
+            /// </summary>
             Host,
+            /// <summary>
+            /// Server mode
+            /// </summary>
             Server,
+            /// <summary>
+            /// Client mode
+            /// </summary>
             Client,
         }
 
@@ -58,6 +74,7 @@ public enum NetworkManagerOperatingMode
         /// send messages to yourself (i.e. Host-Client to Host-Server and vice versa).
         /// As such, the default setting is to start in Host mode.
         /// </summary>
+        /// <param name="networkManager">The newly started <see cref="NetworkManager"/></param>
         /// <param name="managerMode">parameter to specify which mode you want to start the NetworkManager</param>
         /// <param name="networkConfig">parameter to specify custom NetworkConfig settings</param>
         /// <returns>true if it was instantiated or is already instantiate otherwise false means it failed to instantiate</returns>