Documentatie IllegalNameException

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

@@ -12,29 +12,18 @@ import be.kuleuven.cs.som.annotate.*;
  */
 public class IllegalNameException extends RuntimeException {
 
-    /**
-     * Variable registering the index of this illegal name exception
-     */
     private final int index;
 
-    /**
-     * Variable referencing the naem of this illegal name exception
-     */
     private final String name;
 
     /**
-     * Initalize this new illegal name exception with given operands
+     * @param index
+     * @param name
      *
-     * @param   index
+     * @post ...
-     *          The index of the character where the exception occurred.
+     *       |new.getIndex() == index
-     * @param   name
+     * @post ...
-     *          The String where the error occurred.
+     *       |new.getName() == name
-     *
-     * @post    The index of this new illegal name exception is set to the given index
-     *          | new.getIndex() == index
-     *
-     * @post    The name of this new illegal name exception is set to the given name
-     *          | new.getName() == name
      */
     public IllegalNameException(int index, String name) {
         this.index = index;
@@ -42,9 +31,8 @@ public class IllegalNameException extends RuntimeException {
     }
 
     /**
-     * Return the index of this illegal name exception.
+     * @return  ...
-     *
+     *          |result == this.index
-     * @return this.index
      */
     @Basic @Immutable
     public int getIndex() {
@@ -52,9 +40,8 @@ public class IllegalNameException extends RuntimeException {
     }
 
     /**
-     * Return the name of this illegal name exception.
+     * @return  ...
-     *
+     *          |result == this.name
-     * @return this.name
      */
     @Basic @Immutable
     public String getName() {