From 261b99f5c9af90da484d49ab36f36c4cdd866902 Mon Sep 17 00:00:00 2001
From: Nelson Tavares de Sousa <stu103017@mail.uni-kiel.de>
Date: Tue, 16 Jun 2015 14:05:28 +0200
Subject: [PATCH] fixed all javadoc issues
---
pom.xml | 3 ---
.../java/teetime/framework/AbstractStage.java | 8 +++++++-
.../teetime/framework/pipe/IPipeFactory.java | 7 ++++++-
.../framework/pipe/PipeFactoryRegistry.java | 2 +-
.../java/teetime/framework/signal/ISignal.java | 9 +--------
src/main/java/teetime/stage/Counter.java | 2 ++
src/main/java/teetime/stage/ObjectProducer.java | 4 ++++
.../teetime/stage/io/AbstractTcpReader.java | 1 +
.../teetime/stage/io/Directory2FilesFilter.java | 17 -----------------
src/main/java/teetime/stage/util/TextLine.java | 5 -----
.../java/teetime/util/CyclicListIterator.java | 1 +
src/main/java/teetime/util/Pair.java | 4 ----
.../classpath/CachedClassForNameResolver.java | 2 +-
.../util/classpath/ClassForNameResolver.java | 1 +
.../util/io/network/AbstractTcpReader.java | 1 +
15 files changed, 26 insertions(+), 41 deletions(-)
diff --git a/pom.xml b/pom.xml
index e901b55f..e4c19186 100644
--- a/pom.xml
+++ b/pom.xml
@@ -185,9 +185,6 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.3</version>
- <configuration>
- <failOnError>false</failOnError>
- </configuration>
<executions>
<execution>
<id>attach-javadocs</id>
diff --git a/src/main/java/teetime/framework/AbstractStage.java b/src/main/java/teetime/framework/AbstractStage.java
index ab552d4d..2ece7a0c 100644
--- a/src/main/java/teetime/framework/AbstractStage.java
+++ b/src/main/java/teetime/framework/AbstractStage.java
@@ -146,6 +146,9 @@ public abstract class AbstractStage extends Stage {
/**
* Creates and adds an InputPort to the stage
*
+ * @param type
+ * class of elements to be received
+ *
* @param <T>
* the type of elements to be received
*
@@ -176,9 +179,12 @@ public abstract class AbstractStage extends Stage {
/**
* Creates and adds an OutputPort to the stage
*
+ * @param type
+ * class of elements to be sent
+ *
* @param <T>
* the type of elements to be sent
- *
+ *
* @return Newly added OutputPort
*/
protected <T> OutputPort<T> createOutputPort(final Class<T> type) {
diff --git a/src/main/java/teetime/framework/pipe/IPipeFactory.java b/src/main/java/teetime/framework/pipe/IPipeFactory.java
index 8319f0a9..26fed2b5 100644
--- a/src/main/java/teetime/framework/pipe/IPipeFactory.java
+++ b/src/main/java/teetime/framework/pipe/IPipeFactory.java
@@ -32,6 +32,9 @@ public interface IPipeFactory {
* OutputPort of the stage, which produces data.
* @param targetPort
* Input port of the receiving stage.
+ * @param <T>
+ * type of elements which traverse this pipe
+ *
* @return The connecting pipe.
*/
<T> IPipe create(OutputPort<? extends T> sourcePort, InputPort<T> targetPort);
@@ -45,6 +48,8 @@ public interface IPipeFactory {
* Input port of the receiving stage.
* @param capacity
* Number of elements the pipe can carry.
+ * @param <T>
+ * type of elements which traverse this pipe
* @return The connecting pipe.
*/
<T> IPipe create(OutputPort<? extends T> sourcePort, InputPort<T> targetPort, int capacity);
@@ -60,7 +65,7 @@ public interface IPipeFactory {
PipeOrdering getOrdering();
/**
- * @return Wether or not the created pipes are growable
+ * @return Whether or not the created pipes are growable
*/
boolean isGrowable();
diff --git a/src/main/java/teetime/framework/pipe/PipeFactoryRegistry.java b/src/main/java/teetime/framework/pipe/PipeFactoryRegistry.java
index f8347ce1..bd121f52 100644
--- a/src/main/java/teetime/framework/pipe/PipeFactoryRegistry.java
+++ b/src/main/java/teetime/framework/pipe/PipeFactoryRegistry.java
@@ -93,7 +93,7 @@ public final class PipeFactoryRegistry {
}
/**
- * Adds a new PipeFactory to the registry.<br />
+ * Adds a new PipeFactory to the registry.
* The new PipeFactory will be automatically selected by the Registry, if it is the most suitable Factory
* corresponding to the requirements.
*
diff --git a/src/main/java/teetime/framework/signal/ISignal.java b/src/main/java/teetime/framework/signal/ISignal.java
index eba8019a..7f53a3c3 100644
--- a/src/main/java/teetime/framework/signal/ISignal.java
+++ b/src/main/java/teetime/framework/signal/ISignal.java
@@ -24,13 +24,6 @@ public interface ISignal {
void trigger(Stage stage);
- /**
- * Used by the merger only (so far)
- *
- * @param receivedInputPorts
- * @param allInputPorts
- * @param stageState
- * @return <code>true</code> iff the signal may be triggered, <code>false</code> otherwise.
- */
+ // Only used by the merger so far
boolean mayBeTriggered(Set<InputPort<?>> receivedInputPorts, InputPort<?>[] allInputPorts);
}
diff --git a/src/main/java/teetime/stage/Counter.java b/src/main/java/teetime/stage/Counter.java
index 9bfc67c2..e5292df7 100644
--- a/src/main/java/teetime/stage/Counter.java
+++ b/src/main/java/teetime/stage/Counter.java
@@ -33,6 +33,8 @@ public final class Counter<T> extends AbstractConsumerStage<T> {
/**
* <i>Hint:</i> This method may not be invoked by another thread since it is not thread-safe.
+ *
+ * @return the number of passed elements
*/
public int getNumElementsPassed() {
return this.numElementsPassed;
diff --git a/src/main/java/teetime/stage/ObjectProducer.java b/src/main/java/teetime/stage/ObjectProducer.java
index 7441b89b..4a52414d 100644
--- a/src/main/java/teetime/stage/ObjectProducer.java
+++ b/src/main/java/teetime/stage/ObjectProducer.java
@@ -29,6 +29,10 @@ public final class ObjectProducer<T> extends AbstractProducerStage<T> {
private ConstructorClosure<T> inputObjectCreator;
/**
+ * @param numInputObjects
+ * number of objects which should be instantiated and sent
+ * @param inputObjectCreator
+ * a {@link ConstructorClosure} which creates the new instances
* @since 1.0
*/
public ObjectProducer(final long numInputObjects, final ConstructorClosure<T> inputObjectCreator) {
diff --git a/src/main/java/teetime/stage/io/AbstractTcpReader.java b/src/main/java/teetime/stage/io/AbstractTcpReader.java
index 0227aecd..c3738be2 100644
--- a/src/main/java/teetime/stage/io/AbstractTcpReader.java
+++ b/src/main/java/teetime/stage/io/AbstractTcpReader.java
@@ -93,6 +93,7 @@ public abstract class AbstractTcpReader<T> extends AbstractProducerStage<T> {
* @return <ul>
* <li><code>true</code> when there were enough bytes to perform the read operation
* <li><code>false</code> otherwise. In this case, the buffer is reset, compacted, and filled with new content.
+ * </ul>
*/
protected abstract boolean read(final ByteBuffer buffer);
diff --git a/src/main/java/teetime/stage/io/Directory2FilesFilter.java b/src/main/java/teetime/stage/io/Directory2FilesFilter.java
index 7a7844df..4551ab32 100644
--- a/src/main/java/teetime/stage/io/Directory2FilesFilter.java
+++ b/src/main/java/teetime/stage/io/Directory2FilesFilter.java
@@ -23,11 +23,6 @@ import java.util.Comparator;
import teetime.framework.AbstractConsumerStage;
import teetime.framework.OutputPort;
-/**
- * @author Christian Wulf
- *
- * @since 1.10
- */
public final class Directory2FilesFilter extends AbstractConsumerStage<File> {
private final OutputPort<File> outputPort = this.createOutputPort();
@@ -35,31 +30,19 @@ public final class Directory2FilesFilter extends AbstractConsumerStage<File> {
private FileFilter filter;
private Comparator<File> fileComparator;
- /**
- * @since 1.10
- */
public Directory2FilesFilter(final FileFilter fileFilter) {
this.setFilter(fileFilter);
}
- /**
- * @since 1.10
- */
public Directory2FilesFilter(final Comparator<File> fileComparator) {
this.setFileComparator(fileComparator);
}
- /**
- * @since 1.10
- */
public Directory2FilesFilter(final FileFilter fileFilter, final Comparator<File> fileComparator) {
this.setFilter(fileFilter);
this.setFileComparator(fileComparator);
}
- /**
- * @since 1.10
- */
public Directory2FilesFilter() {
super();
}
diff --git a/src/main/java/teetime/stage/util/TextLine.java b/src/main/java/teetime/stage/util/TextLine.java
index 3470c6a4..e8525b2a 100644
--- a/src/main/java/teetime/stage/util/TextLine.java
+++ b/src/main/java/teetime/stage/util/TextLine.java
@@ -19,17 +19,12 @@ import java.io.File;
/**
* @author Christian Wulf
- *
- * @since 1.10
*/
public final class TextLine {
private final File textFile;
private final String textLine;
- /**
- * @since 1.10
- */
public TextLine(final File textFile, final String textLine) {
this.textFile = textFile;
this.textLine = textLine;
diff --git a/src/main/java/teetime/util/CyclicListIterator.java b/src/main/java/teetime/util/CyclicListIterator.java
index 7f7ca993..fa33171d 100644
--- a/src/main/java/teetime/util/CyclicListIterator.java
+++ b/src/main/java/teetime/util/CyclicListIterator.java
@@ -24,6 +24,7 @@ import java.util.List;
* @author Christian Wulf
*
* @param <T>
+ * type of the elements contained in the list
*/
public final class CyclicListIterator<T> implements Iterator<T> {
diff --git a/src/main/java/teetime/util/Pair.java b/src/main/java/teetime/util/Pair.java
index dda98834..89df0944 100644
--- a/src/main/java/teetime/util/Pair.java
+++ b/src/main/java/teetime/util/Pair.java
@@ -16,10 +16,6 @@
package teetime.util;
/**
- *
- * @param <F>
- * @param <S>
- *
* @deprecated since 1.2
*/
@Deprecated
diff --git a/src/main/java/teetime/util/classpath/CachedClassForNameResolver.java b/src/main/java/teetime/util/classpath/CachedClassForNameResolver.java
index 65e3eb5d..8255a383 100644
--- a/src/main/java/teetime/util/classpath/CachedClassForNameResolver.java
+++ b/src/main/java/teetime/util/classpath/CachedClassForNameResolver.java
@@ -23,7 +23,6 @@ import java.util.concurrent.ConcurrentMap;
* the type that is used to cast a type that was found in the class path
*
* @author Christian Wulf
- * @since 1.11
*/
public final class CachedClassForNameResolver<T> {
@@ -43,6 +42,7 @@ public final class CachedClassForNameResolver<T> {
* @return A {@link Class} instance corresponding to the given name, if it exists.
*
* @throws ClassNotFoundException
+ * thrown iff no class was found for the given <b>classname</b>
*/
public final Class<? extends T> classForName(final String classname) throws ClassNotFoundException {
Class<? extends T> clazz = this.cachedClasses.get(classname);
diff --git a/src/main/java/teetime/util/classpath/ClassForNameResolver.java b/src/main/java/teetime/util/classpath/ClassForNameResolver.java
index 3db67725..349efcdf 100644
--- a/src/main/java/teetime/util/classpath/ClassForNameResolver.java
+++ b/src/main/java/teetime/util/classpath/ClassForNameResolver.java
@@ -38,6 +38,7 @@ public final class ClassForNameResolver<T> {
*
* @return A {@link Class} instance corresponding to the given name, if it exists.
* @throws ClassNotFoundException
+ * thrown iff no class was found for the given <b>classname</b>
*
*/
public final Class<? extends T> classForName(final String classname) throws ClassNotFoundException {
diff --git a/src/main/java/teetime/util/io/network/AbstractTcpReader.java b/src/main/java/teetime/util/io/network/AbstractTcpReader.java
index 704eb58b..1d5fc7ce 100644
--- a/src/main/java/teetime/util/io/network/AbstractTcpReader.java
+++ b/src/main/java/teetime/util/io/network/AbstractTcpReader.java
@@ -98,6 +98,7 @@ public abstract class AbstractTcpReader implements Runnable {
* @return <ul>
* <li><code>true</code> when there were enough bytes to perform the read operation
* <li><code>false</code> otherwise. In this case, the buffer is reset, compacted, and filled with new content.
+ * </ul>
*/
protected abstract boolean onBufferReceived(final ByteBuffer buffer);
--
GitLab