added custom javadoc tags

f27f858e · Nelson Tavares de Sousa · 8fe02746 · f27f858e · f27f858e · f27f858e
Commit f27f858e authored 9 years ago by Nelson Tavares de Sousa
--- a/pom.xml
+++ b/pom.xml
@@ -190,6 +190,20 @@
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-javadoc-plugin</artifactId>
 				<version>${javadoc.version}</version>
+				<configuration>
+					<tags>
+						<tag>
+							<name>stage.input</name>
+							<placement>t</placement>
+							<head>Stage input:</head>
+						</tag>
+						<tag>
+							<name>stage.output</name>
+							<placement>t</placement>
+							<head>Stage output:</head>
+						</tag>
+					</tags>
+				</configuration>
 				<executions>
 					<execution>
 						<id>attach-javadocs</id>
@@ -414,6 +428,18 @@
 				<version>${javadoc.version}</version>
 				<configuration>
 					<destDir>${javadocOutputDir}</destDir>
+					<tags>
+						<tag>
+							<name>stage.input</name>
+							<placement>t</placement>
+							<head>Stage input:</head>
+						</tag>
+						<tag>
+							<name>stage.output</name>
+							<placement>t</placement>
+							<head>Stage output:</head>
+						</tag>
+					</tags>
 				</configuration>
 			</plugin>
 		</plugins>

--- a/src/main/java/teetime/stage/Clock.java
+++ b/src/main/java/teetime/stage/Clock.java
@@ -19,7 +19,7 @@ import teetime.framework.AbstractProducerStage;
 import teetime.framework.TerminationStrategy;

 /**
- * This stage sends an element repeatedly with a given interval.
+ * This stage sends an element repeatedly with a given interval {@link #intervalDelayInMs}.
 *
 * <pre>
 * Illustration:
@@ -27,7 +27,7 @@ import teetime.framework.TerminationStrategy;
 * +------------------------+
 * |                        |
 * |                      +---+
- * |      *INTERVAL* +--> |   |
+ * |      *INTERVAL* +--&gt; |   |
 * |                      +---+
 * |                        |
 * +------------------------+
@@ -37,12 +37,20 @@ import teetime.framework.TerminationStrategy;
 *
 * @author Nelson Tavares de Sousa
 *
+ * @stage.output A long with the current system time in ms.
+ *
 */
 public final class Clock extends AbstractProducerStage<Long> {

 	private boolean initialDelayExceeded = false;

+	/**
+	 * Waiting time span until first sent element.
+	 */
 	private long initialDelayInMs;
+	/**
+	 * Interval between two sent elements.
+	 */
 	private long intervalDelayInMs;

 	@Override

--- a/src/main/java/teetime/stage/basic/distributor/Distributor.java
+++ b/src/main/java/teetime/stage/basic/distributor/Distributor.java
@@ -34,7 +34,7 @@ import teetime.stage.basic.distributor.strategy.RoundRobinStrategy2;
 * +---+             |           |
 *   |               |           |
 *                   |         +---+
- *   .      . . . ---+-------> |   |
+ *   .      . . . ---+-------&gt; |   |
 *                   |         +---+
 *   |               |           |
 * +---+             |           |

--- a/src/main/java/teetime/stage/basic/merger/Merger.java
+++ b/src/main/java/teetime/stage/basic/merger/Merger.java
@@ -33,7 +33,7 @@ import teetime.stage.basic.merger.strategy.RoundRobinStrategy;
 *     +----------------------------+
 *     |                            |
 *     |                          +---+
- *     |           +------------> |   |
+ *     |           +------------&gt; |   |
 *     |           |              +---+
 *     |           |                |
 *   +---+         |
@@ -41,7 +41,7 @@ import teetime.stage.basic.merger.strategy.RoundRobinStrategy;
 *   +---+         |
 *     |           |                |
 *     |           |              +---+
- *     |           +------------> |   |
+ *     |           +------------&gt; |   |
 *     |                          +---+
 *     |                            |
 *     +----------------------------+