Improved java class documentation

[nonrtric.git] / policy-agent / src / main / java / org / oransc / policyagent / tasks / EnvironmentProcessor.java

diff --git a/policy-agent/src/main/java/org/oransc/policyagent/tasks/EnvironmentProcessor.java b/policy-agent/src/main/java/org/oransc/policyagent/tasks/EnvironmentProcessor.java
index 574656f..afb273d 100644 (file)
--- a/policy-agent/src/main/java/org/oransc/policyagent/tasks/EnvironmentProcessor.java
+++ b/policy-agent/src/main/java/org/oransc/policyagent/tasks/EnvironmentProcessor.java
@@ -30,6 +30,10 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import reactor.core.publisher.Mono;
 
+/**
+ * This class reads a few environment variables used for locating the Consul
+ * (Config Binding Service).
+ */
 class EnvironmentProcessor {
 
     private static final int DEFAULT_CONSUL_PORT = 8500;