From 32b0e871b17067dbb193899eadf8305ec9c24090 Mon Sep 17 00:00:00 2001
From: Christian Wulf <chw@informatik.uni-kiel.de>
Date: Tue, 16 Dec 2014 10:56:12 +0100
Subject: [PATCH] updated javadoc
---
src/main/java/teetime/framework/pipe/IPipe.java | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/main/java/teetime/framework/pipe/IPipe.java b/src/main/java/teetime/framework/pipe/IPipe.java
index e4e0dec8..daca7518 100644
--- a/src/main/java/teetime/framework/pipe/IPipe.java
+++ b/src/main/java/teetime/framework/pipe/IPipe.java
@@ -5,7 +5,7 @@ import teetime.framework.OutputPort;
import teetime.framework.signal.ISignal;
/**
- * Represents an interface, which should be adapted by all implementations of pipes.
+ * Represents a pipe that connects an output port with an input port.
*/
public interface IPipe {
@@ -14,14 +14,14 @@ public interface IPipe {
*
* @param element
* Element which will be added
- * @return True if the element could be added, false otherwise
+ * @return <code>true</code> if the element could be added, false otherwise
*/
boolean add(Object element);
/**
* Checks whether the pipe is empty or not.
*
- * @return True if the pipe is empty, false otherwise.
+ * @return <code>true</code> if the pipe is empty, false otherwise.
*/
boolean isEmpty();
--
GitLab