NetworkVariable corrections and added inheritdocs when API is override

Author: michalChrobot

com.unity.netcode.gameobjects/Runtime/NetworkVariable/AnticipatedNetworkVariable.cs

@@ -284,9 +284,7 @@ public void Update()
             }
         }
 
-        /// <summary>
-        /// Releases all resources used by this network variable
-        /// </summary>
+        /// <inheritdoc/>
         public override void Dispose()
         {
             if (m_IsDisposed)
@@ -391,57 +389,39 @@ public void Smooth(in T from, in T to, float durationSeconds, SmoothDelegate how
             m_HasSmoothValues = true;
         }
 
-        /// <summary>
-        /// Checks if the variable has been modified since the last network synchronization
-        /// </summary>
-        /// <returns>True if the variable needs to be synchronized, false otherwise</returns>
+        /// <inheritdoc/>
         public override bool IsDirty()
         {
             return m_AuthoritativeValue.IsDirty();
         }
 
-        /// <summary>
-        /// Resets the dirty state after network synchronization
-        /// </summary>
+        /// <inheritdoc/>
         public override void ResetDirty()
         {
             m_AuthoritativeValue.ResetDirty();
         }
 
-        /// <summary>
-        /// Writes only the changes in the variable's value to the network stream
-        /// </summary>
-        /// <param name="writer">Buffer to write the delta to</param>
+        /// <inheritdoc/>
         public override void WriteDelta(FastBufferWriter writer)
         {
             m_AuthoritativeValue.WriteDelta(writer);
         }
 
-        /// <summary>
-        /// Writes the complete state of the variable to the network stream
-        /// </summary>
-        /// <param name="writer">Buffer to write the field to</param>
+        /// <inheritdoc/>
         public override void WriteField(FastBufferWriter writer)
         {
             m_AuthoritativeValue.WriteField(writer);
         }
 
-        /// <summary>
-        /// Reads the complete state of the variable from the network stream
-        /// </summary>
-        /// <param name="reader">Buffer to read the field from</param>
+        /// <inheritdoc/>
         public override void ReadField(FastBufferReader reader)
         {
             m_AuthoritativeValue.ReadField(reader);
             NetworkVariableSerialization<T>.Duplicate(m_AuthoritativeValue.Value, ref m_AnticipatedValue);
             NetworkVariableSerialization<T>.Duplicate(m_AnticipatedValue, ref m_PreviousAnticipatedValue);
         }
 
-        /// <summary>
-        /// Reads changes in the variable's value from the network stream
-        /// </summary>
-        /// <param name="reader">Buffer to read the delta from</param>
-        /// <param name="keepDirtyDelta">Whether to maintain the dirty state after reading</param>
+        /// <inheritdoc/>
         public override void ReadDelta(FastBufferReader reader, bool keepDirtyDelta)
         {
             m_AuthoritativeValue.ReadDelta(reader, keepDirtyDelta);

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

@@ -22,10 +22,23 @@ public class NetworkVariable<T> : NetworkVariableBase
         /// </summary>
         public OnValueChangedDelegate OnValueChanged;
 
+        /// <summary>
+        /// Delegate that determines if the difference between two values exceeds a threshold for network synchronization
+        /// </summary>
+        /// <param name="previousValue">The previous value to compare against</param>
+        /// <param name="newValue">The new value to compare</param>
+        /// <returns>True if the difference exceeds the threshold and should be synchronized, false otherwise</returns>
         public delegate bool CheckExceedsDirtinessThresholdDelegate(in T previousValue, in T newValue);
 
+        /// <summary>
+        /// Delegate instance for checking if value changes exceed the dirtiness threshold
+        /// </summary>
         public CheckExceedsDirtinessThresholdDelegate CheckExceedsDirtinessThreshold;
 
+        /// <summary>
+        /// Determines if the current value has changed enough from its previous value to warrant network synchronization
+        /// </summary>
+        /// <returns>True if the value should be synchronized, false otherwise</returns>
         public override bool ExceedsDirtinessThreshold()
         {
             if (CheckExceedsDirtinessThreshold != null && m_HasPreviousValue)
@@ -36,6 +49,9 @@ public override bool ExceedsDirtinessThreshold()
             return true;
         }
 
+        /// <summary>
+        /// Initializes the NetworkVariable by setting up initial and previous values
+        /// </summary>
         public override void OnInitialize()
         {
             base.OnInitialize();
@@ -171,6 +187,7 @@ internal ref T RefValue()
             return ref m_InternalValue;
         }
 
+        /// <inheritdoc/>
         public override void Dispose()
         {
             if (m_IsDisposed)
@@ -201,6 +218,9 @@ public override void Dispose()
             m_PreviousValue = default;
         }
 
+        /// <summary>
+        /// Finalizer that ensures proper cleanup of resources
+        /// </summary>
         ~NetworkVariable()
         {
             Dispose();