From cfb27e3de3febba137bbff3f91607cecd720717e Mon Sep 17 00:00:00 2001
From: Robin <robinboehne@web.de>
Date: Tue, 12 Oct 2021 04:08:32 +0200
Subject: [PATCH] removed more useless getter descriptions

---
 src/main/java/edu/kit/typicalc/model/Conclusion.java   |  6 ------
 src/main/java/edu/kit/typicalc/model/Substitution.java |  4 ----
 src/main/java/edu/kit/typicalc/model/Tree.java         | 10 +++-------
 src/main/java/edu/kit/typicalc/model/term/AbsTerm.java |  4 ----
 src/main/java/edu/kit/typicalc/model/term/AppTerm.java |  4 ----
 .../java/edu/kit/typicalc/model/term/BooleanTerm.java  |  2 --
 .../java/edu/kit/typicalc/model/term/ConstTerm.java    |  2 --
 .../java/edu/kit/typicalc/model/term/IntegerTerm.java  |  2 --
 .../java/edu/kit/typicalc/model/term/LambdaTerm.java   |  6 +-----
 src/main/java/edu/kit/typicalc/model/term/VarTerm.java |  2 --
 .../java/edu/kit/typicalc/model/type/FunctionType.java |  4 ----
 .../java/edu/kit/typicalc/model/type/NamedType.java    |  2 --
 src/main/java/edu/kit/typicalc/model/type/Type.java    |  4 +---
 .../edu/kit/typicalc/model/type/TypeAbstraction.java   |  6 +-----
 .../java/edu/kit/typicalc/model/type/TypeVariable.java |  4 ----
 .../kit/typicalc/model/type/UnificationActions.java    |  4 ----
 .../latexcreator/ExplanationCreator.java               |  4 +---
 17 files changed, 7 insertions(+), 63 deletions(-)

diff --git a/src/main/java/edu/kit/typicalc/model/Conclusion.java b/src/main/java/edu/kit/typicalc/model/Conclusion.java
index b364367..ecdf9f2 100644
--- a/src/main/java/edu/kit/typicalc/model/Conclusion.java
+++ b/src/main/java/edu/kit/typicalc/model/Conclusion.java
@@ -32,8 +32,6 @@ public class Conclusion {
     }
 
     /**
-     * Returns the type assumptions used in the conclusion.
-     *
      * @return the type assumptions used in the conclusion
      */
     public Map<VarTerm, TypeAbstraction> getTypeAssumptions() {
@@ -41,8 +39,6 @@ public class Conclusion {
     }
 
     /**
-     * Returns the lambda term in the conclusion.
-     *
      * @return the lambda term in the conclusion
      */
     public LambdaTerm getLambdaTerm() {
@@ -50,8 +46,6 @@ public class Conclusion {
     }
 
     /**
-     * Returns the type assigned to the lambda term in the conclusion.
-     *
      * @return the type assigned to the lambda term in the conclusion
      */
     public Type getType() {
diff --git a/src/main/java/edu/kit/typicalc/model/Substitution.java b/src/main/java/edu/kit/typicalc/model/Substitution.java
index 25091e8..7865612 100644
--- a/src/main/java/edu/kit/typicalc/model/Substitution.java
+++ b/src/main/java/edu/kit/typicalc/model/Substitution.java
@@ -26,8 +26,6 @@ public class Substitution {
     }
 
     /**
-     * Returns the type variable
-     *
      * @return the type variable
      */
     public TypeVariable getVariable() {
@@ -35,8 +33,6 @@ public class Substitution {
     }
 
     /**
-     * Returns the replacement type
-     *
      * @return the replacement type
      */
     public Type getType() {
diff --git a/src/main/java/edu/kit/typicalc/model/Tree.java b/src/main/java/edu/kit/typicalc/model/Tree.java
index d69ce1c..9ef73d7 100644
--- a/src/main/java/edu/kit/typicalc/model/Tree.java
+++ b/src/main/java/edu/kit/typicalc/model/Tree.java
@@ -81,19 +81,15 @@ public class Tree implements TermVisitorTree {
     }
 
     /**
-     * Returns the first type variable the original lambda term was assigned in the first inference step.
-     *
-     * @return the first type variable
+     * @return the first type variable the original lambda term was assigned in the first inference step
      */
     protected TypeVariable getFirstTypeVariable() {
         return firstTypeVariable;
     }
 
     /**
-     * Returns the list of constraints that formed while generating the inference step tree
-     * structure, needed for the subsequent unification.
-     *
-     * @return the constraint list of the tree
+     * @return the list of constraints that formed while generating the inference step tree
+     *      * structure, needed for the subsequent unification
      */
     protected List<Constraint> getConstraints() {
         return constraints;
diff --git a/src/main/java/edu/kit/typicalc/model/term/AbsTerm.java b/src/main/java/edu/kit/typicalc/model/term/AbsTerm.java
index 0e92b10..c0181ca 100644
--- a/src/main/java/edu/kit/typicalc/model/term/AbsTerm.java
+++ b/src/main/java/edu/kit/typicalc/model/term/AbsTerm.java
@@ -29,8 +29,6 @@ public class AbsTerm extends LambdaTerm {
     }
 
     /**
-     * Returns the variable of this abstraction
-     *
      * @return the variable of this abstraction
      */
     public VarTerm getVariable() {
@@ -38,8 +36,6 @@ public class AbsTerm extends LambdaTerm {
     }
 
     /**
-     * Returns the function body of this abstraction
-     *
      * @return the function body of this abstraction
      */
     public LambdaTerm getInner() {
diff --git a/src/main/java/edu/kit/typicalc/model/term/AppTerm.java b/src/main/java/edu/kit/typicalc/model/term/AppTerm.java
index 03f53ca..1d63185 100644
--- a/src/main/java/edu/kit/typicalc/model/term/AppTerm.java
+++ b/src/main/java/edu/kit/typicalc/model/term/AppTerm.java
@@ -25,8 +25,6 @@ public class AppTerm extends LambdaTerm {
     }
 
     /**
-     * Returns the function used in this application
-     *
      * @return the function used in this application
      */
     public LambdaTerm getFunction() {
@@ -34,8 +32,6 @@ public class AppTerm extends LambdaTerm {
     }
 
     /**
-     * Returns the parameter used in this application
-     *
      * @return the parameter used in this application
      */
     public LambdaTerm getParameter() {
diff --git a/src/main/java/edu/kit/typicalc/model/term/BooleanTerm.java b/src/main/java/edu/kit/typicalc/model/term/BooleanTerm.java
index e3eb860..2aed930 100644
--- a/src/main/java/edu/kit/typicalc/model/term/BooleanTerm.java
+++ b/src/main/java/edu/kit/typicalc/model/term/BooleanTerm.java
@@ -20,8 +20,6 @@ public class BooleanTerm extends ConstTerm {
     }
 
     /**
-     * Returns the value of the boolean constant term.
-     *
      * @return the value of the term
      */
     public boolean getValue() {
diff --git a/src/main/java/edu/kit/typicalc/model/term/ConstTerm.java b/src/main/java/edu/kit/typicalc/model/term/ConstTerm.java
index 1bb35e1..927005c 100644
--- a/src/main/java/edu/kit/typicalc/model/term/ConstTerm.java
+++ b/src/main/java/edu/kit/typicalc/model/term/ConstTerm.java
@@ -15,8 +15,6 @@ import java.util.Set;
 public abstract class ConstTerm extends LambdaTerm {
 
     /**
-     * Returns the named type of the constant
-     *
      * @return the named type of the constant
      */
     public abstract NamedType getType();
diff --git a/src/main/java/edu/kit/typicalc/model/term/IntegerTerm.java b/src/main/java/edu/kit/typicalc/model/term/IntegerTerm.java
index f3ee84f..53eda04 100644
--- a/src/main/java/edu/kit/typicalc/model/term/IntegerTerm.java
+++ b/src/main/java/edu/kit/typicalc/model/term/IntegerTerm.java
@@ -20,8 +20,6 @@ public class IntegerTerm extends ConstTerm {
     }
 
     /**
-     * Returns the value of the integer constant term.
-     *
      * @return the value of the term
      */
     public int getValue() {
diff --git a/src/main/java/edu/kit/typicalc/model/term/LambdaTerm.java b/src/main/java/edu/kit/typicalc/model/term/LambdaTerm.java
index e386ce3..558324c 100644
--- a/src/main/java/edu/kit/typicalc/model/term/LambdaTerm.java
+++ b/src/main/java/edu/kit/typicalc/model/term/LambdaTerm.java
@@ -14,16 +14,12 @@ import java.util.Set;
  */
     public abstract class LambdaTerm {
     /**
-     * Returns whether the lambda term contains a let expression
-     *
      * @return whether the lambda term contains a let expression
      */
     public abstract boolean hasLet();
 
     /**
-     * Returns a set of all free variables occurring in the lambda term.
-     *
-     * @return all free variables
+     * @return a set of all free variables occurring in the lambda term
      */
     public abstract Set<VarTerm> getFreeVariables();
 
diff --git a/src/main/java/edu/kit/typicalc/model/term/VarTerm.java b/src/main/java/edu/kit/typicalc/model/term/VarTerm.java
index ef4e570..1d219c0 100644
--- a/src/main/java/edu/kit/typicalc/model/term/VarTerm.java
+++ b/src/main/java/edu/kit/typicalc/model/term/VarTerm.java
@@ -24,8 +24,6 @@ public class VarTerm extends LambdaTerm {
     }
 
     /**
-     * Returns the name of this variable
-     *
      * @return the name of this variable
      */
     public String getName() {
diff --git a/src/main/java/edu/kit/typicalc/model/type/FunctionType.java b/src/main/java/edu/kit/typicalc/model/type/FunctionType.java
index bfa8500..74db01c 100644
--- a/src/main/java/edu/kit/typicalc/model/type/FunctionType.java
+++ b/src/main/java/edu/kit/typicalc/model/type/FunctionType.java
@@ -117,8 +117,6 @@ public class FunctionType extends Type {
     }
 
     /**
-     * Getter for output
-     *
      * @return output
      */
     public Type getOutput() {
@@ -126,8 +124,6 @@ public class FunctionType extends Type {
     }
 
     /**
-     * Getter for parameter
-     *
      * @return parameter
      */
     public Type getParameter() {
diff --git a/src/main/java/edu/kit/typicalc/model/type/NamedType.java b/src/main/java/edu/kit/typicalc/model/type/NamedType.java
index e814c1d..1310f5f 100644
--- a/src/main/java/edu/kit/typicalc/model/type/NamedType.java
+++ b/src/main/java/edu/kit/typicalc/model/type/NamedType.java
@@ -32,8 +32,6 @@ public class NamedType extends Type {
     }
 
     /**
-     * Returns the name of the named type.
-     *
      * @return the name of this type
      */
     public String getName() {
diff --git a/src/main/java/edu/kit/typicalc/model/type/Type.java b/src/main/java/edu/kit/typicalc/model/type/Type.java
index f87a578..d9869fe 100644
--- a/src/main/java/edu/kit/typicalc/model/type/Type.java
+++ b/src/main/java/edu/kit/typicalc/model/type/Type.java
@@ -19,9 +19,7 @@ public abstract class Type {
     public abstract boolean contains(Type x);
 
     /**
-     * Returns a set of all free type variables occurring in the type.
-     *
-     * @return all free type variables
+     * @return a set of all free type variables occurring in the type
      */
     public abstract Set<TypeVariable> getFreeTypeVariables();
 
diff --git a/src/main/java/edu/kit/typicalc/model/type/TypeAbstraction.java b/src/main/java/edu/kit/typicalc/model/type/TypeAbstraction.java
index 84fa7b9..026d9e8 100644
--- a/src/main/java/edu/kit/typicalc/model/type/TypeAbstraction.java
+++ b/src/main/java/edu/kit/typicalc/model/type/TypeAbstraction.java
@@ -87,9 +87,7 @@ public class TypeAbstraction {
     }
 
     /**
-     * Returns a set of all free type variables occurring in the type abstraction.
-     *
-     * @return all free type variables
+     * @return a set of all free type variables occurring in the type abstraction
      */
     public Set<TypeVariable> getFreeTypeVariables() {
         Set<TypeVariable> set = new HashSet<>(this.type.getFreeTypeVariables());
@@ -98,8 +96,6 @@ public class TypeAbstraction {
     }
 
     /**
-     * Getter for the inner type of the type abstraction
-     *
      * @return the inner type of the type abstraction
      */
     public Type getInnerType() {
diff --git a/src/main/java/edu/kit/typicalc/model/type/TypeVariable.java b/src/main/java/edu/kit/typicalc/model/type/TypeVariable.java
index 0f94a31..9e4a972 100644
--- a/src/main/java/edu/kit/typicalc/model/type/TypeVariable.java
+++ b/src/main/java/edu/kit/typicalc/model/type/TypeVariable.java
@@ -30,8 +30,6 @@ public class TypeVariable extends Type implements Comparable<TypeVariable> {
     }
 
     /**
-     * Returns the kind of the type variable.
-     *
      * @return the variable's kind
      */
     public TypeVariableKind getKind() {
@@ -39,8 +37,6 @@ public class TypeVariable extends Type implements Comparable<TypeVariable> {
     }
 
     /**
-     * Returns the index of the type variable as an integer
-     *
      * @return the variable's index
      */
     public int getIndex() {
diff --git a/src/main/java/edu/kit/typicalc/model/type/UnificationActions.java b/src/main/java/edu/kit/typicalc/model/type/UnificationActions.java
index c38ac68..1a7f131 100644
--- a/src/main/java/edu/kit/typicalc/model/type/UnificationActions.java
+++ b/src/main/java/edu/kit/typicalc/model/type/UnificationActions.java
@@ -34,8 +34,6 @@ public class UnificationActions {
     }
 
     /**
-     * Getter for constraints
-     *
      * @return the constraints stored in this object
      */
     public Collection<Constraint> getConstraints() {
@@ -43,8 +41,6 @@ public class UnificationActions {
     }
 
     /**
-     * Getter for substitution
-     *
      * @return the substitution stored in this object
      */
     public Optional<Substitution> getSubstitution() {
diff --git a/src/main/java/edu/kit/typicalc/view/content/typeinferencecontent/latexcreator/ExplanationCreator.java b/src/main/java/edu/kit/typicalc/view/content/typeinferencecontent/latexcreator/ExplanationCreator.java
index cdc9995..b2ecd9e 100644
--- a/src/main/java/edu/kit/typicalc/view/content/typeinferencecontent/latexcreator/ExplanationCreator.java
+++ b/src/main/java/edu/kit/typicalc/view/content/typeinferencecontent/latexcreator/ExplanationCreator.java
@@ -70,9 +70,7 @@ public class ExplanationCreator implements StepVisitor {
     }
 
     /**
-     * Returns a list of strings with an entry for every step of the algorithm.
-     *
-     * @return list of strings containing the explanatory texts
+     * @return list of strings with an entry for every step of the algorithm.
      */
     public List<String> getExplanationTexts() {
         return explanationTexts;