Documentatie util

OGP1718-Worms/src/worms/util/Coordinate.java

@@ -4,6 +4,12 @@ import be.kuleuven.cs.som.annotate.Basic;
 import be.kuleuven.cs.som.annotate.Immutable;
 import be.kuleuven.cs.som.annotate.Value;
 
+/**
+ * A class of Coordinates involving a coordinateX and coordinateY.
+ *
+ * @version 2.0
+ * @author Arthur Bols & Leen Dereu
+ */
 @Value
 public class Coordinate extends Tuple<Double, Double> {
 

OGP1718-Worms/src/worms/util/IllegalNameException.java

@@ -3,12 +3,11 @@ package worms.util;
 import be.kuleuven.cs.som.annotate.*;
 
 /**
- * A class for signalling illegal names for worms
+ * A class for signalling illegal names for worms.
+ * Each illegal name exception involves the name and the index of the character where the error occurred.
  *
- *  Each illegal name exception involves the name and the index of the character where the error occurred.
- *
- *  @version 1.0
- *  @author Arthur Bols / Leen Dereu
+ * @version 1.0
+ * @author Arthur Bols & Leen Dereu
  */
 public class IllegalNameException extends RuntimeException {
 

OGP1718-Worms/src/worms/util/TeamComparator.java

@@ -4,6 +4,12 @@ import worms.model.Worm;
 
 import java.util.Comparator;
 
+/**
+ * A class for a TeamComparator involving two worms.
+ *
+ * @version 1.0
+ * @author Arthur Bols & Leen Dereu
+ */
 public class TeamComparator implements Comparator<Worm> {
 
     /**

OGP1718-Worms/src/worms/util/Tuple.java

@@ -12,7 +12,6 @@ import java.util.Objects;
  * @param <T1> first element type
  * @param <T2> second element type
  *
- *
  * @version 1.2
  * @author Arthur Bols & Leen Dereu
  */