1 files changed, 101 insertions, 2 deletions

diff --git a/src/ch/epfl/xblast/client/XBlastComponent.java b/src/ch/epfl/xblast/client/XBlastComponent.java
index 0ef8c5c..f90d6ee 100644
--- a/src/ch/epfl/xblast/client/XBlastComponent.java
+++ b/src/ch/epfl/xblast/client/XBlastComponent.java
@@ -20,36 +20,69 @@ import java.util.stream.IntStream;
  */
 public final class XBlastComponent extends JComponent {
 
+    /**
+     * Representation of the client's window as a grid.
+     */
     private static class Grid {
 
+        /**
+         * Parameters of a grid.
+         */
         private static final Dimension CELL_DIMENSION = new Dimension(64, 48);
         private static final Dimension SCORE_IMG_DIMENSION = new Dimension(48, 48);
         private static final Dimension TIME_LED_DIMENSION = new Dimension(16, 16);
         private static final Dimension FRAME_DIMENSION = totalDimension();
 
+        /**
+         * Positions of the elements on the grid.
+         */
         private static final List<Point> CELL_POSITIONS = buildCellGrid(CELL_DIMENSION);
         private static final List<Point> SCORE_BG_POSITIONS = buildScoreGrid();
         private static final List<Point> TIME_LINE_POSITIONS = buildTimeLineGrid();
         private static final Map<PlayerID, Point> SCORE_TXT_POSITIONS = buildScoreMap(659);
 
+        /**
+         * Returns the dimension of the grid.
+         *
+         * @return the dimension of the grid
+         */
         private static Dimension totalDimension() {
             return new Dimension(
                     CELL_DIMENSION.width * Cell.COLUMNS,
                     CELL_DIMENSION.height * Cell.ROWS + SCORE_IMG_DIMENSION.height + TIME_LED_DIMENSION.height);
         }
 
+        /**
+         * Returns a list of positions of every cell on the grid.
+         *
+         * @param elementDim dimension of a cell
+         * @return a list of positions of every cell on the grid
+         */
         private static List<Point> buildCellGrid(Dimension elementDim) {
             return Collections.unmodifiableList(Cell.ROW_MAJOR_ORDER.stream()
                     .map(c -> new Point(c.x() * elementDim.width, c.y() * elementDim.height))
                     .collect(Collectors.toList()));
         }
 
+        /**
+         * Builds a list containing the positions of the elements of a line.
+         *
+         * @param elementDim dimension of the every element of the line
+         * @param len length of the line
+         * @param shift shift
+         * @return list containing the positions of the elements of a line.
+         */
         private static List<Point> buildLine(Dimension elementDim, int len, Point shift) {
             return Collections.unmodifiableList(IntStream.range(0, len)
                     .mapToObj(x -> new Point(x * elementDim.width + shift.x, shift.y))
                     .collect(Collectors.toList()));
         }
 
+        /**
+         * Builds the list of the positions of the scores' line elements.
+         *
+         * @return the list of the positions of the scores' line elements.
+         */
         private static List<Point> buildScoreGrid() {
             return buildLine(
                     SCORE_IMG_DIMENSION,
@@ -57,6 +90,11 @@ public final class XBlastComponent extends JComponent {
                     new Point(0, CELL_DIMENSION.height * Cell.ROWS));
         }
 
+        /**
+         * Builds the list of the positions of the time "line" elements.
+         *
+         * @return the list of the positions of the time "line" elements.
+         */
         private static List<Point> buildTimeLineGrid() {
             return buildLine(
                     TIME_LED_DIMENSION,
@@ -64,6 +102,12 @@ public final class XBlastComponent extends JComponent {
                     new Point(0, CELL_DIMENSION.height * Cell.ROWS + SCORE_IMG_DIMENSION.height));
         }
 
+        /**
+         * Builds the map linking the players' ID to the location of their scores on the grid.
+         *
+         * @param vShift vertical position of the scores on the grid
+         * @return map linking the players' ID to the location of their scores on the grid
+         */
         private static Map<PlayerID, Point> buildScoreMap(int vShift) {
             Map<PlayerID, Point> m = new EnumMap<>(PlayerID.class);
             m.put(PlayerID.PLAYER_1, new Point(96, vShift));
@@ -73,6 +117,12 @@ public final class XBlastComponent extends JComponent {
             return m;
         }
 
+        /**
+         * Computes the position of a player on the grid.
+         *
+         * @param p given player
+         * @return the player's position on the grid
+         */
         private static Point positionForPlayer(GameState.Player p) {
             return new Point(
                     4 * p.position().x() - 24,
@@ -81,27 +131,59 @@ public final class XBlastComponent extends JComponent {
 
     }
 
+    /**
+     * Client's painter.
+     */
     private static class Painter {
 
+        /**
+         * Painter's parameters.
+         */
         private static final ImageObserver IMG_OBSERVER = null;
         private static final Font TXT_FONT = new Font("Arial", Font.BOLD, 25);
         private static final Color TXT_COLOR = Color.WHITE;
 
+        /**
+         * Draws a string on the graphic context at the given point.
+         *
+         * @param g the graphic context
+         * @param pos position on the graphic context
+         * @param str string to be draw
+         */
         private static void drawString(Graphics2D g, Point pos, String str) {
             g.setColor(TXT_COLOR);
             g.setFont(TXT_FONT);
             g.drawString(str, pos.x, pos.y);
         }
 
+        /**
+         * Draws an image on the graphic at the given point.
+         *
+         * @param g the graphic context
+         * @param pos position on the graphic context.
+         * @param img image to be draw
+         */
         private static void drawImage(Graphics2D g, Point pos, Image img) {
             g.drawImage(img, pos.x, pos.y, IMG_OBSERVER);
         }
 
+        /**
+         * Draws images given their location on the graphic context.
+         *
+         * @param g the graphic context
+         * @param m map linking images to points on the graphic context
+         */
         private static void drawImageMap(Graphics2D g, Map<Point, Image> m) {
             for (Map.Entry<Point, Image> e : m.entrySet())
                 drawImage(g, e.getKey(), e.getValue());
         }
 
+        /**
+         * Draws strings given their location on the graphic context.
+         *
+         * @param g the graphic context
+         * @param m map linking strings to their locations
+         */
         private static <T> void drawStringMap(Graphics2D g, Map<Point, T> m) {
             for (Map.Entry<Point, T> e : m.entrySet())
                 drawString(g, e.getKey(), e.getValue().toString());
@@ -120,7 +202,17 @@ public final class XBlastComponent extends JComponent {
 
     }
 
+    /**
+     * Sorts the players in order to have the current player at first.
+     *
+     * @param players list of the players
+     * @param currentPlayerID player ID of the current player (the player playing on this client)
+     * @return the ordered list of players