Update docs to pass doc validation. (#4953)

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

@@ -72,7 +72,6 @@ public static ActionSpec MakeDiscrete(params int[] branchSizes)
  /// <param name="numContinuousActions">The number of continuous actions available.</param>
  /// <param name="discreteBranchSizes">The array of branch sizes for the discrete actions. Each index
  /// contains the number of actions available for that branch.</param>
- /// <returns>An ActionSpec initialized with the specified action sizes.</returns>
  public ActionSpec(int numContinuousActions = 0, int[] discreteBranchSizes = null)
  {
  m_NumContinuousActions = numContinuousActions;

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

@@ -8,17 +8,49 @@ namespace Unity.MLAgents.Sensors
  /// </summary>
  public enum BuiltInSensorType
  {
+ /// <summary>
+ /// Default Sensor type if it cannot be determined.
+ /// </summary>
  Unknown = 0,
+ /// <summary>
+ /// The Vector sensor used by the agent.
+ /// </summary>
  VectorSensor = 1,
- // Note that StackingSensor actually returns the wrapped sensor's type
+ /// <summary>
+ /// The Stacking Sensor type. NOTE: StackingSensor actually returns the wrapped sensor's type.
+ /// </summary>
  StackingSensor = 2,
+ /// <summary>
+ /// The RayPerception Sensor types, both 3D and 2D.
+ /// </summary>
  RayPerceptionSensor = 3,
+ /// <summary>
+ /// The observable attribute sensor type.
+ /// </summary>
  ReflectionSensor = 4,
+ /// <summary>
+ /// Sensors that use the Camera for observations.
+ /// </summary>
  CameraSensor = 5,
+ /// <summary>
+ /// Sensors that use RenderTextures for observations.
+ /// </summary>
  RenderTextureSensor = 6,
+ /// <summary>
+ /// Sensors that use buffers or tensors for observations.
+ /// </summary>
  BufferSensor = 7,
+ /// <summary>
+ /// The sensors that observe properties of rigid bodies.
+ /// </summary>
  PhysicsBodySensor = 8,
+ /// <summary>
+ /// The sensors that observe Match 3 boards.
+ /// </summary>
  Match3Sensor = 9,
+ /// <summary>
+ /// Sensors that break down the world into a grid of colliders to observe an area at a pre-defined granularity.
+ /// </summary>
  GridSensor = 10
  }
 
@@ -34,6 +66,4 @@ public interface IBuiltInSensor
  /// <returns>A BuiltInSensorType corresponding to the sensor.</returns>
  BuiltInSensorType GetBuiltInSensorType();
  }
-
-
 }

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

@@ -145,6 +145,11 @@ public void AddRange(IEnumerable<float> data, int writeOffset = 0)
  }
  }
 
+ /// <summary>
+ /// Write the list of floats.
+ /// </summary>
+ /// <param name="data">The actual list of floats to write.</param>
+ /// <param name="writeOffset">Optional write offset to start writing from.</param>
  public void AddList(IList<float> data, int writeOffset = 0)
  {
  if (m_Data != null)
@@ -153,7 +158,6 @@ public void AddList(IList<float> data, int writeOffset = 0)
  {
  var val = data[index];
  m_Data[index + m_Offset + writeOffset] = val;
-
  }
  }
  else

com.unity.ml-agents/Runtime/SideChannels/TrainingAnalyticsSideChannel.cs

@@ -5,6 +5,9 @@
 
 namespace Unity.MLAgents.SideChannels
 {
+ /// <summary>
+ /// Side Channel implementation for recording which training features are being used.
+ /// </summary>
  public class TrainingAnalyticsSideChannel : SideChannel
  {
  const string k_TrainingAnalyticsConfigId = "b664a4a9-d86f-5a5f-95cb-e8353a7e8356";