Improved the docs

chesslablab · May 8, 2024 · bfcc98f · bfcc98f
1 parent cacd2b8
commit bfcc98f
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/src/Variant/Classical/AbstractPgnParser.php b/src/Variant/Classical/AbstractPgnParser.php
@@ -16,6 +16,16 @@
 use Chess\Variant\Classical\PGN\AN\Color;
 use Chess\Variant\Classical\PGN\AN\Piece;
 
+/**
+ * AbstractPgnParser
+ *
+ * The root class in the hierarchy of chess boards defines the getter and the
+ * setter methods, in addition to implementing the internal methods required to
+ * convert a PGN move in text format into a data structure. 
+ *
+ * @author Jordi Bassagaña
+ * @license MIT
+ */
 class AbstractPgnParser extends \SplObjectStorage
 {
     /**

diff --git a/src/Variant/Classical/Board.php b/src/Variant/Classical/Board.php
@@ -223,7 +223,7 @@ public function getPieceBySq(string $sq): ?AbstractPiece
      *
      * @param string $color
      * @param string $pgn
-     * @return bool true if the move can be made; otherwise false
+     * @return bool
      */
     public function play(string $color, string $pgn): bool
     {
@@ -240,7 +240,7 @@ public function play(string $color, string $pgn): bool
      *
      * @param string $color
      * @param string $lan
-     * @return bool true if the move can be made; otherwise false
+     * @return bool
      */
     public function playLan(string $color, string $lan): bool
     {