docs: [1.X] fixes of PVP exceptions (round 2) (#3374)

This PR is a continuation of
#3300
It focuses on fixing PVP errors related to PVP-151-1 "**_Public APIs
should be documented_**" and all remaining PVP errors **present in
pvpExceptions.json file**

We have 87 errors left from PVP-151-1 at the time of this PR creation.
If anyone want's to add to it what we should do is:

1. Check errors present in pvpExceptions.json file (preferably under
"PVP-150-1", choose some to fix
2. Address those errors and when making commit remove the fixed errors
from pvpExceptions file
The first commit of this PR is an example of how such process should
look like

In general [new CI
implementation](#3193)
will catch all new errors like this so all we need to do is fix the
present ones. This PR **does not** focus on PVP present in gold profile
but if capacity allows, those can also be addressed.

**Errors present in "PVP-41-1", "PVP-300-4" are to be expected** so
there is no need of fixing this one!
Another thing is that we could ignore error related to missing APIs for
tests (so TestHelpers, EditorTests, RuntimeTests) because those were
made internal in 2.X version (that's why those errors are not popping by
there). This does not affect users so we don't need to add anything
there

## Backport 
This has its equivalent in
#3375

---------

Co-authored-by: Emma <[email protected]>
Co-authored-by: Noel Stephens <[email protected]>

Author: 3 people

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

@@ -31,6 +31,9 @@ public class NetworkConfig
         [Tooltip("When set, NetworkManager will automatically create and spawn the assigned player prefab. This can be overridden by adding it to the NetworkPrefabs list and selecting override.")]
         public GameObject PlayerPrefab;
 
+        /// <summary>
+        /// 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

@@ -57,6 +57,11 @@ public class NetworkPrefab
         /// </summary>
         public GameObject OverridingTargetPrefab;
 
+        /// <summary>
+        /// 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>
         public bool Equals(NetworkPrefab other)
         {
             return Override == other.Override &&
@@ -66,6 +71,12 @@ public bool Equals(NetworkPrefab other)
                    OverridingTargetPrefab == other.OverridingTargetPrefab;
         }
 
+        /// <summary>
+        /// 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>
         public uint SourcePrefabGlobalObjectIdHash
         {
             get
@@ -98,6 +109,12 @@ public uint SourcePrefabGlobalObjectIdHash
             }
         }
 
+        /// <summary>
+        /// 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>
         public uint TargetPrefabGlobalObjectIdHash
         {
             get
@@ -122,6 +139,11 @@ public uint TargetPrefabGlobalObjectIdHash
             }
         }
 
+        /// <summary>
+        /// 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>
         public bool Validate(int index = -1)
         {
             NetworkObject networkObject;
@@ -224,6 +246,10 @@ public bool Validate(int index = -1)
             return true;
         }
 
+        /// <summary>
+        /// 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>
         public override string ToString()
         {
             return $"{{SourceHash: {SourceHashToOverride}, TargetHash: {TargetPrefabGlobalObjectIdHash}}}";

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

@@ -34,11 +34,14 @@ 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.
+        /// </summary>
         public IReadOnlyList<NetworkPrefab> Prefabs => m_Prefabs;
 
         [NonSerialized]
@@ -62,14 +65,16 @@ private void RemoveTriggeredByNetworkPrefabList(NetworkPrefab networkPrefab)
             m_Prefabs.Remove(networkPrefab);
         }
 
+        /// <summary>
+        /// 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()
         {
@@ -84,6 +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>
         public void Initialize(bool warnInvalid = true)
         {
             m_Prefabs.Clear();
@@ -154,11 +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 <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>
@@ -175,11 +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 <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>
@@ -197,11 +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 <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>
@@ -232,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++)
@@ -251,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++)
@@ -269,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)
         {