1 comment

Bram-Hub · Dec 2, 2024 · 174518c · 174518c
1 parent 420a535
commit 174518c
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/src/main/java/edu/rpi/legup/puzzle/minesweeper/rules/TooFewMinesContradictionRule.java b/src/main/java/edu/rpi/legup/puzzle/minesweeper/rules/TooFewMinesContradictionRule.java
@@ -19,6 +19,16 @@ public TooFewMinesContradictionRule() {
                 "edu/rpi/legup/images/minesweeper/contradictions/TooFewMines.png");
     }
 
+    /**
+     * Checks whether the transition has a contradiction at the specific puzzleElement index using
+     * this rule
+     *
+     * @param board board to check contradiction
+     * @param puzzleElement equivalent puzzleElement
+     * @return null if the transition contains a contradiction at the specified puzzleElement,
+     *     otherwise error message
+     */
+
     @Override
     public String checkContradictionAt(Board board, PuzzleElement puzzleElement) {
         MinesweeperBoard minesweeperBoard = (MinesweeperBoard) board;