diff --git a/app/src/main/java/sudoku/constraint/Constraint.java b/app/src/main/java/sudoku/constraint/Constraint.java index df4c449..5a04a08 100644 --- a/app/src/main/java/sudoku/constraint/Constraint.java +++ b/app/src/main/java/sudoku/constraint/Constraint.java @@ -37,8 +37,4 @@ public enum Constraint { } } - public static String[] getConstraintNames() { - return constraintNames; - } - } diff --git a/app/src/main/java/sudoku/io/ConsoleInterface.java b/app/src/main/java/sudoku/io/ConsoleInterface.java index 5df4453..2edfced 100644 --- a/app/src/main/java/sudoku/io/ConsoleInterface.java +++ b/app/src/main/java/sudoku/io/ConsoleInterface.java @@ -88,7 +88,7 @@ public class ConsoleInterface { * et le laisse jouer. * * @param doku MultiDoku, MultiDoku vide à remplir - * @param listSymbols List, liste des symboles à utiliser + * @param listSymbols List~String~, liste des symboles à utiliser * @param width int, largeur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku */ @@ -119,7 +119,7 @@ public class ConsoleInterface { * quand souhaité. * * @param doku MultiDoku, MultiDoku vide à remplir - * @param listSymbols List, liste des symboles à utiliser + * @param listSymbols List~String~, liste des symboles à utiliser * @param width int, largeur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku */ @@ -214,7 +214,7 @@ public class ConsoleInterface { * l'affichage. * * @param numberOfSymbols int, nombre de symboles à choisir - * @return LIst, liste des symboles à utiliser + * @return LIst~String~, liste des symboles à utiliser */ private List pickSymbols(int numberOfSymbols) { System.out.println("Would you like to pick the " + numberOfSymbols @@ -248,7 +248,7 @@ public class ConsoleInterface { * Permet à l'utilisateur de choisir les contraintes qu'il souhaite utiliser * pour son sudoku. * - * @return List, liste des contraintes à utiliser + * @return List~IConstraint~, liste des contraintes à utiliser */ private List getListConstraints() { List listConstraints = SudokuFactory.DEFAULT_CONSTRAINTS; @@ -298,7 +298,7 @@ public class ConsoleInterface { * Affiche le doku passé en paramètre. * * @param doku MultiDoku, MultiDoku à afficher - * @param listSymbols List, liste des symboles à utiliser + * @param listSymbols List~String~, liste des symboles à utiliser * @param width int, largeur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku */ @@ -310,7 +310,7 @@ public class ConsoleInterface { * Affiche le doku passé en paramètre. * * @param doku RenderableMultiDoku, MultiDoku à afficher - * @param listSymbols List, liste des symboles à utiliser + * @param listSymbols List~String~, liste des symboles à utiliser * @param width int, largeur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku */ @@ -340,7 +340,7 @@ public class ConsoleInterface { * ou de quitter l'application. * * @param doku MultiDoku, MultiDoku actuel - * @param listSymbols List, liste des symboles à utiliser + * @param listSymbols List~String~, liste des symboles à utiliser * @param width int, largeur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku */ @@ -377,7 +377,7 @@ public class ConsoleInterface { * Permet d'afficher une étape de résolution du doku complété. * * @param doku MultiDoku, MultiDoku actuel - * @param listSymbols List, liste des symboles à utiliser + * @param listSymbols List~String~, liste des symboles à utiliser * @param width int, largeur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku * @param step SolverStep, étape de résolution à afficher @@ -399,10 +399,10 @@ public class ConsoleInterface { * le souhaite. * * @param doku MultiDoku, MultiDoku actuel - * @param listSymbols List, liste des symboles à utiliser + * @param listSymbols List~String~, liste des symboles à utiliser * @param width int, largeur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku - * @param steps List, liste des étapes de résolution + * @param steps List~SolverStep~, liste des étapes de résolution */ private void showSolveSteps(MultiDoku doku, List listSymbols, int width, int height, List steps) { @@ -420,7 +420,7 @@ public class ConsoleInterface { * Résout le doku en fonction du solver que choisit l'utilisateur. * * @param doku MultiDoku, MultiDoku actuel - * @param listSymbols List, liste des symboles à utiliser + * @param listSymbols List~String~, liste des symboles à utiliser * @param width int, largeur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku */ @@ -449,7 +449,7 @@ public class ConsoleInterface { * l'utilisateur choisit. * * @param doku MultiDoku, MultiDoku actuel - * @param listSymbols List, liste des symboles à utiliser + * @param listSymbols List~String~, liste des symboles à utiliser * @param width int, largeur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku */ @@ -495,7 +495,7 @@ public class ConsoleInterface { * Renvoie l'index du symbole passé en paramètre. * * @param symbol String, symbole dont on veut l'index - * @param listSymbols List, liste des symboles possibles + * @param listSymbols List~String~, liste des symboles possibles * @param nbSymbols int, nombre de symboles possibles * @return int, index du symbole si celui-ci est valide, Cell.NOSYMBOL sinon. */ @@ -512,7 +512,7 @@ public class ConsoleInterface { * Vérifie que le symbol passé en paramètre est valide. * * @param symbol String, symbole dont on vérifie la validité - * @param listSymbols List, liste des symboles possibles + * @param listSymbols List~String~, liste des symboles possibles * @param size int, nombre de symboles possibles * @return boolean, valant true si le symbole est valide, false sinon. */ diff --git a/app/src/main/java/sudoku/structure/Block.java b/app/src/main/java/sudoku/structure/Block.java index d4211be..622fe28 100644 --- a/app/src/main/java/sudoku/structure/Block.java +++ b/app/src/main/java/sudoku/structure/Block.java @@ -29,7 +29,7 @@ public class Block { /** * Crée un Block avec une liste de Cell donnée. - * @param cells List + * @param cells List~Cell~ */ public Block(List cells) { this.cells = cells; diff --git a/app/src/main/java/sudoku/structure/Cell.java b/app/src/main/java/sudoku/structure/Cell.java index 8c561c3..8e4ee26 100644 --- a/app/src/main/java/sudoku/structure/Cell.java +++ b/app/src/main/java/sudoku/structure/Cell.java @@ -131,7 +131,7 @@ public class Cell { /** * Renvoie les symboles que peut prendre cette Cell par rapport aux contraintes de ses Sudokus. - * @return List, la liste des symboles possibles. + * @return List~Integer~, la liste des symboles possibles. */ public List getPossibleSymbols() { List result = new ArrayList<>(); diff --git a/app/src/main/java/sudoku/structure/MultiDoku.java b/app/src/main/java/sudoku/structure/MultiDoku.java index 3781836..dab3ebd 100644 --- a/app/src/main/java/sudoku/structure/MultiDoku.java +++ b/app/src/main/java/sudoku/structure/MultiDoku.java @@ -8,8 +8,8 @@ import java.util.List; import java.util.Set; /** - * @class MultiDoku - * @brief Représente une grille de Multidoku. + * Class : MultiDoku + * Brief : Représente une grille de Multidoku. * Une grille de sudoku est un multidoku avec un seul sous-sudoku. */ public class MultiDoku { @@ -52,7 +52,7 @@ public class MultiDoku { /** * Renvoie la liste des Cells préalablement remplies du MultiDoku. * - * @return List, vide si aucune Cell n'est remplie. + * @return List~Cell~, vide si aucune Cell n'est remplie. */ public List getFilledCells() { List result = new ArrayList<>(); @@ -67,7 +67,7 @@ public class MultiDoku { /** * Renvoie la liste des Cells vides du MultiDoku. * - * @return List, vide si aucune Cell ne l'est. + * @return List~Cell~, vide si aucune Cell ne l'est. */ public List getEmptyCells() { List result = new ArrayList<>(); @@ -117,7 +117,7 @@ public class MultiDoku { * Renvoie la liste des Cells contenue dans ce MultiDoku, * soit les Cells contenues de chaques sous-Sudoku. * - * @return List + * @return List~Cell~ */ public List getCells() { Set cellsSet = new HashSet<>(); @@ -160,7 +160,7 @@ public class MultiDoku { /** * Renvoie les sous-Sudoku * - * @return List + * @return List~Sudoku~ */ public List getSubGrids() { return this.subGrids; diff --git a/app/src/main/java/sudoku/structure/Sudoku.java b/app/src/main/java/sudoku/structure/Sudoku.java index 9828997..758cd59 100644 --- a/app/src/main/java/sudoku/structure/Sudoku.java +++ b/app/src/main/java/sudoku/structure/Sudoku.java @@ -6,8 +6,8 @@ import sudoku.constraint.IConstraint; import java.util.List; /** - * @class Sudoku - * @brief Représent un Sudoku + * Class : Sudoku + * Brief : Représent un Sudoku */ public class Sudoku { @@ -203,7 +203,7 @@ public class Sudoku { /** * Place les symboles d'index contenus dans values dans les cases du Sudoku. * - * @param values List, liste des index des symboles à placer. + * @param values List~Integer~, liste des index des symboles à placer. * @return boolean, vaut true si les symboles ont été placés, false sinon. */ public boolean setCellsSymbol(List values) { @@ -223,7 +223,7 @@ public class Sudoku { * Place les symboles d'index contenus dans values dans les cases du Sudoku et * rend ces cases immuables. * - * @param values List, liste des index des symboles à placer. + * @param values List~Integer~, liste des index des symboles à placer. * @return boolean, vaut true si les symboles ont été placés, false sinon. */ public boolean setImmutableCellsSymbol(List values) { diff --git a/app/src/main/java/sudoku/structure/SudokuFactory.java b/app/src/main/java/sudoku/structure/SudokuFactory.java index 02e367e..3a649c0 100644 --- a/app/src/main/java/sudoku/structure/SudokuFactory.java +++ b/app/src/main/java/sudoku/structure/SudokuFactory.java @@ -36,7 +36,7 @@ public class SudokuFactory { * Créée des Cells et les met dans une liste de taille size. * * @param size int, nombre de Cells à initialiser. - * @return List, liste des Cells initialisées. + * @return List~Cell~, liste des Cells initialisées. */ private static List initCells(int size) { List cells = new ArrayList<>(size * size); @@ -50,10 +50,10 @@ public class SudokuFactory { * Créée des Blocks de taille width par height à partir des cellules données, et * les met dans une liste. * - * @param cells List, liste des Cells à découper en Blocks. + * @param cells List~Cell~, liste des Cells à découper en Blocks. * @param width int, largeur des Blocks à créer. * @param height int, hauteur des Blocks à créer. - * @return List, liste des Blocks créés. + * @return List~Block~, liste des Blocks créés. */ private static List initRectangleBlocs(List cells, int width, int height) { List blocs = new ArrayList<>(); @@ -265,7 +265,7 @@ public class SudokuFactory { * Crée un Sudoku vide avec les Blocks aléatoires. * * @param blockSize int, la taille des Block. - * @param constraints List, la liste des contraintes. + * @param constraints List~IConstraint~, la liste des contraintes. * @return MultiDoku, avec un seul Sudoku. */ public static MultiDoku createBasicEmptyRandomBlockDoku(int blockSize, List constraints) { @@ -358,8 +358,8 @@ public class SudokuFactory { /** * Transforme des Constraints en IConstraints correspondants. - * @param constraints List - * @return List + * @param constraints List~Constraints~ + * @return List~IConstraints~ */ public static List fromConstraints(List constraints) { List iconstraints = new ArrayList<>(); diff --git a/app/src/test/java/sudoku/solver/SolverTest.java b/app/src/test/java/sudoku/solver/SolverTest.java index d2e9ffb..a68aceb 100644 --- a/app/src/test/java/sudoku/solver/SolverTest.java +++ b/app/src/test/java/sudoku/solver/SolverTest.java @@ -18,7 +18,7 @@ import sudoku.structure.Sudoku; import sudoku.structure.SudokuFactory; class SolverTest { - private int ns = Cell.NOSYMBOL; + private final int ns = Cell.NOSYMBOL; protected static HumanSolver h; private static RandomSolver r; private static MixedSolver m;