Ajout de commentaires

projetAgile/src/fr/iutfbleau/projetAgile/Puissance4/Model/GrilleModel.java

@@ -147,41 +147,6 @@ public class GrilleModel extends AbstractGridInitiater{
         fireStatusChanged(this.gameStatus, this.playerTurn, this.playerOneScore, this.playerTwoScore);
     }
 
-    public int getPlayerTurn() {
-        return this.playerTurn;
-    }
-
-    public int[][] getTab() {
-        return this.grille;
-    }
-
-    public int getColumn() {
-        return this.column;
-    }
-
-    public int getRow() {
-        return this.row;
-    }
-
-    public String getPlayerOneName() {
-        return this.playerOneName;
-    }
-
-    public String getPlayerTwoName() {
-        return this.playerTwoName;
-    }
-
-    public int getPlayerOneScore() {
-        return playerOneScore;
-    }
-
-    public int getPlayerTwoScore() {
-        return playerTwoScore;
-    }
-
-    public GameStatus getGameStatus() {
-        return this.gameStatus;
-    }
      /**
      * Change le status de la partie et notifie tous les listeners
      * @param gameStatus le status de la partie
@@ -197,12 +162,91 @@ public class GrilleModel extends AbstractGridInitiater{
         fireStatusChanged(this.gameStatus, this.playerTurn, this.playerOneScore, this.playerTwoScore);
     }
 
+    /**
+     * Retourne le tour du joueur
+     * @return Le tour du joueur
+     */
+    public int getPlayerTurn() {
+        return this.playerTurn;
+    }
+
+    /**
+     * Retourne le tableau d'entier qui représente l'état de la grille
+     * @return Le tableau d'entier
+     */
+    public int[][] getTab() {
+        return this.grille;
+    }
+
+    /**
+     * Retourne le nombre de colonne de la grille
+     * @return Le nombre de colonne 
+     */
+    public int getColumn() {
+        return this.column;
+    }
+
+    /**
+     * Retourne le nombre de ligne de la grille
+     * @return Le nombre de ligne 
+     */
+    public int getRow() {
+        return this.row;
+    }
+
+    /**
+     * Retourne le nom du joueur 1
+     * @return Un string du nom du joueur 1
+     */
+    public String getPlayerOneName() {
+        return this.playerOneName;
+    }
+
+    /**
+     * Retourne le nom du joueur 2
+     * @return Un string du nom du joueur 2
+     */
+    public String getPlayerTwoName() {
+        return this.playerTwoName;
+    }
+
+    /**
+     * Retourne le score du joueur 1
+     * @return Le score du joueur 1
+     */
+    public int getPlayerOneScore() {
+        return playerOneScore;
+    }
+
+    /**
+     * Retourne le score du joueur 2
+     * @return Le score du joueur 2
+     */
+    public int getPlayerTwoScore() {
+        return playerTwoScore;
+    }
+
+    /**
+     * Retourne le {@link fr.iutfbleau.projetAgile.Puissance4.Utils.GameStatus status} de la partie
+     * @return Le status de la partie
+     */
+    public GameStatus getGameStatus() {
+        return this.gameStatus;
+    }
+
+    /**
+     * Définit le nom du joueur 1 
+     * @param playerOneName Le nom du joueur 1
+     */
     public void setPlayerOneName(String playerOneName) {
         this.playerOneName = playerOneName;
     }
 
+    /**
+     * Définit le nom du joueur 2
+     * @param playerTwoName Le nom du joueur 2
+     */
     public void setPlayerTwoName(String playerTwoName) {
         this.playerTwoName = playerTwoName;
     }
-
 }