More documentation

Signed-off-by: pacien <pacien.trangirard@pacien.net>

6 files changed, 20 insertions, 10 deletions

diff --git a/src/main/java/fr/umlv/java/wallj/block/BlockFactory.java b/src/main/java/fr/umlv/java/wallj/block/BlockFactory.java
index acd280f..6911c88 100644
--- a/src/main/java/fr/umlv/java/wallj/block/BlockFactory.java
+++ b/src/main/java/fr/umlv/java/wallj/block/BlockFactory.java
@@ -9,7 +9,6 @@ import org.jbox2d.common.Vec2;
  * @author Pacien TRAN-GIRARD
  */
 public final class BlockFactory {
-
   private static Block forType(BlockType t, Vec2 pos) {
     switch (t) {
       case WALL:
@@ -28,6 +27,11 @@ public final class BlockFactory {
     }
   }
 
+  /**
+   * @param type the type of the block to build
+   * @param pos  the initial position of the block
+   * @return the built block
+   */
   public static Block build(BlockType type, TileVec2 pos) {
     return forType(type, pos.toVec2());
   }
@@ -35,5 +39,4 @@ public final class BlockFactory {
   private BlockFactory() {
     // static class
   }
-
 }
diff --git a/src/main/java/fr/umlv/java/wallj/block/BlockType.java b/src/main/java/fr/umlv/java/wallj/block/BlockType.java
index 6ef1df3..84faa39 100644
--- a/src/main/java/fr/umlv/java/wallj/block/BlockType.java
+++ b/src/main/java/fr/umlv/java/wallj/block/BlockType.java
@@ -6,7 +6,6 @@ package fr.umlv.java.wallj.block;
  * @author Pacien TRAN-GIRARD
  */
 public enum BlockType {
-
   FREE(false, true, true, false),
   WALL(true, false, false, false),
   TRASH(true, true, false, false),
@@ -53,5 +52,4 @@ public enum BlockType {
   public boolean isMovableByExplosion() {
     return movableByExplosion;
   }
-
 }
diff --git a/src/main/java/fr/umlv/java/wallj/block/SolidDef.java b/src/main/java/fr/umlv/java/wallj/block/SolidDef.java
index bfc1743..496c602 100644
--- a/src/main/java/fr/umlv/java/wallj/block/SolidDef.java
+++ b/src/main/java/fr/umlv/java/wallj/block/SolidDef.java
@@ -13,6 +13,11 @@ import org.jbox2d.dynamics.FixtureDef;
  * @author Pacien TRAN-GIRARD
  */
 public final class SolidDef {
+  /**
+   * @param bodyType type of body
+   * @param pos initial position of the body
+   * @return a corresponding body definition
+   */
   public static BodyDef bodyDefOf(BodyType bodyType, Vec2 pos) {
     BodyDef def = new BodyDef();
     def.type = bodyType;
@@ -20,6 +25,10 @@ public final class SolidDef {
     return def;
   }
 
+  /**
+   * @param shape a shape definition
+   * @return a corresponding fixture definition
+   */
   public static FixtureDef fixtureDefOf(Shape shape) {
     FixtureDef def = new FixtureDef();
     def.shape = shape;
@@ -27,12 +36,18 @@ public final class SolidDef {
     return def;
   }
 
+  /**
+   * @return a tile square shape definition
+   */
   public static PolygonShape squareShape() {
     PolygonShape shape = new PolygonShape();
     shape.setAsBox(TileVec2.TILE_DIM, TileVec2.TILE_DIM);
     return shape;
   }
 
+  /**
+   * @return a circle shape definition fitting in a tile
+   */
   public static CircleShape circleShape() {
     CircleShape shape = new CircleShape();
     shape.m_radius = TileVec2.TILE_DIM / 2;
diff --git a/src/main/java/fr/umlv/java/wallj/board/BoardParser.java b/src/main/java/fr/umlv/java/wallj/board/BoardParser.java
index 3b77767..90fd9c2 100644
--- a/src/main/java/fr/umlv/java/wallj/board/BoardParser.java
+++ b/src/main/java/fr/umlv/java/wallj/board/BoardParser.java
@@ -15,7 +15,6 @@ import java.util.stream.Collectors;
  * @author Pacien TRAN-GIRARD
  */
 public final class BoardParser {
-
   private static Board buildBoard(List<List<BlockType>> map) {
     if (!Matrix.isShapeValid(map)) throw new IllegalArgumentException("Board must be rectangular.");
 
@@ -65,5 +64,4 @@ public final class BoardParser {
   private BoardParser() {
     // static class
   }
-
 }
diff --git a/src/main/java/fr/umlv/java/wallj/board/PathFinder.java b/src/main/java/fr/umlv/java/wallj/board/PathFinder.java
index 2f2f009..c530d83 100644
--- a/src/main/java/fr/umlv/java/wallj/board/PathFinder.java
+++ b/src/main/java/fr/umlv/java/wallj/board/PathFinder.java
@@ -10,7 +10,6 @@ import java.util.stream.Collectors;
  * @author Pacien TRAN-GIRARD
  */
 public class PathFinder {
-
   private static final int LEAP_COST = 1;
 
   private static class Node<T> {
@@ -129,5 +128,4 @@ public class PathFinder {
     if (startNode == null) throw new IllegalArgumentException("Invalid starting point.");
     return findPath(startNode, target, PathFinder::euclideanDistance);
   }
-
 }
diff --git a/src/main/java/fr/umlv/java/wallj/board/TileVec2.java b/src/main/java/fr/umlv/java/wallj/board/TileVec2.java
index 1d95690..4165c81 100644
--- a/src/main/java/fr/umlv/java/wallj/board/TileVec2.java
+++ b/src/main/java/fr/umlv/java/wallj/board/TileVec2.java
@@ -13,7 +13,6 @@ import java.util.stream.Collectors;
  * @author Pacien TRAN-GIRARD
  */
 public final class TileVec2 {
-
   public static final int TILE_DIM = 20;
   private static final List<TileVec2> NEIGHBOR_OFFSETS = Arrays.asList(
   of(0, -1),
@@ -98,5 +97,4 @@ public final class TileVec2 {
            ", row=" + row +
            '}';
   }
-
 }