From f7d17f5a069dce7614b413724adb47885812b908 Mon Sep 17 00:00:00 2001
From: Nelson Tavares de Sousa <stu103017@mail.uni-kiel.de>
Date: Wed, 26 Aug 2015 13:53:11 +0200
Subject: [PATCH] added stage sketch as third custom javadoc tag
---
pom.xml | 10 ++++++++++
src/main/java/teetime/stage/Clock.java | 10 ++++------
.../teetime/stage/basic/distributor/Distributor.java | 8 ++++----
src/main/java/teetime/stage/basic/merger/Merger.java | 8 ++++----
4 files changed, 22 insertions(+), 14 deletions(-)
diff --git a/pom.xml b/pom.xml
index 2c490e2b..7572b9f9 100644
--- a/pom.xml
+++ b/pom.xml
@@ -202,6 +202,11 @@
<placement>t</placement>
<head>Stage output:</head>
</tag>
+ <tag>
+ <name>stage.sketch</name>
+ <placement>t</placement>
+ <head>Stage sketch:</head>
+ </tag>
</tags>
</configuration>
<executions>
@@ -439,6 +444,11 @@
<placement>t</placement>
<head>Stage output:</head>
</tag>
+ <tag>
+ <name>stage.sketch</name>
+ <placement>t</placement>
+ <head>Stage sketch:</head>
+ </tag>
</tags>
</configuration>
</plugin>
diff --git a/src/main/java/teetime/stage/Clock.java b/src/main/java/teetime/stage/Clock.java
index 8980c330..b263bf02 100644
--- a/src/main/java/teetime/stage/Clock.java
+++ b/src/main/java/teetime/stage/Clock.java
@@ -21,9 +21,9 @@ import teetime.framework.TerminationStrategy;
/**
* This stage sends an element repeatedly with a given interval {@link #intervalDelayInMs}.
*
- * <pre>
- * Illustration:
- *
+ * @stage.sketch
+ *
+ * <pre>
* +------------------------+
* | |
* | +---+
@@ -31,9 +31,7 @@ import teetime.framework.TerminationStrategy;
* | +---+
* | |
* +------------------------+
- *
- *
- * </pre>
+ * </pre>
*
* @author Nelson Tavares de Sousa
*
diff --git a/src/main/java/teetime/stage/basic/distributor/Distributor.java b/src/main/java/teetime/stage/basic/distributor/Distributor.java
index 5f020cbd..0185d3a0 100644
--- a/src/main/java/teetime/stage/basic/distributor/Distributor.java
+++ b/src/main/java/teetime/stage/basic/distributor/Distributor.java
@@ -24,9 +24,9 @@ import teetime.stage.basic.distributor.strategy.RoundRobinStrategy2;
/**
*
- * <pre>
- * Illustration:
- *
+ * @stage.sketch
+ *
+ * <pre>
* +---------------------------+
* | |
* +---+ |
@@ -44,7 +44,7 @@ import teetime.stage.basic.distributor.strategy.RoundRobinStrategy2;
* +---------------------------+
*
*
- * </pre>
+ * </pre>
*
* @author Christian Wulf
*
diff --git a/src/main/java/teetime/stage/basic/merger/Merger.java b/src/main/java/teetime/stage/basic/merger/Merger.java
index b507228b..1570c7b3 100644
--- a/src/main/java/teetime/stage/basic/merger/Merger.java
+++ b/src/main/java/teetime/stage/basic/merger/Merger.java
@@ -27,9 +27,9 @@ import teetime.stage.basic.merger.strategy.RoundRobinStrategy;
*
* This stage merges data from the input ports, by taking elements according to the chosen merge strategy and by putting them to the output port.
*
- * <pre>
- * Illustration:
- *
+ * @stage.sketch
+ *
+ * <pre>
* +----------------------------+
* | |
* | +---+
@@ -45,7 +45,7 @@ import teetime.stage.basic.merger.strategy.RoundRobinStrategy;
* | +---+
* | |
* +----------------------------+
- * </pre>
+ * </pre>
*
*
* @author Christian Wulf, Nelson Tavares de Sousa
--
GitLab