diff --git a/pom.xml b/pom.xml index 6d9008525be26c59b915b0e7c567ad88cf728538..2c490e2b0fb4c63e6fb4aaca0250e8ac337d577c 100644 --- 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> diff --git a/src/main/java/teetime/stage/Clock.java b/src/main/java/teetime/stage/Clock.java index fefa8d7ab9b15f36125699a88f3caf75667f7855..8980c330cf6f9f0b419c6f0427929e6e947e6ad6 100644 --- 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* +--> | | * | +---+ * | | * +------------------------+ @@ -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 diff --git a/src/main/java/teetime/stage/basic/distributor/Distributor.java b/src/main/java/teetime/stage/basic/distributor/Distributor.java index e5ee2948d42b4fc213f0c0fce3e40cf1bba264e8..5f020cbda6ab15f13df74011232ccbf6c2540472 100644 --- 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; * +---+ | | * | | | * | +---+ - * . . . . ---+-------> | | + * . . . . ---+-------> | | * | +---+ * | | | * +---+ | | diff --git a/src/main/java/teetime/stage/basic/merger/Merger.java b/src/main/java/teetime/stage/basic/merger/Merger.java index 27bbc4e8714d10900b4d8348d6c4974afdb792a2..b507228b8e055b256b82dbec932828d617868fc3 100644 --- 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; * +----------------------------+ * | | * | +---+ - * | +------------> | | + * | +------------> | | * | | +---+ * | | | * +---+ | @@ -41,7 +41,7 @@ import teetime.stage.basic.merger.strategy.RoundRobinStrategy; * +---+ | * | | | * | | +---+ - * | +------------> | | + * | +------------> | | * | +---+ * | | * +----------------------------+