From 8ac3ab4bb24a4fa104458a05dbca30604617ec08 Mon Sep 17 00:00:00 2001
From: Nelson Tavares de Sousa <stu103017@mail.uni-kiel.de>
Date: Thu, 16 Oct 2014 15:31:00 +0200
Subject: [PATCH] javadoc
---
src/main/java/teetime/framework/pipe/InterThreadPipe.java | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/src/main/java/teetime/framework/pipe/InterThreadPipe.java b/src/main/java/teetime/framework/pipe/InterThreadPipe.java
index 0825c280..258b6412 100644
--- a/src/main/java/teetime/framework/pipe/InterThreadPipe.java
+++ b/src/main/java/teetime/framework/pipe/InterThreadPipe.java
@@ -24,6 +24,11 @@ public abstract class InterThreadPipe extends AbstractPipe {
this.signalQueue.offer(signal);
}
+ /**
+ * Retrieves and removes the head of the signal queue
+ *
+ * @return Head of signal queue, <code>null</code> if signal queue is empty.
+ */
public ISignal getSignal() {
return this.signalQueue.poll();
}
--
GitLab