From f27f858ea9d5368ba9e2406f93096b2088b02cf1 Mon Sep 17 00:00:00 2001
From: Nelson Tavares de Sousa <stu103017@mail.uni-kiel.de>
Date: Wed, 26 Aug 2015 13:48:26 +0200
Subject: [PATCH] added custom javadoc tags
---
pom.xml | 26 +++++++++++++++++++
src/main/java/teetime/stage/Clock.java | 12 +++++++--
.../stage/basic/distributor/Distributor.java | 2 +-
.../teetime/stage/basic/merger/Merger.java | 4 +--
4 files changed, 39 insertions(+), 5 deletions(-)
diff --git a/pom.xml b/pom.xml
index 6d900852..2c490e2b 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 fefa8d7a..8980c330 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 e5ee2948..5f020cbd 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 27bbc4e8..b507228b 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;
* +---+ |
* | | |
* | | +---+
- * | +------------> | |
+ * | +------------> | |
* | +---+
* | |
* +----------------------------+
--
GitLab