Comments & fix typos06-2_code_review

10 files changed, 105 insertions, 17 deletions

diff --git a/src/ch/epfl/xblast/ArgumentChecker.java b/src/ch/epfl/xblast/ArgumentChecker.java
index a8ca31a..8ba744e 100644
--- a/src/ch/epfl/xblast/ArgumentChecker.java
+++ b/src/ch/epfl/xblast/ArgumentChecker.java
@@ -42,7 +42,7 @@ public final class ArgumentChecker {
     }
 
     /**
-     * Requires the given sequence to be non-empty and returns it or throw an IllegalArgumentException otherwise.
+     * Requires the given Sequence to be non-empty and returns it or throw an IllegalArgumentException otherwise.
      *
      * @param s   the sequence to check
      * @param <T> the sequence type
diff --git a/src/ch/epfl/xblast/Cell.java b/src/ch/epfl/xblast/Cell.java
index 16632cc..8214066 100644
--- a/src/ch/epfl/xblast/Cell.java
+++ b/src/ch/epfl/xblast/Cell.java
@@ -28,7 +28,7 @@ public final class Cell {
     public static final int COUNT = COLUMNS * ROWS;
 
     /**
-     * The list of the board's Cell's, major-ordered.
+     * The list of the board's Cell-s, major-ordered.
      */
     public static final List<Cell> ROW_MAJOR_ORDER = Collections.unmodifiableList(rowMajorOrder());
 
@@ -36,6 +36,7 @@ public final class Cell {
      * The list of the board's Cell-s, spiral-ordered.
      */
     public static final List<Cell> SPIRAL_ORDER = Collections.unmodifiableList(spiralOrder());
+
     /**
      * The coordinates of the Cell.
      */
diff --git a/src/ch/epfl/xblast/Direction.java b/src/ch/epfl/xblast/Direction.java
index 5f5df33..b8852de 100644
--- a/src/ch/epfl/xblast/Direction.java
+++ b/src/ch/epfl/xblast/Direction.java
@@ -1,7 +1,7 @@
 package ch.epfl.xblast;
 
 /**
- * A Direction.
+ * Directions.
  *
  * @author Pacien TRAN-GIRARD (261948)
  * @author Timothée FLOURE (257420)
diff --git a/src/ch/epfl/xblast/Lists.java b/src/ch/epfl/xblast/Lists.java
index d599776..22d9d06 100644
--- a/src/ch/epfl/xblast/Lists.java
+++ b/src/ch/epfl/xblast/Lists.java
@@ -34,7 +34,7 @@ public final class Lists {
      *
      * @param l   the list to reverse
      * @param <T> the type of the list's elements
-     * @return a reversed copy of the list.
+     * @return a reversed copy of the list
      */
     private static <T> List<T> reversed(List<T> l) {
         List<T> r = new ArrayList<>(l);
@@ -70,7 +70,7 @@ public final class Lists {
     }
 
     /**
-     * Returns all the permutations of the elements of the given list
+     * Returns all the permutations of the elements of the given list.
      *
      * @param l   given list
      * @param <T> the type of the list's elements
diff --git a/src/ch/epfl/xblast/SubCell.java b/src/ch/epfl/xblast/SubCell.java
index 9585fd2..51cbbb4 100644
--- a/src/ch/epfl/xblast/SubCell.java
+++ b/src/ch/epfl/xblast/SubCell.java
@@ -27,6 +27,7 @@ public final class SubCell {
      * The height of the board (total of sub-rows).
      */
     private static final int SUB_ROWS = SUB_ROW_DIVISIONS * Cell.ROWS;
+
     /**
      * The coordinates of the SubCell.
      */
@@ -148,7 +149,7 @@ public final class SubCell {
     /**
      * Returns a String representation of the coordinates of the SubCell.
      *
-     * @return a String representation of the coordinates of the SubCell.
+     * @return a String representation of the coordinates of the SubCell
      */
     @Override
     public String toString() {
diff --git a/src/ch/epfl/xblast/server/Block.java b/src/ch/epfl/xblast/server/Block.java
index 1bfe891..5ada099 100644
--- a/src/ch/epfl/xblast/server/Block.java
+++ b/src/ch/epfl/xblast/server/Block.java
@@ -3,7 +3,7 @@ package ch.epfl.xblast.server;
 import java.util.NoSuchElementException;
 
 /**
- * A Block.
+ * Blocks.
  *
  * @author Pacien TRAN-GIRARD (261948)
  * @author Timothée FLOURE (257420)
@@ -41,19 +41,19 @@ public enum Block {
     BONUS_RANGE(Bonus.INC_RANGE);
 
     /**
-     * Corresponding bonus, or null
+     * Corresponding bonus, or null.
      */
     private Bonus maybeAssociatedBonus;
 
     /**
-     * Main builder, used by the bonus blocks
+     * Main builder, used by the bonus blocks.
      */
     Block(Bonus maybeAssociatedBonus) {
         this.maybeAssociatedBonus = maybeAssociatedBonus;
     }
 
     /**
-     * Default builder, used by the non-bonus blocks
+     * Default builder, used by the non-bonus blocks.
      */
     Block() {
         this.maybeAssociatedBonus = null;
diff --git a/src/ch/epfl/xblast/server/Board.java b/src/ch/epfl/xblast/server/Board.java
index 06f3081..a18422a 100644
--- a/src/ch/epfl/xblast/server/Board.java
+++ b/src/ch/epfl/xblast/server/Board.java
@@ -23,13 +23,21 @@ public final class Board {
      */
     static final int BOMB_BLOCKING_DISTANCE = 6;
 
-    private static final int BLOCKS_LIST_SIZE = 195;
+    /**
+     * Dimensions of the Board.
+     */
     private static final int BOARD_ROWS = 13;
     private static final int BOARD_COLUMNS = 15;
     private static final int INNER_BOARD_ROWS = BOARD_ROWS - 2;
     private static final int INNER_BOARD_COLUMNS = BOARD_COLUMNS - 2;
     private static final int QUADRANT_ROWS = 6;
     private static final int QUADRANT_COLUMNS = 7;
+
+    /**
+     * Number of blocks of a Board.
+     */
+    private static final int BLOCKS_LIST_SIZE = BOARD_ROWS * BOARD_COLUMNS;
+
     /**
      * List containing all the blocks of the board.
      */
@@ -83,7 +91,7 @@ public final class Board {
     }
 
     /**
-     * Build a walled board filled with the given inner rows
+     * Build a walled board filled with the given inner rows.
      *
      * @param innerBlocks lists of the internal rows
      * @return a new walled board filled with the given rows
@@ -134,7 +142,7 @@ public final class Board {
      * Return the sequence of blocks related to the given cell.
      *
      * @param c cell
-     * @return the sequence of blocks related to the given cell.
+     * @return the sequence of blocks related to the given cell
      */
     public Sq<Block> blocksAt(Cell c) {
         return this.blocks.get(c.rowMajorIndex());
diff --git a/src/ch/epfl/xblast/server/Bomb.java b/src/ch/epfl/xblast/server/Bomb.java
index 78de111..535573f 100644
--- a/src/ch/epfl/xblast/server/Bomb.java
+++ b/src/ch/epfl/xblast/server/Bomb.java
@@ -20,11 +20,31 @@ import java.util.stream.Stream;
  */
 public final class Bomb {
 
+    /**
+     * Function consuming a step of the Bomb's fuse.
+     */
     private static final UnaryOperator<Integer> FUSE_STEP_FUNCTION = fl -> fl - 1;
+
+    /**
+     * Owner of the Bomb.
+     */
     private PlayerID ownerId;
+
+    /**
+     * Position of the Bomb.
+     */
     private Cell position;
+
+    /**
+     * Fuse of the Bomb.
+     */
     private Sq<Integer> fuseLengths;