style

Some comment clean up.

Author: NoelStephensUnity

com.unity.netcode.gameobjects/Editor/Configuration/HybridNetcodeConfigApplier.cs

@@ -6,21 +6,19 @@
 namespace Unity.Netcode.GameObjects.Editor.Configuration
 {
     /// <summary>
-    /// Keeps the project's <see cref="NetCodeConfig"/> aligned with what NGO needs whenever the project is running in
-    /// hybrid mode (Netcode for Entities installed, and at least one registered network prefab carrying a ghost).
+    /// Keeps the project's <see cref="NetCodeConfig"/> aligned with NGO needs whenever the project is running in
+    /// hybrid mode (N4E installed and at least one registered NGO network prefab has a GhostObject component).
     /// </summary>
     /// <remarks>
-    /// This never creates a <see cref="NetCodeConfig"/>. Netcode for Entities already creates one unconditionally from
-    /// its own <see cref="InitializeOnLoadMethodAttribute"/>, and creating a second lands the project in N4E's
-    /// multiple-config error path. We find the one N4E settled on and correct it.
+    /// This does not create <see cref="NetCodeConfig"/>. This finds the one N4E created and modifies it.
     /// </remarks>
     internal static class HybridNetcodeConfigApplier
     {
         [InitializeOnLoadMethod]
         private static void OnApplicationStart()
         {
-            // N4E creates and assigns the global config from its own InitializeOnLoadMethod. Cross-assembly ordering
-            // between the two is not a documented contract, so defer rather than racing it.
+            // Cross-assembly ordering between the two is not a documented contract.
+            // Defer rather than racing it.
             EditorApplication.delayCall += OnDelayCall;
         }
 
@@ -31,12 +29,13 @@ private static void OnDelayCall()
         }
 
         /// <summary>
-        /// Corrects the global <see cref="NetCodeConfig"/> for hybrid mode, if this is a hybrid project.
+        /// Adjusts <see cref="NetCodeConfig"/> for NGO hybrid mode.
         /// </summary>
         /// <param name="applyRecommended">
-        /// When true, re-applies the full tuned set even if this project has already had it applied once. Driven by the
-        /// button in Project Settings. When false, the tuned values are only written the first time, so that a user's
-        /// own edits are not repeatedly overwritten.
+        /// Driven by the button in Project Settings:
+        /// - When true: it re-applies the full tuned set even if this project has already had it applied once.
+        /// - When false: default NGO settings are only written once, the first time they are applied. From that
+        /// point forward, the user's edits are not overwritten.
         /// </param>
         internal static void Apply(bool applyRecommended)
         {
@@ -91,7 +90,6 @@ internal static void Apply(bool applyRecommended)
         /// <summary>
         /// True when any <see cref="NetworkManager"/> in the project has a registered prefab carrying a ghost.
         /// </summary>
-        /// <returns>Whether this project is configured for hybrid mode.</returns>
         internal static bool IsHybridProject()
         {
             foreach (var networkManager in Resources.FindObjectsOfTypeAll<NetworkManager>())
@@ -140,7 +138,7 @@ private static bool HasGhost(NetworkPrefab prefab)
         /// <summary>
         /// Resolves the config N4E considers global, falling back to a project scan when N4E has not assigned one yet.
         /// </summary>
-        /// <returns>The config to correct, or null when none exists yet.</returns>
+        /// <returns>The config to adjust or null if no config exists.</returns>
         internal static NetCodeConfig ResolveGlobalConfig()
         {
             if (NetCodeConfig.Global != null)
@@ -153,7 +151,9 @@ internal static NetCodeConfig ResolveGlobalConfig()
         }
 
         /// <summary>
-        /// The tick rate N4E should be driven at. NGO owns this, so it comes from <see cref="NetworkConfig.TickRate"/>.
+        /// Returns either the current N4E tick rate or the NGO <see cref="NetworkConfig.TickRate"/>.
+        /// If no NetworkManager is found yet, it returns N4E's tick rate.
+        /// If a NetworkManager is found, then it returns NGO's tick rate.
         /// </summary>
         /// <param name="config">The config, used as the fallback when no NetworkManager can be found.</param>
         /// <returns>The tick rate to write into the config.</returns>

com.unity.netcode.gameobjects/Editor/Configuration/NetcodeForGameObjectsProjectSettings.cs

@@ -37,11 +37,11 @@ private void OnEnable()
 
 #if UNIFIED_NETCODE
         /// <summary>
-        /// The version of the NGO hybrid mode defaults already applied to this project's NetCodeConfig.
+        /// The hybrid mode default values already applied to this project's NetCodeConfig.
         /// </summary>
         /// <remarks>
-        /// Zero means they have never been applied. Recording it is what keeps the tuned values a one-shot, so that a
-        /// user who deliberately changes them does not have them overwritten on the next domain reload.
+        /// Zero means they have never been applied. Persisting this value is what keeps the tuned values a one-shot.
+        /// For users who deliberately change them, they are not overwritten on the next domain reload.
         /// </remarks>
         [SerializeField]
         public int HybridDefaultsVersion;

com.unity.netcode.gameobjects/Editor/Configuration/NetcodeSettingsProvider.cs

@@ -215,8 +215,8 @@ private static void OnGuiHandler(string obj)
 
 #if UNIFIED_NETCODE
         /// <summary>
-        /// Surfaces the state of the project's NetCodeConfig, and offers a way back to the NGO defaults for anyone who
-        /// has since changed them.
+        /// Displays the current state of the project's NetCodeConfig and offers a way to reset back to the
+        /// NGO default values for anyone who has since changed them.
         /// </summary>
         /// <param name="settings">The project settings holding the applied-defaults marker.</param>
         private static void DrawHybridSettings(NetcodeForGameObjectsProjectSettings settings)

com.unity.netcode.gameobjects/Tests/Editor/HybridNetcodeDefaultsTests.cs

@@ -7,7 +7,7 @@
 namespace Unity.Netcode.EditorTests
 {
     /// <summary>
-    /// Guards the NetCodeConfig values NGO applies in hybrid mode, and the reasoning behind the non-obvious ones.
+    /// Validates the NetCodeConfig values NGO applies in hybrid mode.
     /// </summary>
     internal class HybridNetcodeDefaultsTests
     {
@@ -84,12 +84,11 @@ public void ApplyRecommendedProducesTheTunedValues()
         }
 
         /// <summary>
-        /// The reason the millisecond form is used rather than <see cref="ClientTickRate.InterpolationTimeNetTicks"/>.
+        /// Why the millisecond form is used rather than <see cref="ClientTickRate.InterpolationTimeNetTicks"/>.
         /// </summary>
         /// <remarks>
         /// Netcode for Entities rounds the millisecond value up to whole network ticks, so it holds at least the
-        /// configured wall clock buffer at any tick rate. Two net ticks does not: it is 66.7ms at 30Hz but only 33.3ms
-        /// at 60Hz, and 33.3ms is the buffer the 2000 instance stress test stuttered at.
+        /// configured wall clock buffer at any tick rate.
         /// </remarks>
         /// <param name="tickRate">The tick rate to resolve the buffer against.</param>
         [TestCase(30u)]

com.unity.netcode.gameobjects/Tests/Runtime/Unified/UnifiedSnapshotPacketSizeMeasurement.cs

@@ -12,8 +12,8 @@
 namespace Unity.Netcode.RuntimeTests
 {
     /// <summary>
-    /// Measurement harness (not a pass/fail behaviour test) used to size
-    /// <see cref="NetCode.GhostSendSystemData.DefaultSnapshotPacketSize"/> for hybrid (NGO + N4E) mode.
+    /// Measurement harness (not a pass/fail behaviour test) used to determine bandwidth consumption based
+    /// on the <see cref="NetCode.GhostSendSystemData.DefaultSnapshotPacketSize"/> when running in hybrid mode.
     /// Spawns N hybrid ghosts, keeps every one of them dirty on every tick, and reads the N4E client-side
     /// snapshot metrics singleton for a fixed sample window. Results are emitted as "PKTSZ|" log lines.
     /// </summary>