- javadoc

Author: LukasMolzberger

src/main/java/network/aika/Thought.java

@@ -177,13 +177,21 @@ private boolean checkMaxPhaseReached(Phase maxPhase) {
         return maxPhase.compareTo(queue.firstEntry().getValue().getPhase()) < 0;
     }
 
+
+    /**
+     * After the switch into final mode, the initial assumption, that the positive feedback synapses are fully
+     * active is reverted and the actual evaluation of the feedback synapses takes place.
+     */
     public void processFinalMode() {
         activationsById.values()
                 .forEach(act -> act.setFinal());
 
         process(PROCESSING);
     }
 
+    /**
+     * The postprocessing steps such as counting, cleanup or save are executed.
+     */
     public void postProcessing() {
         process(POST_PROCESSING);
     }
@@ -227,9 +235,6 @@ public int getNumberOfActivations() {
     public String toString() {
         StringBuilder sb = new StringBuilder();
         for(Activation act: activationsById.values()) {
-/*            if(!act.isActive())
-                continue;
-*/
             sb.append(act.toString());
             sb.append("\n");
         }

src/main/java/network/aika/fields/package-info.java

@@ -0,0 +1,12 @@
+package network.aika.fields;
+
+/**
+ * This package contains an implementation of an event driven fields and functions concept. Each field and function can
+ * either act as an event source or an event sink and can propagate changes to its value to all the registered listeners.
+ * The package recognizes the close relation between differential algebra and event-driven programming. For example to
+ * implement the conjunction of two events requires the implementation of a rule like: If A was triggered the check
+ * if B is already true and if B is triggered than check if A is already true. This is essentially the product rule.
+ * Implementing this rule by hand without this more explicit and descriptive field concept requires the programmer to
+ * take care of these two cases A and B by hand which are usually scattered across the entire code base, easily leading
+ * to unwanted bugs.
+ */