fixed javadoc

src/main/java/teetime/framework/AbstractStage.java

@@ -130,6 +130,9 @@ public abstract class AbstractStage extends Stage {
 	/**
 	 * Creates and adds an InputPort to the stage
 	 *
+	 * @param <T>
+	 *            the type of elements to be received
+	 *
 	 * @return Newly added InputPort
 	 *
 	 */
@@ -143,7 +146,9 @@ public abstract class AbstractStage extends Stage {
 	/**
 	 * Creates and adds an InputPort to the stage
 	 *
-	 * @param type
+	 * @param <T>
+	 *            the type of elements to be received
+	 *
 	 * @return Newly added InputPort
 	 */
 	protected <T> InputPort<T> createInputPort(final Class<T> type) {
@@ -155,6 +160,9 @@ public abstract class AbstractStage extends Stage {
 	/**
 	 * Creates and adds an OutputPort to the stage
 	 *
+	 * @param <T>
+	 *            the type of elements to be sent
+	 *
 	 * @return Newly added OutputPort
 	 *
 	 */
@@ -168,7 +176,9 @@ public abstract class AbstractStage extends Stage {
 	/**
 	 * Creates and adds an OutputPort to the stage
 	 *
-	 * @param type
+	 * @param <T>
+	 *            the type of elements to be sent
+	 * 
 	 * @return Newly added OutputPort
 	 */
 	protected <T> OutputPort<T> createOutputPort(final Class<T> type) {

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

@@ -82,7 +82,11 @@ public abstract class AnalysisConfiguration {
 	 * Connects two stages with a pipe within the same thread.
 	 *
 	 * @param sourcePort
+	 *            {@link OutputPort} of the sending stage
 	 * @param targetPort
+	 *            {@link InputPort} of the sending stage
+	 * @param <T>
+	 *            the type of elements to be sent
 	 * @return
 	 *         the pipe instance which connects the two given stages
 	 *
@@ -97,7 +101,11 @@ public abstract class AnalysisConfiguration {
 	 * Connects two stages with a bounded pipe within two separate threads.
 	 *
 	 * @param sourcePort
+	 *            {@link OutputPort} of the sending stage
 	 * @param targetPort
+	 *            {@link InputPort} of the sending stage
+	 * @param <T>
+	 *            the type of elements to be sent
 	 * @return
 	 *         the pipe instance which connects the two given stages
 	 *
@@ -112,7 +120,11 @@ public abstract class AnalysisConfiguration {
 	 * Connects two stages with a unbounded pipe within two separate threads.
 	 *
 	 * @param sourcePort
+	 *            {@link OutputPort} of the sending stage
 	 * @param targetPort
+	 *            {@link InputPort} of the sending stage
+	 * @param <T>
+	 *            the type of elements to be sent
 	 * @return
 	 *         the pipe instance which connects the two given stages
 	 *
@@ -127,10 +139,15 @@ public abstract class AnalysisConfiguration {
 	 * Connects two stages with a bounded pipe within two separate threads.
 	 *
 	 * @param sourcePort
+	 *            {@link OutputPort} of the sending stage
 	 * @param targetPort
+	 *            {@link InputPort} of the sending stage
 	 * @param capacity
 	 *            capacity of the underlying queue
+	 * @param <T>
+	 *            the type of elements to be sent
 	 * @return
+	 *         the pipe instance which connects the two given stages
 	 *
 	 * @deprecated since 1.2. Use {@link #connectPorts(OutputPort, InputPort)} instead.
 	 */
@@ -143,10 +160,15 @@ public abstract class AnalysisConfiguration {
 	 * Connects two stages with a unbounded pipe within two separate threads.
 	 *
 	 * @param sourcePort
+	 *            {@link OutputPort} of the sending stage
 	 * @param targetPort
+	 *            {@link InputPort} of the sending stage
 	 * @param capacity
 	 *            capacity of the underlying queue
+	 * @param <T>
+	 *            the type of elements to be sent
 	 * @return
+	 *         the pipe instance which connects the two given stages
 	 *
 	 * @deprecated since 1.2. Use {@link #connectPorts(OutputPort, InputPort)} instead.
 	 */
@@ -156,12 +178,14 @@ public abstract class AnalysisConfiguration {
 	}
 
 	/**
-	 * Connects two ports with a pipe.
+	 * Connects two ports with a pipe with a default capacity of currently 4
 	 *
 	 * @param sourcePort
-	 *            port from the sending stage
+	 *            {@link OutputPort} of the sending stage
 	 * @param targetPort
-	 *            port from the receiving stage
+	 *            {@link InputPort} of the sending stage
+	 * @param <T>
+	 *            the type of elements to be sent
 	 */
 	protected <T> void connectPorts(final OutputPort<? extends T> sourcePort, final InputPort<T> targetPort) {
 		connectPorts(sourcePort, targetPort, 4);
@@ -171,11 +195,13 @@ public abstract class AnalysisConfiguration {
 	 * Connects to ports with a pipe of a certain capacity
 	 *
 	 * @param sourcePort
-	 *            port from the sending stage
+	 *            {@link OutputPort} of the sending stage
 	 * @param targetPort
-	 *            port from the receiving stage
+	 *            {@link InputPort} of the sending stage
 	 * @param capacity
 	 *            the pipe is set to this capacity, if the value is greater than 0. If it is 0, than the pipe is unbounded, thus growing of the pipe is enabled.
+	 * @param <T>
+	 *            the type of elements to be sent
 	 */
 	protected <T> void connectPorts(final OutputPort<? extends T> sourcePort, final InputPort<T> targetPort, final int capacity) {
 		connections.add(new Connection<T>(sourcePort, targetPort, capacity));

src/main/java/teetime/framework/InputPort.java

@@ -15,6 +15,15 @@
  */
 package teetime.framework;
 
+/**
+ *
+ * @author Christian Wulf
+ *
+ * @param <T>
+ *            the type of elements to be sent
+ *
+ * @since 1.0
+ */
 public final class InputPort<T> extends AbstractPort<T> {
 
 	InputPort(final Class<T> type, final Stage owningStage) {

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

@@ -131,6 +131,9 @@ public abstract class Stage {
 	/**
 	 * Event that is triggered within the initialization phase of the analysis.
 	 * It does not count to the execution time.
+	 *
+	 * @throws Exception
+	 *             an arbitrary exception if an error occurs during the initialization
 	 */
 	@SuppressWarnings("PMD.SignatureDeclareThrowsException")
 	public abstract void onInitializing() throws Exception;

src/main/java/teetime/framework/exceptionHandling/AbstractExceptionListener.java

@@ -21,8 +21,9 @@ import org.slf4j.LoggerFactory;
 import teetime.framework.Stage;
 
 /**
- * Represent a minimalistic StageExceptionListener. Listener which extend from this one, must a least implement this functionality.
- * This abstract class provides a Logger {@link #logger} and a method to terminate the threads execution {@link #terminateExecution()}.
+ * Represents a minimalistic StageExceptionListener.
+ * Listener which extend from this one, must a least implement this functionality.
+ * This abstract class provides a Logger {@link #logger} and the method {@link #onStageException(Exception, Stage)} which is called on every raised exception.
  */
 public abstract class AbstractExceptionListener {
 

src/main/java/teetime/framework/pipe/PipeFactoryRegistry.java

@@ -28,7 +28,7 @@ import org.slf4j.LoggerFactory;
  * <p>
  * To get a PipeFactory instance, call {@link #getPipeFactory(ThreadCommunication, PipeOrdering, boolean)}.
  *
- * @Deprecated since 1.2
+ * @deprecated since 1.2
  */
 @Deprecated
 public final class PipeFactoryRegistry {