Documented AbsoluteForkEval (chesslablab#633)

src/Eval/AbsoluteForkEval.php

@@ -7,12 +7,27 @@
 use Chess\Variant\AbstractPiece;
 use Chess\Variant\Classical\PGN\AN\Piece;
 
+/**
+ * Absolute Fork Evaluation
+ *
+ * A fork is a tactic in which a piece attacks multiple enemy pieces
+ * simultaneously. A fork is a type of double attack. If the king is one of the
+ * attacked pieces, the term absolute fork is then used.
+ */
 class AbsoluteForkEval extends AbstractEval implements ElaborateEvalInterface
 {
     use ElaborateEvalTrait;
 
+    /**
+     * The name of the heuristic.
+     *
+     * @var string
+     */
     const NAME = 'Absolute fork';
 
+    /**
+     * @param \Chess\Variant\AbstractBoard $board
+     */
     public function __construct(AbstractBoard $board)
     {
         $this->board = $board;
@@ -31,6 +46,11 @@ public function __construct(AbstractBoard $board)
         }
     }
 
+    /**
+     * Elaborate on the evaluation.
+     *
+     * @param \Chess\Variant\AbstractPiece $piece
+     */
     private function elaborate(AbstractPiece $piece): void
     {
         $phrase = PiecePhrase::create($piece);