Even more JavaDoc

src/main/java/teetime/framework/Analysis.java

@@ -11,6 +11,13 @@ import org.slf4j.LoggerFactory;
 
 import teetime.util.Pair;
 
+/**
+ * Represents an Analysis to which stages can be added and executed later.
+ * This needs a {@link AnalysisConfiguration},
+ * in which the adding and configuring of stages takes place.
+ * To start the analysis {@link #init()} and {@link #start()} need to be executed in this order.
+ * This class will automatically create threads and join them without any further commitment.
+ */
 public class Analysis implements UncaughtExceptionHandler {
 
 	private static final Logger LOGGER = LoggerFactory.getLogger(Analysis.class);

src/main/java/teetime/framework/AnalysisConfiguration.java

@@ -5,6 +5,10 @@ import java.util.List;
 
 import teetime.framework.pipe.PipeFactoryRegistry;
 
+/**
+ * Represents a configuration of connected stages, which is needed to run a analysis.
+ * Stages can be added by executing {@link #addThreadableStage(Stage)}.
+ */
 public class AnalysisConfiguration {
 
 	protected static final PipeFactoryRegistry PIPE_FACTORY_REGISTRY = PipeFactoryRegistry.INSTANCE;

src/main/java/teetime/framework/Stage.java

@@ -10,6 +10,10 @@ import org.slf4j.LoggerFactory;
 import teetime.framework.signal.ISignal;
 import teetime.framework.validation.InvalidPortConnection;
 
+/**
+ * Represents a minimal Stage, with some pre-defined methods.
+ * Implemented stages need to adapt all abstract methods with own implementations.
+ */
 public abstract class Stage { // NOPMD (should not start with "Abstract")
 
 	private static final ConcurrentMap<String, Integer> INSTANCES_COUNTER = new ConcurrentHashMap<String, Integer>();