Inline docstrings where return is void and method takes no parameters

This commit is contained in:
Imbus 2023-12-10 14:53:50 +01:00
parent 196f066281
commit a6dba79d9d

View file

@ -1,40 +1,34 @@
package sudoku; package sudoku;
/** Solver is a class that implements the SudokuSolver interface */
public class Solver implements SudokuSolver { public class Solver implements SudokuSolver {
private int[][] board = null; private int[][] board = null;
private int tries = 0; private int tries = 0;
/** Constructor */
public Solver() { public Solver() {
board = new int[9][9]; board = new int[9][9];
} }
/** /** {@inheritDoc} */
* {@inheritDoc}
*/
@Override @Override
public void setBoard(int[][] board) { public void setBoard(int[][] board) {
this.board = board; this.board = board;
} }
/** /** {@inheritDoc} */
* {@inheritDoc}
*/
@Override @Override
public int[][] getBoard() { public int[][] getBoard() {
return board; return board;
} }
/** /** Resets the board to all zeros */
* Resets the board to all zeros
*/
@Override @Override
public void clear() { public void clear() {
board = new int[9][9]; board = new int[9][9];
} }
/** /*{@inheritDoc} */
* {@inheritDoc}
*/
@Override @Override
public boolean solve() { public boolean solve() {
return solve(0, 0); return solve(0, 0);
@ -98,9 +92,7 @@ public class Solver implements SudokuSolver {
randomizeBoard(3); randomizeBoard(3);
} }
/** /** {@inheritDoc} */
* {@inheritDoc}
*/
@Override @Override
public void randomizeBoard(int difficulty) { public void randomizeBoard(int difficulty) {
int amount_prefilled = (difficulty * 9) + 1; int amount_prefilled = (difficulty * 9) + 1;
@ -121,9 +113,7 @@ public class Solver implements SudokuSolver {
} }
} }
/** /** {@inheritDoc} */
* {@inheritDoc}
*/
@Override @Override
public void set(int row, int col, int val) { public void set(int row, int col, int val) {
if (row < 9 && col < 9) { if (row < 9 && col < 9) {
@ -131,9 +121,7 @@ public class Solver implements SudokuSolver {
} }
} }
/** /** {@inheritDoc} */
* {@inheritDoc}
*/
@Override @Override
public int get(int row, int col) { public int get(int row, int col) {
if (row < 9 && col < 9) { if (row < 9 && col < 9) {
@ -142,9 +130,7 @@ public class Solver implements SudokuSolver {
return 0; return 0;
} }
/** /** {@inheritDoc} */
* {@inheritDoc}
*/
@Override @Override
public boolean isLegal(int row, int col, int num) { public boolean isLegal(int row, int col, int num) {
// Sanity check // Sanity check
@ -174,9 +160,7 @@ public class Solver implements SudokuSolver {
return true; return true;
} }
/** /** {@inheritDoc} */
* {@inheritDoc}
*/
public boolean isSolvable() { public boolean isSolvable() {
// We want to work on a copy // We want to work on a copy
int[][] copy = new int[9][9]; int[][] copy = new int[9][9];