style

Some additional minor updates to XML API.

Author: NoelStephensUnity

com.unity.netcode.gameobjects/Runtime/Configuration/NetworkConfig.cs

@@ -32,7 +32,7 @@ public class NetworkConfig
         public GameObject PlayerPrefab;
 
         /// <summary>
-        /// The collection of network prefabs available for spawning across the network
+        /// The collection of network prefabs available for spawning across the network.
         /// </summary>
         [SerializeField]
         public NetworkPrefabs Prefabs = new NetworkPrefabs();

com.unity.netcode.gameobjects/Runtime/Configuration/NetworkPrefab.cs

@@ -58,10 +58,10 @@ public class NetworkPrefab
         public GameObject OverridingTargetPrefab;
 
         /// <summary>
-        /// Compares this NetworkPrefab with another to determine equality
+        /// Compares this NetworkPrefab with another to determine equality.
         /// </summary>
-        /// <param name="other">The NetworkPrefab to compare against</param>
-        /// <returns>True if all fields match between the two NetworkPrefabs, false otherwise</returns>
+        /// <param name="other">The NetworkPrefab to compare against.</param>
+        /// <returns>True if all fields match between the two NetworkPrefabs, false otherwise.</returns>
         public bool Equals(NetworkPrefab other)
         {
             return Override == other.Override &&
@@ -72,11 +72,11 @@ public bool Equals(NetworkPrefab other)
         }
 
         /// <summary>
-        /// Gets the GlobalObjectIdHash of the source prefab based on the current override settings
+        /// Gets the GlobalObjectIdHash of the source prefab based on the current override settings.
         /// </summary>
-        /// <value>The hash value identifying the source prefab</value>
-        /// <exception cref="InvalidOperationException">Thrown when required prefab references are missing or invalid</exception>
-        /// <exception cref="ArgumentOutOfRangeException">Thrown when Override has an invalid value</exception>
+        /// <value>The hash value identifying the source prefab.</value>
+        /// <exception cref="InvalidOperationException">Thrown when required prefab references are missing or invalid.</exception>
+        /// <exception cref="ArgumentOutOfRangeException">Thrown when Override has an invalid value.</exception>
         public uint SourcePrefabGlobalObjectIdHash
         {
             get
@@ -110,11 +110,11 @@ public uint SourcePrefabGlobalObjectIdHash
         }
 
         /// <summary>
-        /// Gets the GlobalObjectIdHash of the target prefab when using prefab overrides
+        /// Gets the GlobalObjectIdHash of the target prefab when using prefab overrides.
         /// </summary>
-        /// <value>The hash value identifying the target prefab, or 0 if no override is set</value>
-        /// <exception cref="InvalidOperationException">Thrown when required prefab references are missing or invalid</exception>
-        /// <exception cref="ArgumentOutOfRangeException">Thrown when Override has an invalid value</exception>
+        /// <value>The hash value identifying the target prefab, or 0 if no override is set.</value>
+        /// <exception cref="InvalidOperationException">Thrown when required prefab references are missing or invalid.</exception>
+        /// <exception cref="ArgumentOutOfRangeException">Thrown when Override has an invalid value.</exception>
         public uint TargetPrefabGlobalObjectIdHash
         {
             get
@@ -140,10 +140,10 @@ public uint TargetPrefabGlobalObjectIdHash
         }
 
         /// <summary>
-        /// Validates the NetworkPrefab configuration to ensure all required fields are properly set
+        /// Validates the NetworkPrefab configuration to ensure all required fields are properly set.
         /// </summary>
-        /// <param name="index">Optional index used for error reporting when validating lists of prefabs</param>
-        /// <returns>True if the NetworkPrefab is valid and ready for use, false otherwise</returns>
+        /// <param name="index">Optional index used for error reporting when validating lists of prefabs.</param>
+        /// <returns>True if the NetworkPrefab is valid and ready for use, false otherwise.</returns>
         public bool Validate(int index = -1)
         {
             NetworkObject networkObject;
@@ -247,9 +247,9 @@ public bool Validate(int index = -1)
         }
 
         /// <summary>
-        /// Returns a string representation of this NetworkPrefab's source and target hash values
+        /// Returns a string representation of this NetworkPrefab's source and target hash values.
         /// </summary>
-        /// <returns>A string containing the source and target hash values</returns>
+        /// <returns>A string containing the source and target hash values.</returns>
         public override string ToString()
         {
             return $"{{SourceHash: {SourceHashToOverride}, TargetHash: {TargetPrefabGlobalObjectIdHash}}}";

com.unity.netcode.gameobjects/Runtime/Configuration/NetworkPrefabs.cs

@@ -34,13 +34,13 @@ public class NetworkPrefabs
         /// This is used for the legacy way of spawning NetworkPrefabs with an override when manually instantiating and spawning.
         /// To handle multiple source NetworkPrefab overrides that all point to the same target NetworkPrefab use
         /// <see cref="NetworkSpawnManager.InstantiateAndSpawn(NetworkObject, ulong, bool, bool, bool, Vector3, Quaternion)"/>
-        /// or <see cref="NetworkObject.InstantiateAndSpawn(NetworkManager, ulong, bool, bool, bool, Vector3, Quaternion)"/>
+        /// or <see cref="NetworkObject.InstantiateAndSpawn(NetworkManager, ulong, bool, bool, bool, Vector3, Quaternion)"/>.
         /// </summary>
         [NonSerialized]
         public Dictionary<uint, uint> OverrideToNetworkPrefab = new Dictionary<uint, uint>();
 
         /// <summary>
-        /// Gets the read-only list of all registered network prefabs
+        /// Gets the read-only list of all registered network prefabs.
         /// </summary>
         public IReadOnlyList<NetworkPrefab> Prefabs => m_Prefabs;
 
@@ -66,16 +66,15 @@ private void RemoveTriggeredByNetworkPrefabList(NetworkPrefab networkPrefab)
         }
 
         /// <summary>
-        /// Finalizer that ensures proper cleanup of network prefab resources
+        /// Destructor that cleans up network prefab resources.
         /// </summary>
         ~NetworkPrefabs()
         {
             Shutdown();
         }
 
         /// <summary>
-        /// Deregister from add and remove events
-        /// Clear the list
+        /// Deregister from add and remove events and clear the events.
         /// </summary>
         internal void Shutdown()
         {
@@ -90,7 +89,7 @@ internal void Shutdown()
         /// Processes the <see cref="NetworkPrefabsList"/> if one is present for use during runtime execution,
         /// else processes <see cref="Prefabs"/>.
         /// </summary>
-        /// <param name="warnInvalid">When true, logs warnings about invalid prefabs that are removed during initialization</param>
+        /// <param name="warnInvalid">When true, logs warnings about invalid prefabs that are removed during initialization.</param>
         public void Initialize(bool warnInvalid = true)
         {
             m_Prefabs.Clear();
@@ -161,13 +160,12 @@ public void Initialize(bool warnInvalid = true)
         }
 
         /// <summary>
-        /// Add a new NetworkPrefab instance to the list
+        /// Add a new NetworkPrefab instance to the list.
         /// </summary>
-        /// <param name="networkPrefab">The NetworkPrefab to add</param>
+        /// <param name="networkPrefab">The <see cref="NetworkPrefab"/> to add.</param>
         /// <returns>True if the prefab was successfully added, false if it was invalid or already registered</returns>
         /// <remarks>
-        /// The framework does not synchronize this list between clients. Any runtime changes must be handled manually.
-        ///
+        /// The framework does not synchronize this list between clients. Any runtime changes must be handled manually.<br />
         /// Any modifications made here are not persisted. Permanent configuration changes should be done
         /// through the <see cref="NetworkPrefabsList"/> scriptable object property.
         /// </remarks>
@@ -184,12 +182,11 @@ public bool Add(NetworkPrefab networkPrefab)
         }
 
         /// <summary>
-        /// Remove a NetworkPrefab instance from the list
+        /// Remove a NetworkPrefab instance from the list.
         /// </summary>
-        /// <param name="prefab">The NetworkPrefab to remove</param>
+        /// <param name="prefab">The <see cref="NetworkPrefab"/> to remove.</param>
         /// <remarks>
-        /// The framework does not synchronize this list between clients. Any runtime changes must be handled manually.
-        ///
+        /// The framework does not synchronize this list between clients. Any runtime changes must be handled manually.<br />
         /// Any modifications made here are not persisted. Permanent configuration changes should be done
         /// through the <see cref="NetworkPrefabsList"/> scriptable object property.
         /// </remarks>
@@ -207,12 +204,11 @@ public void Remove(NetworkPrefab prefab)
         }
 
         /// <summary>
-        /// Remove a NetworkPrefab instance with matching <see cref="NetworkPrefab.Prefab"/> from the list
+        /// Remove a NetworkPrefab instance with matching <see cref="NetworkPrefab.Prefab"/> from the list.
         /// </summary>
-        /// <param name="prefab">The GameObject to match against for removal</param>
+        /// <param name="prefab">The <see cref="GameObject"/> to match against for removal.</param>
         /// <remarks>
-        /// The framework does not synchronize this list between clients. Any runtime changes must be handled manually.
-        ///
+        /// The framework does not synchronize this list between clients. Any runtime changes must be handled manually.<br />
         /// Any modifications made here are not persisted. Permanent configuration changes should be done
         /// through the <see cref="NetworkPrefabsList"/> scriptable object property.
         /// </remarks>
@@ -243,10 +239,10 @@ public void Remove(GameObject prefab)
         }
 
         /// <summary>
-        /// Check if the given GameObject is present as a prefab within the list
+        /// Check if the given GameObject is present as a prefab within the list.
         /// </summary>
-        /// <param name="prefab">The prefab to check</param>
-        /// <returns>Whether or not the prefab exists</returns>
+        /// <param name="prefab">The prefab to check.</param>
+        /// <returns>True if the prefab exists or false if it does not.</returns>
         public bool Contains(GameObject prefab)
         {
             for (int i = 0; i < m_Prefabs.Count; i++)
@@ -262,10 +258,10 @@ public bool Contains(GameObject prefab)
         }
 
         /// <summary>
-        /// Check if the given NetworkPrefab is present within the list
+        /// Check if the given NetworkPrefab is present within the list.
         /// </summary>
-        /// <param name="prefab">The prefab to check</param>
-        /// <returns>Whether or not the prefab exists</returns>
+        /// <param name="prefab">The prefab to check.</param>
+        /// <returns>True if the prefab exists or false if it does not.</returns>
         public bool Contains(NetworkPrefab prefab)
         {
             for (int i = 0; i < m_Prefabs.Count; i++)
@@ -280,7 +276,7 @@ public bool Contains(NetworkPrefab prefab)
         }
 
         /// <summary>
-        /// Configures <see cref="NetworkPrefabOverrideLinks"/> for the given <see cref="NetworkPrefab"/>
+        /// Configures <see cref="NetworkPrefabOverrideLinks"/> for the given <see cref="NetworkPrefab"/>.
         /// </summary>
         private bool AddPrefabRegistration(NetworkPrefab networkPrefab)
         {