Skip to content

Commit f82f8cd

Browse files
author
Aurimas Petrovas
committed
more xml doc fixes
1 parent eb3b742 commit f82f8cd

File tree

17 files changed

+57
-57
lines changed

17 files changed

+57
-57
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ public static ActionBuffers FromDiscreteActions(float[] discreteActions)
4343
/// <summary>
4444
/// Construct an <see cref="ActionBuffers"/> instance with the continuous and discrete actions that will
4545
/// be used.
46-
/// /// </summary>
46+
/// </summary>
4747
/// <param name="continuousActions">The continuous actions to send to an <see cref="IActionReceiver"/>.</param>
4848
/// <param name="discreteActions">The discrete actions to send to an <see cref="IActionReceiver"/>.</param>
4949
public ActionBuffers(float[] continuousActions, int[] discreteActions)
@@ -63,7 +63,7 @@ public ActionBuffers(ActionSegment<float> continuousActions, ActionSegment<int>
6363

6464
/// <summary>
6565
/// Construct an <see cref="ActionBuffers"/> instance with <see cref="ActionSpec"/>. All values are initialized to zeros.
66-
/// /// </summary>
66+
/// </summary>
6767
/// <param name="actionSpec">The <see cref="ActionSpec"/> to send to an <see cref="IActionReceiver"/>.</param>
6868
public ActionBuffers(ActionSpec actionSpec)
6969
: this(new ActionSegment<float>(new float[actionSpec.NumContinuousActions]),

‎com.unity.ml-agents/Runtime/Actuators/IActuator.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ public interface IActuator : IActionReceiver, IHeuristicProvider
1414
/// <summary>
1515
/// Gets the name of this IActuator which will be used to sort it.
1616
/// </summary>
17-
/// <returns>The string name of this `IActuator`</returns>
17+
/// <value>The string name of this `IActuator`</value>
1818
string Name { get; }
1919

2020
/// <summary>
@@ -32,7 +32,7 @@ public static class IActuatorExtensions
3232
/// <summary>
3333
/// Returns the number of discrete branches + the number of continuous actions.
3434
/// </summary>
35-
/// <param name="actuator"></param>
35+
/// <param name="actuator">Actuator</param>
3636
/// <returns>The number possible actions.</returns>
3737
public static int TotalNumberOfActions(this IActuator actuator)
3838
{

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -687,7 +687,7 @@ internal void ReloadPolicy()
687687
/// <summary>
688688
/// Returns the current step counter (within the current episode).
689689
/// </summary>
690-
/// <returns>The current step count.</returns>
690+
/// <value>The current step count.</value>
691691
public int StepCount
692692
{
693693
get { return m_StepCount; }

‎com.unity.ml-agents/Runtime/Communicator/UnityRLCapabilities.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ public UnityRLCapabilities(
3636

3737
/// <summary>
3838
/// Will print a warning to the console if Python does not support base capabilities and will
39-
/// return <value>true</value> if the warning was printed.
39+
/// return true if the warning was printed.
4040
/// </summary>
4141
/// <returns>True if the warning was printed, False if not.</returns>
4242
public bool WarnOnPythonMissingBaseRLCapabilities()

‎com.unity.ml-agents/Runtime/Demonstrations/DemonstrationWriter.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public class DemonstrationWriter
2626
/// Create a DemonstrationWriter that will write to the specified stream.
2727
/// The stream must support writes and seeking.
2828
/// </summary>
29-
/// <param name="stream"></param>
29+
/// <param name="stream">Target stream</param>
3030
public DemonstrationWriter(Stream stream)
3131
{
3232
m_Writer = stream;

‎com.unity.ml-agents/Runtime/InplaceArray.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ namespace Unity.MLAgents
1010
/// <remarks>
1111
/// This does not implement any interfaces such as IList, in order to avoid any accidental boxing allocations.
1212
/// </remarks>
13-
/// <typeparam name="T"></typeparam>
13+
/// <typeparam name="T">T</typeparam>
1414
public struct InplaceArray<T> : IEquatable<InplaceArray<T>> where T : struct
1515
{
1616
private const int k_MaxLength = 4;
@@ -85,7 +85,7 @@ public InplaceArray(T elem0, T elem1, T elem2, T elem3)
8585
/// </summary>
8686
/// <param name="elems">The `IList` to construct the array from.</param>
8787
/// <returns>Corresponding `InplaceArray` from the input IList.</returns>
88-
/// <exception cref="ArgumentOutOfRangeException"></exception>
88+
/// <exception cref="ArgumentOutOfRangeException">Argument out of range</exception>
8989
public static InplaceArray<T> FromList(IList<T> elems)
9090
{
9191
switch (elems.Count)
@@ -107,7 +107,7 @@ public static InplaceArray<T> FromList(IList<T> elems)
107107
/// Per-element access.
108108
/// </summary>
109109
/// <param name="index">The index to get or set.</param>
110-
/// <exception cref="IndexOutOfRangeException"></exception>
110+
/// <exception cref="IndexOutOfRangeException">Index out of range</exception>
111111
public T this[int index]
112112
{
113113
get
@@ -171,7 +171,7 @@ public int Length
171171
/// Returns a string representation of the array's elements.
172172
/// </summary>
173173
/// <returns>The string summary of the `InplaceArray`.</returns>
174-
/// <exception cref="IndexOutOfRangeException"></exception>
174+
/// <exception cref="IndexOutOfRangeException">Index out of range</exception>
175175
public override string ToString()
176176
{
177177
switch (m_Length)

‎com.unity.ml-agents/Runtime/Integrations/Match3/Match3Actuator.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ public class Match3Actuator : IActuator, IBuiltInActuator
1919
/// <summary>
2020
/// Create a Match3Actuator.
2121
/// </summary>
22-
/// <param name="board"></param>
22+
/// <param name="board">Board</param>
2323
/// <param name="forceHeuristic">Whether the inference action should be ignored and the Agent's Heuristic
2424
/// should be called. This should only be used for generating comparison stats of the Heuristic.</param>
2525
/// <param name="seed">The seed used to initialize <see cref="System.Random"/>.</param>
26-
/// <param name="name"></param>
26+
/// <param name="name">Name</param>
2727
public Match3Actuator(AbstractBoard board,
2828
bool forceHeuristic,
2929
int seed,

‎com.unity.ml-agents/Runtime/Integrations/Match3/Match3Sensor.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ namespace Unity.MLAgents.Integrations.Match3
88
/// <summary>
99
/// Delegate that provides integer values at a given (x,y) coordinate.
1010
/// </summary>
11-
/// <param name="x"></param>
12-
/// <param name="y"></param>
11+
/// <param name="x">X</param>
12+
/// <param name="y">Y</param>
1313
public delegate int GridValueProvider(int x, int y);
1414

1515
/// <summary>

‎com.unity.ml-agents/Runtime/Integrations/Match3/Move.cs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,9 @@ public struct Move
6565
/// the Move corresponding to an Agent decision.
6666
/// </summary>
6767
/// <param name="moveIndex">Must be between 0 and NumPotentialMoves(maxRows, maxCols).</param>
68-
/// <param name="maxBoardSize"></param>
68+
/// <param name="maxBoardSize">Max board size</param>
6969
/// <returns>Corresponding `Move`.</returns>
70-
/// <exception cref="ArgumentOutOfRangeException"></exception>
70+
/// <exception cref="ArgumentOutOfRangeException">Argument out of range</exception>
7171
public static Move FromMoveIndex(int moveIndex, BoardSize maxBoardSize)
7272
{
7373
var maxRows = maxBoardSize.Rows;
@@ -104,7 +104,7 @@ public static Move FromMoveIndex(int moveIndex, BoardSize maxBoardSize)
104104
/// <summary>
105105
/// Increment the Move to the next MoveIndex, and update the Row, Column, and Direction accordingly.
106106
/// </summary>
107-
/// <param name="maxBoardSize"></param>
107+
/// <param name="maxBoardSize">Max board size</param>
108108
public void Next(BoardSize maxBoardSize)
109109
{
110110
var maxRows = maxBoardSize.Rows;
@@ -143,10 +143,10 @@ public void Next(BoardSize maxBoardSize)
143143
/// <summary>
144144
/// Construct a Move from the row, column, direction, and board size.
145145
/// </summary>
146-
/// <param name="row"></param>
147-
/// <param name="col"></param>
148-
/// <param name="dir"></param>
149-
/// <param name="maxBoardSize"></param>
146+
/// <param name="row">Row</param>
147+
/// <param name="col">Col</param>
148+
/// <param name="dir">Dir</param>
149+
/// <param name="maxBoardSize">Max board size</param>
150150
/// <returns>Corresponding `Move`.</returns>
151151
public static Move FromPositionAndDirection(int row, int col, Direction dir, BoardSize maxBoardSize)
152152
{
@@ -208,7 +208,7 @@ public static Move FromPositionAndDirection(int row, int col, Direction dir, Boa
208208
/// Check if the move is valid for the given board size.
209209
/// This will be passed the return value from AbstractBoard.GetCurrentBoardSize().
210210
/// </summary>
211-
/// <param name="boardSize"></param>
211+
/// <param name="boardSize">Board size</param>
212212
/// <returns>True if move is valide given input `boardSize`, False if not.</returns>
213213
public bool InRangeForBoard(BoardSize boardSize)
214214
{
@@ -223,7 +223,7 @@ public bool InRangeForBoard(BoardSize boardSize)
223223
/// Get the other row and column that correspond to this move.
224224
/// </summary>
225225
/// <returns>Corresponding other (row, column) tuple for this move.</returns>
226-
/// <exception cref="ArgumentOutOfRangeException"></exception>
226+
/// <exception cref="ArgumentOutOfRangeException">Argument out of range</exception>
227227
public (int Row, int Column) OtherCell()
228228
{
229229
switch (Direction)
@@ -267,7 +267,7 @@ public Direction OtherDirection()
267267
/// Return the number of potential moves for a board of the given size.
268268
/// This is equivalent to the number of internal edges in the board.
269269
/// </summary>
270-
/// <param name="maxBoardSize"></param>
270+
/// <param name="maxBoardSize">Max board size</param>
271271
/// <returns>Number of potential moves given a boardsize.</returns>
272272
public static int NumPotentialMoves(BoardSize maxBoardSize)
273273
{

‎com.unity.ml-agents/Runtime/SensorHelper.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,8 @@ public static bool CompareObservation(ISensor sensor, float[] expected, out stri
7777
/// simplifying unit tests.
7878
/// </summary>
7979
/// <param name="sensor">`ISensor` to generate observation from.</param>
80-
/// <param name="expected"></param>
81-
/// <param name="errorMessage"></param>
80+
/// <param name="expected">The expected observations.</param>
81+
/// <param name="errorMessage">The error message to throw if sensor observation doesn't match.</param>
8282
/// <returns>True if the generated observation for the provided sensor equal the expected values, False if not.</returns>
8383
public static bool CompareObservation(ISensor sensor, float[,,] expected, out string errorMessage)
8484
{

0 commit comments

Comments
 (0)