Paketbeschreibungen für parser, term, type, step

src/main/java/edu/kit/typicalc/model/TypeInferer.java

@@ -47,8 +47,6 @@ public class TypeInferer implements TypeInfererInterface {
         // cancel algorithm if term can't be typified
         if (!unification.getSubstitutions().isOk()) {
             typeInfResult = Optional.empty();
-            // TODO: schönere Methode, mit nicht typisierbar umzugehen?
-            //  getter unten anpassen!
             return;
         }
 

src/main/java/edu/kit/typicalc/model/parser/package-info.java

@@ -0,0 +1,10 @@
+@NonNullApi
+@NonNullFields
+/**
+ * The parser package contains all classes needed to parse the input strings from the user to an abstract form
+ * consisting of classes provided by the the model, term and type package.
+ */
+package edu.kit.typicalc.model.parser;
+
+import org.springframework.lang.NonNullApi;
+import org.springframework.lang.NonNullFields;

src/main/java/edu/kit/typicalc/model/step/package-info.java

@@ -0,0 +1,11 @@
+@NonNullFields
+@NonNullApi
+/**
+ * The step package models the inference steps that are executed while generating the prof tree.
+ * To represent the different kinds of typing rules that can be applied, InferenceStep has various subclasses.
+ * These subclasses can be produced by factories, appropriate to the desired context.
+ */
+package edu.kit.typicalc.model.step;
+
+import org.springframework.lang.NonNullApi;
+import org.springframework.lang.NonNullFields;

src/main/java/edu/kit/typicalc/model/term/package-info.java

@@ -0,0 +1,10 @@
+@NonNullFields
+@NonNullApi
+/**
+ * The term package models the different kinds of lambda terms:
+ * application, abstraction, variable constant and let-polymorphism.
+ */
+package edu.kit.typicalc.model.term;
+
+import org.springframework.lang.NonNullApi;
+import org.springframework.lang.NonNullFields;

src/main/java/edu/kit/typicalc/model/type/package-info.java

@@ -1,4 +1,9 @@
 @NonNullApi
+@NonNullFields
+/**
+ * The type package models all types that can be assigned to lambda terms.
+ */
 package edu.kit.typicalc.model.type;
 
 import org.springframework.lang.NonNullApi;
+import org.springframework.lang.NonNullFields;