Bugfix/#52 javadoc coverage (#134)

* WIP * WIP
jotoh98 · Jan 14, 2020 · 9f7e802 · 9f7e802
1 parent cbc5bd1
commit 9f7e802
Show file tree

Hide file tree

Showing 12 changed files with 217 additions and 75 deletions.
diff --git a/src/main/java/com/treasure/hunt/analysis/StatisticObject.java b/src/main/java/com/treasure/hunt/analysis/StatisticObject.java
@@ -4,6 +4,8 @@
 import lombok.Value;
 
 /**
+ * This defines a component, we want to analyze in our simulation.
+ *
  * @author Trostorff, Daniel
  */
 @Value

diff --git a/src/main/java/com/treasure/hunt/game/GameManager.java b/src/main/java/com/treasure/hunt/game/GameManager.java
@@ -209,13 +209,6 @@ public void stopBeat() {
         beatThreadRunning.set(false);
     }
 
-    /**
-     * @return whether the game of the {@link GameEngine} is finished or not.
-     */
-    public boolean isGameFinished() {
-        return gameEngine.isFinished();
-    }
-
     /**
      * @return {@code true}, if the shown step is the most up to date one. {@code false}, otherwise.
      */
@@ -300,12 +293,8 @@ public CompletableFuture<Void> beat(ReadOnlyObjectProperty<Double> delay) {
     }
 
     /**
-     * @return {@code true}, if the shown step is the first one. {@code false}, otherwise.
+     * {@inheritDoc}
      */
-    public boolean isFirstStepShown() {
-        return stepBackwardImpossibleBinding.getValue();
-    }
-
     @Override
     public void write(Kryo kryo, Output output) {
         kryo.writeObject(output, gameEngine);

diff --git a/src/main/java/com/treasure/hunt/jts/geom/Circle.java b/src/main/java/com/treasure/hunt/jts/geom/Circle.java
@@ -13,11 +13,6 @@
  * @see org.locationtech.jts.geom.Geometry
  */
 public class Circle extends Polygon {
-    /**
-     * The radius of the circle.
-     */
-    double radius;
-
     /**
      * The constructor
      *

diff --git a/src/main/java/com/treasure/hunt/jts/geom/GeometryAngle.java b/src/main/java/com/treasure/hunt/jts/geom/GeometryAngle.java
@@ -24,7 +24,6 @@
  * @author jotoh
  */
 public class GeometryAngle extends LineString implements Shapeable {
-
     /**
      * GeometryAngle constructor via three {@link Coordinate}s.
      *
@@ -34,11 +33,7 @@ public class GeometryAngle extends LineString implements Shapeable {
      * @param left    the left angles arm end point
      */
     public GeometryAngle(GeometryFactory factory, Coordinate right, Coordinate center, Coordinate left) {
-        super(
-                factory.getCoordinateSequenceFactory()
-                        .create(new Coordinate[]{center, left, right}),
-                factory
-        );
+        super(factory.getCoordinateSequenceFactory().create(new Coordinate[]{center, left, right}), factory);
     }
 
     /**
@@ -98,7 +93,6 @@ public void setRight(Coordinate right) {
         setCoordinate(2, right);
     }
 
-
     public Vector2D rightVector() {
         return new Vector2D(getCenter(), getRight());
     }
@@ -123,6 +117,9 @@ public double extend() {
         return extend;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public Shape toShape(AdvancedShapeWriter shapeWriter) {
         GeneralPath generalPath = new GeneralPath();
@@ -135,6 +132,9 @@ public Shape toShape(AdvancedShapeWriter shapeWriter) {
         return generalPath;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public String getGeometryType() {
         return "Angle";
@@ -147,6 +147,9 @@ public boolean inView(Coordinate coordinate) {
         return testExtend >= 0 && testExtend <= extend();
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public GeometryAngle copy() {
         return new GeometryAngle(factory, getRight().copy(), getCenter().copy(), getLeft().copy());

diff --git a/src/main/java/com/treasure/hunt/jts/geom/GeometryLine.java b/src/main/java/com/treasure/hunt/jts/geom/GeometryLine.java
@@ -15,101 +15,156 @@ public GeometryLine(GeometryFactory factory) {
         super(factory);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public String getGeometryType() {
         return null;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public Coordinate getCoordinate() {
         return null;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public Coordinate[] getCoordinates() {
         return new Coordinate[0];
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public int getNumPoints() {
         return 0;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public boolean isEmpty() {
         return false;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public int getDimension() {
         return 0;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public Geometry getBoundary() {
         return null;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public int getBoundaryDimension() {
         return 0;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public Geometry reverse() {
         return null;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public boolean equalsExact(Geometry other, double tolerance) {
         return false;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void apply(CoordinateFilter filter) {
-
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void apply(CoordinateSequenceFilter filter) {
-
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void apply(GeometryFilter filter) {
-
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void apply(GeometryComponentFilter filter) {
-
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     protected Geometry copyInternal() {
         return null;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void normalize() {
-
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     protected Envelope computeEnvelopeInternal() {
         return null;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     protected int compareToSameClass(Object o) {
         return 0;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     protected int compareToSameClass(Object o, CoordinateSequenceComparator comp) {
         return 0;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     protected int getSortIndex() {
         return 0;