nettoyage + lisibilité code + changement structure

fr/iut_fbleau/Avalam/AvalamPly.java

@@ -4,44 +4,43 @@ import fr.iut_fbleau.GameAPI.AbstractPly;
 import fr.iut_fbleau.GameAPI.Player;
 
 /**
- * Représente un coup (ply) dans le jeu Avalam.
- *
- * Un coup est défini par :
- * <ul>
- *     <li>un joueur (PLAYER1 ou PLAYER2)</li>
- *     <li>une position source (xFrom, yFrom)</li>
- *     <li>une position destination (xTo, yTo)</li>
- * </ul>
- *
- * Ces coordonnées seront utilisées par <code>AvalamBoard</code> pour :
- * <ul>
- *     <li>vérifier la légalité du coup</li>
- *     <li>fusionner les tours concernées</li>
- *     <li>mettre à jour la grille</li>
- * </ul>
- *
- * Cette classe ne contient aucune logique de vérification : tout est délégué
- * à <code>AvalamBoard.isLegal()</code> et <code>AvalamBoard.doPly()</code>.
- */
+* La classe <code>AvalamPly</code>
+*
+* Représente un coup (ply) dans le jeu Avalam.
+* Un coup est défini par :
+* - un joueur (PLAYER1 ou PLAYER2)
+* - une position source (xFrom, yFrom)
+* - une position destination (xTo, yTo)
+*
+* Cette classe ne vérifie pas la légalité : tout est délégué à <code>AvalamBoard</code>.
+*/
 public class AvalamPly extends AbstractPly {
 
-    /** Coordonnées source */
+    //Attributs
+
+    /** Coordonnée ligne de la case source. */
     private final int xFrom;
+
+    /** Coordonnée colonne de la case source. */
     private final int yFrom;
 
-    /** Coordonnées destination */
+    /** Coordonnée ligne de la case destination. */
     private final int xTo;
+
+    /** Coordonnée colonne de la case destination. */
     private final int yTo;
 
+    //Constructeur
+
     /**
-     * Constructeur principal.
-     *
-     * @param player joueur qui joue le coup
-     * @param xFrom ligne d'origine
-     * @param yFrom colonne d'origine
-     * @param xTo ligne de destination
-     * @param yTo colonne de destination
-     */
+    * Construit un coup Avalam.
+    *
+    * @param player joueur qui joue le coup
+    * @param xFrom ligne d'origine
+    * @param yFrom colonne d'origine
+    * @param xTo ligne de destination
+    * @param yTo colonne de destination
+    */
     public AvalamPly(Player player, int xFrom, int yFrom, int xTo, int yTo) {
         super(player);
         this.xFrom = xFrom;
@@ -50,26 +49,51 @@ public class AvalamPly extends AbstractPly {
         this.yTo = yTo;
     }
 
-    /** Ligne d'origine */
+    //Méthodes
+
+    /**
+    * Retourne la ligne d'origine.
+    *
+    * @return ligne source
+    */
     public int getXFrom() {
         return xFrom;
     }
 
-    /** Colonne d'origine */
+    /**
+    * Retourne la colonne d'origine.
+    *
+    * @return colonne source
+    */
     public int getYFrom() {
         return yFrom;
     }
 
-    /** Ligne de destination */
+    /**
+    * Retourne la ligne de destination.
+    *
+    * @return ligne destination
+    */
     public int getXTo() {
         return xTo;
     }
 
-    /** Colonne de destination */
+    /**
+    * Retourne la colonne de destination.
+    *
+    * @return colonne destination
+    */
     public int getYTo() {
         return yTo;
     }
 
+    //Affichage
+
+    /**
+    * Retourne une représentation textuelle du coup.
+    *
+    * @return chaîne décrivant le coup
+    */
     @Override
     public String toString() {
         return "AvalamPly{" +