Documented RelativeForkEval

Author: programarivm

src/Eval/RelativeForkEval.php

@@ -7,15 +7,30 @@
 use Chess\Variant\AbstractPiece;
 use Chess\Variant\Classical\PGN\AN\Piece;
 
+/**
+ * Relative Fork Evaluation
+ *
+ * A fork is a tactic in which a piece attacks multiple pieces at the same time.
+ * It is a double attack. A fork not involving the enemy king is a relative
+ * fork.
+ */
 class RelativeForkEval extends AbstractEval implements
     ElaborateEvalInterface,
     ExplainEvalInterface
 {
     use ElaborateEvalTrait;
     use ExplainEvalTrait;
 
+    /**
+     * The name of the heuristic.
+     *
+     * @var string
+     */
     const NAME = 'Relative fork';
 
+    /**
+     * @param \Chess\Variant\AbstractBoard $board
+     */
     public function __construct(AbstractBoard $board)
     {
         $this->board = $board;
@@ -52,6 +67,11 @@ public function __construct(AbstractBoard $board)
         $this->explain($this->result);
     }
 
+    /**
+     * Elaborate on the evaluation.
+     *
+     * @param \Chess\Variant\AbstractPiece $piece
+     */
     private function elaborate(AbstractPiece $piece): void
     {
         $phrase = PiecePhrase::create($piece);