adding documentation

app/src/main/java/sudoku/structure/SudokuFactory.java

@@ -14,9 +14,21 @@ import sudoku.solver.Solver;
 
 public class SudokuFactory {
 
+	/**
+	 * Générateur de nombre aléatoire.
+	 */
 	private static final Random random = new Random();
+	/**
+	 * Liste des contraintes par défaut d'un Multi- ou Sudoku.
+	 * Comprend les contraintes de blocs, de lignes, et de colonnes.
+	 */
 	public static List<IConstraint> DEFAULT_CONSTRAINTS = Arrays.asList(new BlockConstraint(), new LineConstraint(), new ColumnConstraint());
 
+	/**
+	 * Créée des Cells et les met dans une liste de taille size.
+	 * @param size int, nombre de Cells à initialiser.
+	 * @return List<Cell>, liste des Cells initialisées.
+	 */
 	private static List<Cell> initCells(int size) {
 		List<Cell> cells = new ArrayList<>(size * size);
 		for (int i = 0; i < size * size; i++) {
@@ -25,6 +37,13 @@ public class SudokuFactory {
 		return cells;
 	}
 
+	/**
+	 * Créée des Blocks de taille width par height à partir des cellules données, et les met dans une liste.
+	 * @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<Block>, liste des Blocks créés.
+	 */
 	private static List<Block> initRectangleBlocs(List<Cell> cells, int width, int height) {
 		List<Block> blocs = new ArrayList<>();
 		int size = width * height;
@@ -48,16 +67,32 @@ public class SudokuFactory {
 		return blocs;
 	}
 
+	/**
+	 * Créée un MultiDoku vide dont les Blocks sont de taille widthBlock par heightBlock.
+	 * @param widthBlock int, largeur des Blocks.
+	 * @param heightBlock int, hauteur des Blocks.
+	 * @return MultiDoku, MultiDoku vide.
+	 */
 	public static MultiDoku createBasicEmptyRectangleSudoku(int widthBlock, int heightBlock) {
 		Sudoku s = createRectangleSudoku(widthBlock, heightBlock);
 		return new MultiDoku(Arrays.asList(s));
 	}
 
+	/**
+	 * Créée un MultiDoku vide dont les Blocks sont carrés de longueur size.
+	 * @param size int, taille des Blocks.
+	 * @return MultiDoku, MultiDoku vide.
+	 */
 	public static MultiDoku createBasicEmptySquareSudoku(int size) {
 		return createBasicEmptyRectangleSudoku(size, size);
 	}
 
-	public static void setIMMutableCells(MultiDoku doku, Map<Coordinate, Integer> immutableCells) {
+	/**
+	 * Place des Cells immutables de valeurs fournies, aux Coordinate fournies dans le MultiDoku doku fourni.
+	 * @param doku MultiDoku, MultiDoku à remplir.
+	 * @param immutableCells Map<Coordinate, Integer>, association de Coordinate coordonnées et Integer valeurs, correspondant aux cases à remplir.
+	 */
+	public static void setImmutableCells(MultiDoku doku, Map<Coordinate, Integer> immutableCells) {
 		immutableCells.forEach((coordinate, symbol) -> {
 			for (Sudoku sudoku : doku.getSubGrids()) {
 				Cell cell = sudoku.getCell(coordinate.getX(), coordinate.getY());
@@ -69,6 +104,13 @@ public class SudokuFactory {
 		});
 	}
 
+	/**
+	 * Créée un MultiDoku de difficulté difficulty à partir d'un MultiDoku fourni.
+	 * @param doku MultiDoku, MultiDoku dont on doit vider des Cells.
+	 * @param difficulty int, nombre de cases à retirer.
+	 * @return boolean, valant true si un MultiDoku de difficulté donnée peut être créée, false sinon.
+	 * @throws Exception si la difficulté n'est pas compatible avec la taille du MultiDoku.
+	 */
 	public static boolean newDokuFromFilledOne (MultiDoku doku, int difficulty) throws Exception {
 
 		if (difficulty > doku.getCells().size()) {
@@ -100,19 +142,36 @@ public class SudokuFactory {
 		return false;
     }
 
-	private static Sudoku createRectangleSudoku(int width, int height) {
-		int symbolCount = width * height;
+	/**
+	 * Créée un Sudoku vide dont les Blocks sont de taille widthBlock par heightBlock.
+	 * @param widthBlock int, largeur des Blocks.
+	 * @param heightBlock int, hauteur des Blocks.
+	 * @return Sudoku, Sudoku vide.
+	 */
+	private static Sudoku createRectangleSudoku(int widthBlock, int heightBlock) {
+		int symbolCount = widthBlock * heightBlock;
 		List<Cell> cases = initCells(symbolCount);
-		List<Block> blocs = initRectangleBlocs(cases, width, height);
+		List<Block> blocs = initRectangleBlocs(cases, widthBlock, heightBlock);
 		Sudoku s = new Sudoku(cases, blocs, DEFAULT_CONSTRAINTS);
-		s.setBlockWidth(width);
+		s.setBlockWidth(widthBlock);
 		return s;
 	}
 
+		/**
+	 * Créée un Sudoku vide dont les Blocks sont carrés de longueur size.
+	 * @param size int, taille des Blocks.
+	 * @return Sudoku, Sudoku vide.
+	 */
 	private static Sudoku createSquareSudoku(int size) {
 		return createRectangleSudoku(size, size);
 	}
 
+	/**
+	 * Connecte deux Sudokus selon la décalage offset fourni.
+	 * @param sudoku1 Sudoku, premier sudoku à connecter.
+	 * @param sudoku2 Sudoku, second sudoku à connecter.
+	 * @param offset Coordinate, décalage entre les deux Sudokus.
+	 */
 	private static void linkSquareSudokus(Sudoku sudoku1, Sudoku sudoku2, Coordinate offset) {
 		int blockWidth = sudoku1.getBlockWidth();
 		for (int dx = 0; dx < blockWidth; dx++) {
@@ -142,7 +201,12 @@ public class SudokuFactory {
 		}
 	}
 
-	public static MultiDoku createBasicSquareMultidoku(int size) {
+	/**
+	 * Créée un MultiDoku de Blocks carrés de taille size composé de cinq Sudokus, dont un central qui partage chacun de ses Blockss d'angle avec un autre Sudoku.
+	 * @param size int, largeur des Blocks unitraires des Sudokus à crééer.
+	 * @return MultiDoku, MultiDoku de forme X.
+	 */
+	public static MultiDoku createBasicXShapedMultidoku(int size) {
 		assert (size > 1);
 
 		/**