docs: [2.X] fixes of PVP exceptions (#3225)

This PR 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 currently have 768 errors to address so this PR will be a
collaborative effort. 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

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.

**Error present in "PVP-41-1" is to be expected** so there is no need of
fixing this one!

---------

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

Author: 3 people

com.unity.netcode.gameobjects/Runtime/Components/AnticipatedNetworkTransform.cs

@@ -50,10 +50,24 @@ public class AnticipatedNetworkTransform : NetworkTransform
         internal override bool HideInterpolateValue => true;
 #endif
 
+        /// <summary>
+        /// Represents a complete transform state for network synchronization and anticipation
+        /// </summary>
         public struct TransformState
         {
+            /// <summary>
+            /// The position component of the transform state in world space coordinates.
+            /// </summary>
             public Vector3 Position;
+
+            /// <summary>
+            /// The rotation component of the transform state as a quaternion.
+            /// </summary>
             public Quaternion Rotation;
+
+            /// <summary>
+            /// The scale component of the transform state in local space.
+            /// </summary>
             public Vector3 Scale;
         }
 

com.unity.netcode.gameobjects/Runtime/Messaging/RpcTargets/BaseRpcTarget.cs

@@ -29,9 +29,9 @@ internal BaseRpcTarget(NetworkManager manager)
         }
 
         /// <summary>
-        /// Can be used to provide additional lock checks before disposing the target.
+        /// Verifies the target can be disposed based on its lock state.
         /// </summary>
-        /// <exception cref="Exception">The exception thrown if the target is still locked when disposed.</exception>
+        /// <exception cref="Exception">Thrown when attempting to dispose a locked temporary RPC target</exception>
         protected void CheckLockBeforeDispose()
         {
             if (m_Locked)
@@ -41,7 +41,7 @@ protected void CheckLockBeforeDispose()
         }
 
         /// <summary>
-        /// Invoked when the target is disposed.
+        /// Releases resources used by the RPC target.
         /// </summary>
         public abstract void Dispose();
 

com.unity.netcode.gameobjects/Runtime/NetworkVariable/Collections/NetworkList.cs

@@ -21,12 +21,12 @@ public class NetworkList<T> : NetworkVariableBase where T : unmanaged, IEquatabl
         public delegate void OnListChangedDelegate(NetworkListEvent<T> changeEvent);
 
         /// <summary>
-        /// The callback to be invoked when the list gets changed
+        /// Creates A NetworkList/>
         /// </summary>
         public event OnListChangedDelegate OnListChanged;
 
         /// <summary>
-        /// Constructor method for <see cref="NetworkList"/>
+        /// Constructor method for <see cref="NetworkList{T}"/>
         /// </summary>
         public NetworkList() { }
 
@@ -132,7 +132,7 @@ public override void WriteDelta(FastBufferWriter writer)
             }
         }
 
-        /// <inheritdoc cref="NetworkVariable{T}.Writeield"/>
+        /// <inheritdoc cref="NetworkVariable{T}.WriteField"/>
         public override void WriteField(FastBufferWriter writer)
         {
             writer.WriteValueSafe((ushort)m_List.Length);
@@ -158,12 +158,12 @@ public override void ReadField(FastBufferReader reader)
         /// <inheritdoc cref="NetworkVariable{T}.ReadDelta"/>
         public override void ReadDelta(FastBufferReader reader, bool keepDirtyDelta)
         {
-            /// This is only invoked by <see cref="NetworkVariableDeltaMessage"/> and the only time
-            /// keepDirtyDelta is set is when it is the server processing. To be able to handle previous
-            /// versions, we use IsServer to keep the dirty states received and the keepDirtyDelta to
-            /// actually mark this as dirty and add it to the list of <see cref="NetworkObject"/>s to
-            /// be updated. With the forwarding of deltas being handled by <see cref="NetworkVariableDeltaMessage"/>,
-            /// once all clients have been forwarded the dirty events, we clear them by invoking <see cref="PostDeltaRead"/>.
+            // This is only invoked by <see cref="NetworkVariableDeltaMessage"/> and the only time
+            // keepDirtyDelta is set is when it is the server processing. To be able to handle previous
+            // versions, we use IsServer to keep the dirty states received and the keepDirtyDelta to
+            // actually mark this as dirty and add it to the list of <see cref="NetworkObject"/>s to
+            // be updated. With the forwarding of deltas being handled by <see cref="NetworkVariableDeltaMessage"/>,
+            // once all clients have been forwarded the dirty events, we clear them by invoking <see cref="PostDeltaRead"/>.
             var isServer = m_NetworkManager.IsServer;
             reader.ReadValueSafe(out ushort deltaCount);
             for (int i = 0; i < deltaCount; i++)
@@ -406,13 +406,22 @@ internal override void PostDeltaRead()
             }
         }
 
-        /// <inheritdoc cref="NetworkVariable{T}.GetEnumerator"/>
+        /// <summary>
+        /// Returns an enumerator that iterates through the <see cref="NetworkList{T}" />.
+        /// </summary>
+        /// <returns>An enumerator for the <see cref="NetworkList{T}"/>.</returns>
         public IEnumerator<T> GetEnumerator()
         {
             return m_List.GetEnumerator();
         }
 
-        /// <inheritdoc cref="NetworkVariable{T}.Add"/>
+        /// <summary>
+        /// Adds an item to the end of the <see cref="NetworkList{T}"/>.
+        /// </summary>
+        /// <param name="item">The item to be added to the list.</param>
+        /// <remarks>
+        /// This method checks for write permissions before adding the item.
+        /// </remarks>
         public void Add(T item)
         {
             // check write permissions
@@ -434,7 +443,12 @@ public void Add(T item)
             HandleAddListEvent(listEvent);
         }
 
-        /// <inheritdoc cref="NetworkVariable{T}.Clear"/>
+        /// <summary>
+        /// Removes all items from the <see cref="NetworkList{T}"/>.
+        /// </summary>
+        /// <remarks>
+        /// This method checks for write permissions before clearing the list.
+        /// </remarks>
         public void Clear()
         {
             // check write permissions
@@ -454,14 +468,25 @@ public void Clear()
             HandleAddListEvent(listEvent);
         }
 
-        /// <inheritdoc cref="NetworkVariable{T}.Contains"/>
+        /// <summary>
+        /// Determines whether the <see cref="NetworkList{T}"/> contains a specific value.
+        /// </summary>
+        /// <param name="item">The object to locate in the <see cref="NetworkList{T}"/>.</param>
+        /// <returns><see langword="true" /> if the <see cref="item"/> is found in the <see cref="NetworkList{T}"/>; otherwise, <see langword="false" />.</returns>
         public bool Contains(T item)
         {
             int index = m_List.IndexOf(item);
             return index != -1;
         }
 
-        /// <inheritdoc cref="NetworkVariable{T}.Remove"/>
+        /// <summary>
+        /// Removes the first occurrence of a specific object from the NetworkList.
+        /// </summary>
+        /// <remarks>
+        /// This method checks for write permissions before removing the item.
+        /// </remarks>
+        /// <param name="item">The object to remove from the list.</param>
+        /// <returns><see langword="true" /> if the item was successfully removed from the list; otherwise, <see langword="false" />.</returns>
         public bool Remove(T item)
         {
             // check write permissions
@@ -488,16 +513,29 @@ public bool Remove(T item)
             return true;
         }
 
-        /// <inheritdoc cref="NetworkVariable{T}.Count"/>
+        /// <summary>
+        /// Gets the number of elements contained in the <see cref="NetworkList{T}"/>.
+        /// </summary>
         public int Count => m_List.Length;
 
-        /// <inheritdoc cref="NetworkVariable{T}.IndexOf"/>
+        /// <summary>
+        /// Determines the index of a specific <see cref="item"/> in the <see cref="NetworkList{T}"/>.
+        /// </summary>
+        /// <param name="item">The object to remove from the list.</param>
+        /// <returns>The index of the <see cref="item"/> if found in the list; otherwise, -1.</returns>
         public int IndexOf(T item)
         {
             return m_List.IndexOf(item);
         }
 
-        /// <inheritdoc cref="NetworkVariable{T}.Insert"/>
+        /// <summary>
+        /// Inserts <see cref="item"/> to the <see cref="NetworkList{T}"/> at the specified <see cref="index"/>.
+        /// </summary>
+        /// <remarks>
+        /// This method checks for write permissions before inserting the item.
+        /// </remarks>
+        /// <param name="index">The index at which the item should be inserted.</param>
+        /// <param name="item">The item to insert.</param>
         public void Insert(int index, T item)
         {
             // check write permissions
@@ -527,7 +565,13 @@ public void Insert(int index, T item)
             HandleAddListEvent(listEvent);
         }
 
-        /// <inheritdoc cref="NetworkVariable{T}.RemoveAt"/>
+        /// <summary>
+        /// Removes the <see cref="NetworkList{T}"/> item at the specified <see cref="index"/>.
+        /// </summary>
+        /// <remarks>
+        /// This method checks for write permissions before removing the item.
+        /// </remarks>
+        /// <param name="index">The index of the element to remove.</param>
         public void RemoveAt(int index)
         {
             // check write permissions
@@ -549,9 +593,14 @@ public void RemoveAt(int index)
             HandleAddListEvent(listEvent);
         }
 
-
-
-        /// <inheritdoc cref="NetworkVariable{T}.this"/>
+        /// <summary>
+        /// Gets or sets the element at the specified index in the <see cref="NetworkList{T}"/>.
+        /// </summary>
+        /// <remarks>
+        /// This method checks for write permissions before setting the value.
+        /// </remarks>
+        /// <param name="index">The zero-based index of the element to get or set.</param>
+        /// <value>The element at the specified index.</value>
         public T this[int index]
         {
             get => m_List[index];
@@ -587,7 +636,7 @@ private void HandleAddListEvent(NetworkListEvent<T> listEvent)
         }
 
         /// <summary>
-        /// This is actually unused left-over from a previous interface
+        /// This method should not be used. It is left over from a previous interface
         /// </summary>
         public int LastModifiedTick
         {