From 7cc9581307481581d9108f207ddf829b31deef1e Mon Sep 17 00:00:00 2001
From: Nelson Tavares de Sousa <stu103017@mail.uni-kiel.de>
Date: Thu, 16 Oct 2014 14:30:38 +0200
Subject: [PATCH] Modified javadoc
---
.../java/teetime/framework/pipe/PipeFactoryRegistry.java | 9 ++++++---
1 file changed, 6 insertions(+), 3 deletions(-)
diff --git a/src/main/java/teetime/framework/pipe/PipeFactoryRegistry.java b/src/main/java/teetime/framework/pipe/PipeFactoryRegistry.java
index 47821865..44c20920 100644
--- a/src/main/java/teetime/framework/pipe/PipeFactoryRegistry.java
+++ b/src/main/java/teetime/framework/pipe/PipeFactoryRegistry.java
@@ -9,8 +9,8 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Provides PipeFactories, which are used to connect stages.
- * The instance of this singleton class is saved in <code>PipeFactoryRegistry.INSTANCE</code>.
+ * Represents a Registry which provides PipeFactories that are used to create pipes.
+ * The instance of this singleton class is saved in {@link PipeFactoryRegistry#INSTANCE}.
* <p>
* To get a PipeFactory instance, call {@link #getPipeFactory(ThreadCommunication, PipeOrdering, boolean)}.
*
@@ -43,6 +43,9 @@ public class PipeFactoryRegistry {
private final Map<String, IPipeFactory> pipeFactories = new HashMap<String, IPipeFactory>();
+ /**
+ * The singleton instance of PipeFactoryRegistry
+ */
public static PipeFactoryRegistry INSTANCE = new PipeFactoryRegistry();
private PipeFactoryRegistry() {
@@ -78,7 +81,7 @@ public class PipeFactoryRegistry {
}
/**
- * Registers a new PipeFactory to the registry.<br />
+ * Adds a new PipeFactory to the registry.<br />
* The new PipeFactory will be automatically selected by the Registry, if it is the most suitable Factory
* corresponding to the requirements.
*
--
GitLab