fix all PVS and doc generation warnings (#5262)

Author: Chris Elion

com.unity.ml-agents/Runtime/Actuators/ActionSegment.cs

@@ -116,19 +116,29 @@ public bool IsEmpty()
             return Array == null || Array.Length == 0;
         }
 
-        /// <inheritdoc/>
+        /// <summary>
+        /// Returns an enumerator that iterates through the ActionSegment.
+        /// </summary>
+        /// <returns>An IEnumerator object that can be used to iterate through the ActionSegment.</returns>
         IEnumerator<T> IEnumerable<T>.GetEnumerator()
         {
             return new Enumerator(this);
         }
 
-        /// <inheritdoc/>
+        /// <summary>
+        /// Returns an enumerator that iterates through the ActionSegment.
+        /// </summary>
+        /// <returns>An IEnumerator object that can be used to iterate through the ActionSegment.</returns>
         public IEnumerator GetEnumerator()
         {
             return new Enumerator(this);
         }
 
-        /// <inheritdoc/>
+        /// <summary>
+        /// Indicates whether the current ActionSegment is equal to another ActionSegment.
+        /// </summary>
+        /// <param name="obj">An ActionSegment to compare with this ActionSegment.</param>
+        /// <returns>true if the current ActionSegment is equal to the other parameter; otherwise, false.</returns>
         public override bool Equals(object obj)
         {
             if (!(obj is ActionSegment<T>))
@@ -138,13 +148,20 @@ public override bool Equals(object obj)
             return Equals((ActionSegment<T>)obj);
         }
 
-        /// <inheritdoc/>
+        /// <summary>
+        /// Indicates whether the current ActionSegment is equal to another ActionSegment.
+        /// </summary>
+        /// <param name="other">An ActionSegment to compare with this ActionSegment.</param>
+        /// <returns>true if the current ActionSegment is equal to the other parameter; otherwise, false.</returns>
         public bool Equals(ActionSegment<T> other)
         {
             return Offset == other.Offset && Length == other.Length && Array.SequenceEqual(other.Array);
         }
 
-        /// <inheritdoc/>
+        /// <summary>
+        /// Computes the hash code of the ActionSegment.
+        /// </summary>
+        /// <returns>A hash code for the current ActionSegment.</returns>
         public override int GetHashCode()
         {
             unchecked

com.unity.ml-agents/Runtime/Actuators/IActionReceiver.cs

@@ -127,7 +127,11 @@ public bool IsEmpty()
             return ContinuousActions.IsEmpty() && DiscreteActions.IsEmpty();
         }
 
-        /// <inheritdoc/>
+        /// <summary>
+        /// Indicates whether the current ActionBuffers is equal to another ActionBuffers.
+        /// </summary>
+        /// <param name="obj">An ActionBuffers to compare with this ActionBuffers.</param>
+        /// <returns>true if the current ActionBuffers is equal to the other parameter; otherwise, false.</returns>
         public override bool Equals(object obj)
         {
             if (!(obj is ActionBuffers))
@@ -140,7 +144,10 @@ public override bool Equals(object obj)
                 ab.DiscreteActions.SequenceEqual(DiscreteActions);
         }
 
-        /// <inheritdoc/>
+        /// <summary>
+        /// Computes the hash code of the ActionBuffers.
+        /// </summary>
+        /// <returns>A hash code for the current ActionBuffers.</returns>
         public override int GetHashCode()
         {
             unchecked

com.unity.ml-agents/Runtime/Agent.cs

@@ -1151,7 +1151,7 @@ void ResetSensors()
         ///     - <see cref="VectorSensor.AddObservation(Vector2)"/>
         ///     - <see cref="VectorSensor.AddObservation(Quaternion)"/>
         ///     - <see cref="VectorSensor.AddObservation(bool)"/>
-        ///     - <see cref="VectorSensor.AddObservation(IEnumerable{float})"/>
+        ///     - <see cref="VectorSensor.AddObservation(IList{float})"/>
         ///     - <see cref="VectorSensor.AddOneHotObservation(int, int)"/>
         ///
         /// You can use any combination of these helper functions to build the agent's

com.unity.ml-agents/Runtime/Sensors/BufferSensorComponent.cs

@@ -11,7 +11,7 @@ public class BufferSensorComponent : SensorComponent
     {
 
         /// <summary>
-        /// Name of the generated <see cref="bufferSensor"/> object.
+        /// Name of the generated <see cref="BufferSensor"/> object.
         /// Note that changing this at runtime does not affect how the Agent sorts the sensors.
         /// </summary>
         public string SensorName

com.unity.ml-agents/Runtime/Sensors/CompressionSpec.cs

@@ -41,13 +41,17 @@ public SensorCompressionType SensorCompressionType
 
         internal int[] m_CompressedChannelMapping;
 
+        /// <summary>
         /// The mapping of the channels in compressed data to the actual channel after decompression.
+        /// </summary>
+        /// <remarks>
         /// The mapping is a list of integer index with the same length as
         /// the number of output observation layers (channels), including padding if there's any.
         /// Each index indicates the actual channel the layer will go into.
         /// Layers with the same index will be averaged, and layers with negative index will be dropped.
         /// For example, mapping for CameraSensor using grayscale and stacking of two: [0, 0, 0, 1, 1, 1]
         /// Mapping for GridSensor of 4 channels and stacking of two: [0, 1, 2, 3, -1, -1, 4, 5, 6, 7, -1, -1]
+        /// </remarks>
         public int[] CompressedChannelMapping
         {
             get => m_CompressedChannelMapping;

com.unity.ml-agents/Runtime/Sensors/StackingSensor.cs

@@ -200,6 +200,7 @@ public byte[] GetCompressedObservation()
             return outputBytes;
         }
 
+        /// <inheritdoc/>
         public CompressionSpec GetCompressionSpec()
         {
             var wrappedSpec = m_WrappedSensor.GetCompressionSpec();

com.unity.ml-agents/Runtime/Sensors/VectorSensor.cs

@@ -21,6 +21,7 @@ public class VectorSensor : ISensor, IBuiltInSensor
         /// </summary>
         /// <param name="observationSize">Number of vector observations.</param>
         /// <param name="name">Name of the sensor.</param>
+        /// <param name="observationType"></param>
         public VectorSensor(int observationSize, string name = null, ObservationType observationType = ObservationType.Default)
         {
             if (string.IsNullOrEmpty(name))

com.unity.ml-agents/Runtime/Sensors/VectorSensorComponent.cs

@@ -60,6 +60,7 @@ public override ISensor[] CreateSensors()
         /// <summary>
         /// Returns the underlying VectorSensor
         /// </summary>
+        /// <returns></returns>
         public VectorSensor GetSensor()
         {
             return m_Sensor;