From b7a87c9690a24b3d85ec6cc6ccfc9d7fd205b878 Mon Sep 17 00:00:00 2001
From: Justine Yannis <yannisjustine91@gmail.com>
Date: Wed, 26 Oct 2022 14:57:59 +0200
Subject: [PATCH] Ajout de commentaires

---
 .../Puissance4/Model/GrilleModel.java         |  2 +-
 .../Puissance4/Utils/Constants.java           | 48 +++++++++++++++----
 .../Puissance4/Utils/GameStatus.java          | 13 ++++-
 3 files changed, 51 insertions(+), 12 deletions(-)

diff --git a/projetAgile/src/fr/iutfbleau/projetAgile/Puissance4/Model/GrilleModel.java b/projetAgile/src/fr/iutfbleau/projetAgile/Puissance4/Model/GrilleModel.java
index 4da4862..9c55bef 100644
--- a/projetAgile/src/fr/iutfbleau/projetAgile/Puissance4/Model/GrilleModel.java
+++ b/projetAgile/src/fr/iutfbleau/projetAgile/Puissance4/Model/GrilleModel.java
@@ -32,7 +32,7 @@ public class GrilleModel extends AbstractGridInitiater{
     }
 
     /**
-     * Réinitialise le modèle avec des cases vides et met à jour son status à PLAYING
+     * Réinitialise le modèle avec des cases vides et met à jour son status à {@link fr.iutfbleau.projetAgile.Puissance4.Utils.GameStatus#PLAYING PLAYING} 
      */
     public void reset() {
         for(int i = 0; i < this.column; i++) {
diff --git a/projetAgile/src/fr/iutfbleau/projetAgile/Puissance4/Utils/Constants.java b/projetAgile/src/fr/iutfbleau/projetAgile/Puissance4/Utils/Constants.java
index 34a5d55..55ee6bb 100644
--- a/projetAgile/src/fr/iutfbleau/projetAgile/Puissance4/Utils/Constants.java
+++ b/projetAgile/src/fr/iutfbleau/projetAgile/Puissance4/Utils/Constants.java
@@ -3,25 +3,53 @@ package fr.iutfbleau.projetAgile.Puissance4.Utils;
 import java.awt.Color;
 
 /**
- * Classe qui représente les paramètres et constantes du puissance 4
- *  - Le nombre de colonne et de lignes;
- *  - Le numéro des joueurs et d'un pion "vide";
- *  - La couleur des pions;
- *  - La couleur du fond;
- *  - Un booléen pour savoir si un survol des pions doit être affiché.
+ * Classe qui représente les paramètres et constantes du Puissance 4
  */
 public class Constants {
+    /**
+     * La couleur du joueur 1
+     */
     public final static Color PLAYER_ONE_COLOR = new Color(252,21,21);
+    /**
+     * La couleur du joueur 1
+     */
     public final static Color PLAYER_TWO_COLOR = new Color(241,205,15);
-    public final static Color BACKGROUND_COLOR = new Color(31,31,31);
+    /**
+     * La couleur d'un pion "vide"
+     */
     public final static Color EMPTY_COLOR = new Color(42,42,42);
+    /**
+     * La couleur de fond du panneau
+     */
+    public final static Color BACKGROUND_COLOR = new Color(31,31,31);
+    /**
+     * L'entier qui représente un pion "vide"
+     */
     public final static int EMPTY_PLAYER = 0;
+    /**
+     * L'entier qui représente un pion du joueur 1
+     */
     public final static int PLAYER_ONE = 1;
+    /**
+     * L'entier qui représente un pion du joueur 2
+     */
     public final static int PLAYER_TWO = 2;
+    /**
+     * Le survol du pion est activé ?
+     */
     public static final boolean DRAW_POSITION = true;
-    public static int PIECE_MARGIN = 10;
-    public static int COLUMN_COUNT = 7;
-    public static int ROW_COUNT = 6;
+    /**
+     * La marge d'un pion
+     */
+    public final static int PIECE_MARGIN = 10;
+    /**
+     * Le nombre de colonne de la grille
+     */
+    public final static int COLUMN_COUNT = 7;
+    /**
+     * Le nombre de ligne de la grille
+     */
+    public final static int ROW_COUNT = 6;
 
     private Constants() {
 
diff --git a/projetAgile/src/fr/iutfbleau/projetAgile/Puissance4/Utils/GameStatus.java b/projetAgile/src/fr/iutfbleau/projetAgile/Puissance4/Utils/GameStatus.java
index fc399cc..b74bace 100644
--- a/projetAgile/src/fr/iutfbleau/projetAgile/Puissance4/Utils/GameStatus.java
+++ b/projetAgile/src/fr/iutfbleau/projetAgile/Puissance4/Utils/GameStatus.java
@@ -4,6 +4,17 @@ package fr.iutfbleau.projetAgile.Puissance4.Utils;
  * Enumeration du status d'une partie (En cours, gagné, égalité)
  */
 public enum GameStatus {
-    PLAYING, WIN, DRAW;
+    /**
+     * Status d'une partie en cours
+     */
+    PLAYING,
+    /**
+     * Status d'une partie terminé et gagné par un joueur
+     */
+    WIN,
+    /**
+     * Status d'une partie terminé avec une égalité
+     */
+    DRAW;
 }