Skip to content

Commit eb3b742

Browse files
author
Aurimas Petrovas
committed
test xmldoc fixes
1 parent 3ce9849 commit eb3b742

File tree

3 files changed

+5
-3
lines changed

3 files changed

+5
-3
lines changed

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ public static bool IsInitialized
136136
/// <summary>
137137
/// Reports whether or not the communicator is on.
138138
/// </summary>
139-
/// <see cref="ICommunicator"/>
139+
/// <seealso cref="ICommunicator"/>
140140
/// <value>
141141
/// <c>True</c>, if communicator is on, <c>false</c> otherwise.
142142
/// </value>
@@ -400,7 +400,7 @@ static int ReadPortFromArgs()
400400
/// then the values of the parameters generated from the training process can be
401401
/// retrieved here.
402402
/// </summary>
403-
/// <returns>The `EnvironmentParameters` instance.</returns>
403+
/// <value>The `EnvironmentParameters` instance.</value>
404404
public EnvironmentParameters EnvironmentParameters
405405
{
406406
get { return m_EnvironmentParameters; }

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ public abstract class ActuatorComponent : MonoBehaviour
1919
/// The specification of the possible actions for this ActuatorComponent.
2020
/// This must produce the same results as the corresponding IActuator's ActionSpec.
2121
/// </summary>
22-
/// <see cref="ActionSpec"/>
22+
/// <seealso cref="ActionSpec"/>
2323
public abstract ActionSpec ActionSpec { get; }
2424
}
2525
}

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

+2
Original file line numberDiff line numberDiff line change
@@ -239,9 +239,11 @@ internal struct AgentParameters
239239
/// reset and start a new training episode rather than continue to fail.
240240
/// </remarks>
241241
/// <example>
242+
/// <para>
242243
/// To use a step limit when training while allowing agents to run without resetting
243244
/// outside of training, you can set the max step to 0 in <see cref="Initialize"/>
244245
/// if the <see cref="Academy"/> is not connected to an external process.
246+
/// <para>
245247
/// <code>
246248
/// using Unity.MLAgents;
247249
///

0 commit comments

Comments
 (0)