docstrings

Author: Chris Elion

com.unity.ml-agents.extensions/Documentation~/Match3.md

@@ -5,6 +5,7 @@ We provide some utilities to integrate ML-Agents with Match-3 games.
 ## AbstractBoard class
 The `AbstractBoard` is the bridge between ML-Agents and your game. It allows ML-Agents to
 * ask your game what the "color" of a cell is
+* ask whether the cell is a "special" piece type or not
 * ask your game whether a move is allowed
 * request that your game make a move
 
@@ -17,6 +18,11 @@ Returns the "color" of piece at the given row and column.
 This should be between 0 and NumCellTypes-1 (inclusive).
 The actual order of the values doesn't matter.
 
+#### `public abstract int GetSpecialType(int row, int col)`
+Returns the special type of the piece at the given row and column.
+This should be between 0 and NumSpecialTypes (inclusive).
+The actual order of the values doesn't matter.
+
 #### `public abstract bool IsMoveValid(Move m)`
 Check whether the particular `Move` is valid for the game.
 The actual results will depend on the rules of the game, but we provide the `SimpleIsMoveValid()` method

com.unity.ml-agents.extensions/Runtime/Match3/AbstractBoard.cs

@@ -5,14 +5,29 @@ namespace Unity.MLAgents.Extensions.Match3
 {
     public abstract class AbstractBoard : MonoBehaviour
     {
+        /// <summary>
+        /// Number of rows on the board
+        /// </summary>
         public int Rows;
+
+        /// <summary>
+        /// Number of columns on the board
+        /// </summary>
         public int Columns;
+
+        /// <summary>
+        /// Maximum number of different types of cells (colors, pieces, etc).
+        /// </summary>
         public int NumCellTypes;
-        public int NumSpecialTypes;
 
+        /// <summary>
+        /// Maximum number of special types. This can be zero, in which case
+        /// all cells of the same type are assumed to be equivalent.
+        /// </summary>
+        public int NumSpecialTypes;
 
         /// <summary>
-        /// Returns the "color" of piece at the given row and column.
+        /// Returns the "color" of the piece at the given row and column.
         /// This should be between 0 and NumCellTypes-1 (inclusive).
         /// The actual order of the values doesn't matter.
         /// </summary>
@@ -21,6 +36,14 @@ public abstract class AbstractBoard : MonoBehaviour
         /// <returns></returns>
         public abstract int GetCellType(int row, int col);
 
+        /// <summary>
+        /// Returns the special type of the piece at the given row and column.
+        /// This should be between 0 and NumSpecialTypes (inclusive).
+        /// The actual order of the values doesn't matter.
+        /// </summary>
+        /// <param name="row"></param>
+        /// <param name="col"></param>
+        /// <returns></returns>
         public abstract int GetSpecialType(int row, int col);
 
         /// <summary>
@@ -41,8 +64,6 @@ public abstract class AbstractBoard : MonoBehaviour
         /// <returns></returns>
         public abstract bool MakeMove(Move m);
 
-        // TODO handle "special" cell types?
-
         public IEnumerable<Move> AllMoves()
         {
             var currentMove = Move.FromMoveIndex(0, Rows, Columns);