Merge "Fix Javadoc errors"

8 files changed, 25 insertions, 23 deletions

diff --git a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CLICommand.java b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CLICommand.java
index 74f4a6f92..7f4333cd8 100644
--- a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CLICommand.java
+++ b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CLICommand.java
@@ -27,7 +27,7 @@ import org.onap.policy.apex.model.utilities.Assertions;
 
 /**
  * This class represents a single Apex CLI command that is issued to the Apex Editor Java API
- * {@link com.ericsson.apex.model.modelapi.ApexEditorAPI}.
+ * {@link org.onap.policy.apex.model.modelapi.ApexEditorAPI}.
  *
  * @author Liam Fallon (liam.fallon@ericsson.com)
  */
diff --git a/core/core-infrastructure/src/main/java/org/onap/policy/apex/core/infrastructure/messaging/util/MessagingUtils.java b/core/core-infrastructure/src/main/java/org/onap/policy/apex/core/infrastructure/messaging/util/MessagingUtils.java
index 44b3c7fab..fb79d9270 100644
--- a/core/core-infrastructure/src/main/java/org/onap/policy/apex/core/infrastructure/messaging/util/MessagingUtils.java
+++ b/core/core-infrastructure/src/main/java/org/onap/policy/apex/core/infrastructure/messaging/util/MessagingUtils.java
@@ -100,9 +100,9 @@ public final class MessagingUtils {
     }
 
     /**
-     * Check if port is available or not
+     * Check if port is available or not.
      * 
-     * @param port
+     * @param port the port to test
      * @return true if port is available
      */
     public static boolean isPortAvailable(final int port) {
diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/ApexException.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/ApexException.java
index 913924389..94472d3eb 100644
--- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/ApexException.java
+++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/ApexException.java
@@ -85,6 +85,7 @@ public class ApexException extends Exception {
     /**
      * Build a cascaded message from an exception and all its nested exceptions
      * @param throwable the top level exception
+     * @return cascaded message string
      */
     public static String buildCascadedMessage(Throwable throwable) {
         final StringBuilder builder = new StringBuilder();
diff --git a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSObjectEventProtocolParameters.java b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSObjectEventProtocolParameters.java
index c2baff8e6..83aef4e9d 100644
--- a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSObjectEventProtocolParameters.java
+++ b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSObjectEventProtocolParameters.java
@@ -26,34 +26,34 @@ import org.onap.policy.apex.service.parameters.eventprotocol.EventProtocolParame
  * Event protocol parameters for JMS Object messages as an event protocol.
  *
  * <p>
- * On reception of an a JMS {@link javax.jms.ObjectMessage}, the JMS Object plugin unmarshals the message as follows:
+ * On reception of an a JMS {@code javax.jms.ObjectMessage}, the JMS Object plugin unmarshals the message as follows:
  * <ol>
- * <li>It extracts the Java object from the {@link javax.jms.ObjectMessage} instance.
- * <li>It creates an {@link org.onap.policy.apex.service.engine.event.ApexEvent} instance to hold the java object.
+ * <li>It extracts the Java object from the {@code javax.jms.ObjectMessage} instance.</li>
+ * <li>It creates an {@link org.onap.policy.apex.service.engine.event.ApexEvent} instance to hold the java object.</li>
  * <li>It sets the name of the Apex event to be the simple class name of the incoming Java object and appends the value
- * of the {@code incomingEventSuffix} parameter to it.
- * <li>It sets the version of the incoming event to the value of the {@code incomingEventVersion} parameter.
+ * of the {@code incomingEventSuffix} parameter to it.</li>
+ * <li>It sets the version of the incoming event to the value of the {@code incomingEventVersion} parameter.</li>
  * <li>It sets the name space of the incoming event to be the value of the package of the class of the incoming Java
- * object.
- * <li>It sets the source of the incoming event to the value of the {@code incomingEventSource} parameter.
- * <li>It sets the target of the incoming event to the value of the {@code incomingEventTarget} parameter.
+ * object.</li>
+ * <li>It sets the source of the incoming event to the value of the {@code incomingEventSource} parameter.</li>
+ * <li>It sets the target of the incoming event to the value of the {@code incomingEventTarget} parameter.</li>
  * <li>It puts a single entry into the Apex event map with the the simple class name of the incoming Java object being
- * the key of the entry and the actual incoming object as the value of the entry.
+ * the key of the entry and the actual incoming object as the value of the entry.</li>
  * </ol>
  * <p>
  * When sending an object to JMS, the plugin expects to receive an Apex event with a single entry. The plugin marshals
- * the value of that entry to an object that can be sent by JMS as a {@link javax.jms.ObjectMessage} instance.
+ * the value of that entry to an object that can be sent by JMS as a {@code javax.jms.ObjectMessage} instance.
  * <p>
  * The parameters for this plugin are:
  * <ol>
  * <li>incomingEventSuffix: The suffix to append to the simple name of incoming Java class instances when they are
- * encapsulated in Apex events. The parameter defaults to the string value {@code IncomingEvent}.
+ * encapsulated in Apex events. The parameter defaults to the string value {@code IncomingEvent}.</li>
  * <li>incomingEventVersion: The event version to use for incoming Java class instances when they are encapsulated in
- * Apex events. The parameter defaults to the string value {@code 1.0.0}.
+ * Apex events. The parameter defaults to the string value {@code 1.0.0}.</li>
  * <li>incomingEventSource: The event source to use for incoming Java class instances when they are encapsulated in Apex
- * events. The parameter defaults to the string value {@code JMS}.
+ * events. The parameter defaults to the string value {@code JMS}.</li>
  * <li>incomingEventTarget: The event target to use for incoming Java class instances when they are encapsulated in Apex
- * events. The parameter defaults to the string value {@code Apex}.
+ * events. The parameter defaults to the string value {@code Apex}.</li>
  * </ol>
  *
  * @author Liam Fallon (liam.fallon@ericsson.com)
diff --git a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSTextEventProtocolParameters.java b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSTextEventProtocolParameters.java
index 8ddc64862..b3a9154ff 100644
--- a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSTextEventProtocolParameters.java
+++ b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSTextEventProtocolParameters.java
@@ -28,7 +28,7 @@ import org.onap.policy.apex.service.engine.event.impl.jsonprotocolplugin.JSONEve
  * Text messages received and sent over JMS in ~Text format are assumed to be in a JSON format that Apex can understand.
  * Therefore this plugin is a subclass of the built in JSON event protocol plugin.
  * <p>
- * On reception of a JMS {@link javax.jms.TextMessage} message, the JMS Text plugin unmarshals the message the JMS text
+ * On reception of a JMS {@code javax.jms.TextMessage} message, the JMS Text plugin unmarshals the message the JMS text
  * message and passes it to its JSON superclass unmarshaling for processing.
  * <p>
  * When sending an Apex event, the plugin uses its underlying JSON superclass to marshal the event to a JSON string and
diff --git a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/package-info.java b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/package-info.java
index 92d6d07d4..f7e236743 100644
--- a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/package-info.java
+++ b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/package-info.java
@@ -20,7 +20,7 @@
 
 /**
  * Contains implementations of Apex event protocol converter plugins for JMS event protocols that are implementations of
- * {@link javax.jms.Message}.
+ * {@code javax.jms.Message}.
  *
  * @author Liam Fallon (liam.fallon@ericsson.com)
  */
diff --git a/plugins/plugins-event/plugins-event-protocol/pom.xml b/plugins/plugins-event/plugins-event-protocol/pom.xml
index 563a4f625..a751dc4ba 100644
--- a/plugins/plugins-event/plugins-event-protocol/pom.xml
+++ b/plugins/plugins-event/plugins-event-protocol/pom.xml
@@ -40,5 +40,6 @@
     <modules>
         <module>plugins-event-protocol-jms</module>
         <module>plugins-event-protocol-xml</module>
+        <module>plugins-event-protocol-yaml</module>
     </modules>
-</project>
\ No newline at end of file
+</project>
diff --git a/plugins/plugins-executor/plugins-executor-mvel/src/main/java/org/onap/policy/apex/plugins/executor/mvel/package-info.java b/plugins/plugins-executor/plugins-executor-mvel/src/main/java/org/onap/policy/apex/plugins/executor/mvel/package-info.java
index 8e8ab889b..f7f1498be 100644
--- a/plugins/plugins-executor/plugins-executor-mvel/src/main/java/org/onap/policy/apex/plugins/executor/mvel/package-info.java
+++ b/plugins/plugins-executor/plugins-executor-mvel/src/main/java/org/onap/policy/apex/plugins/executor/mvel/package-info.java
@@ -20,9 +20,9 @@
 
 /**
  * Implements the MVEL executor plugin for APEX, providing extensions of the abstract classes
- * {@link com.ericsson.apex.core.engine.executor.TaskExecutor},
- * {@link com.ericsson.apex.core.engine.executor.TaskSelectExecutor}, and
- * {@link com.ericsson.apex.core.engine.executor.StateFinalizerExecutor}.
+ * {@link org.onap.policy.apex.core.engine.executor.TaskExecutor},
+ * {@link org.onap.policy.apex.core.engine.executor.TaskSelectExecutor}, and
+ * {@link org.onap.policy.apex.core.engine.executor.StateFinalizerExecutor}.
  *
  * @author Liam Fallon (liam.fallon@ericsson.com)
  */