From c481f66b0c959aaa51e9c10d7e6fe4524f0de9d1 Mon Sep 17 00:00:00 2001
From: Janet-Doe <lilas.grenier@etu.univ-lyon1.fr>
Date: Sun, 2 Feb 2025 21:03:36 +0100
Subject: [PATCH] add doc + delete unused class

---
 app/src/main/java/sudoku/io/SudokuFile.java     |  7 -------
 app/src/main/java/sudoku/io/SudokuSave.java     | 15 ---------------
 app/src/main/java/sudoku/solver/HintHelper.java |  7 +++++++
 3 files changed, 7 insertions(+), 22 deletions(-)
 delete mode 100644 app/src/main/java/sudoku/io/SudokuFile.java
 delete mode 100644 app/src/main/java/sudoku/io/SudokuSave.java

diff --git a/app/src/main/java/sudoku/io/SudokuFile.java b/app/src/main/java/sudoku/io/SudokuFile.java
deleted file mode 100644
index 2b4e015..0000000
--- a/app/src/main/java/sudoku/io/SudokuFile.java
+++ /dev/null
@@ -1,7 +0,0 @@
-package sudoku.io;
-
-public class SudokuFile {
-
-	
-
-}
diff --git a/app/src/main/java/sudoku/io/SudokuSave.java b/app/src/main/java/sudoku/io/SudokuSave.java
deleted file mode 100644
index 1f5019e..0000000
--- a/app/src/main/java/sudoku/io/SudokuSave.java
+++ /dev/null
@@ -1,15 +0,0 @@
-package sudoku.io;
-
-public class SudokuSave {
-
-	public static enum AlgoResolution {
-		Backtracking,
-		NoBacktring
-	}
-
-	// private final MultiDoku sudoku;
-	// private final AlgoResolution resolution;
-
-	
-
-}
diff --git a/app/src/main/java/sudoku/solver/HintHelper.java b/app/src/main/java/sudoku/solver/HintHelper.java
index 179716f..635ca48 100644
--- a/app/src/main/java/sudoku/solver/HintHelper.java
+++ b/app/src/main/java/sudoku/solver/HintHelper.java
@@ -14,6 +14,13 @@ public class HintHelper {
 
 	public static record Hint(Cell cell, int newValue) {}
 
+	/**
+	 * Si possible, donne un indice sur la résolution du doku passé en paramètre,
+	 * selon la méthode de résolution rensaignée.
+	 * @param doku MultiDoku, multidoku pour lequel on veut un indice
+	 * @param solver Solver, méthode de résolution souhaitée
+	 * @return Hint, indice sur une case à remplir, valant null si le doku n'a pas de solution.
+	 */
 	public static Hint getHint(MultiDoku doku, Solver solver) {
 		doku.getStateManager().pushState();
 		doku.clearMutableCells();