Replace non-Javadoc comments with inheritDocs

Copyright headers not changed as this review only amends comments.

Issue-ID: POLICY-1791
Change-Id: Icbeb2c6e591b3b160ae102bb67aef2d407924a4d
Signed-off-by: liamfallon <liam.fallon@est.tech>

13 files changed, 86 insertions, 127 deletions

diff --git a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/jms/JmsEventProducer.java b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/jms/JmsEventProducer.java
index ab2f45c22..dcec4a944 100644
--- a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/jms/JmsEventProducer.java
+++ b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/jms/JmsEventProducer.java
@@ -81,8 +81,8 @@ public class JmsEventProducer implements Runnable {
         producerThread.start();
     }
 
-    /* (non-Javadoc)
-     * @see java.lang.Runnable#run()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void run() {
diff --git a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/jms/JmsEventSubscriber.java b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/jms/JmsEventSubscriber.java
index 9dd58c817..94155c1a5 100644
--- a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/jms/JmsEventSubscriber.java
+++ b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/jms/JmsEventSubscriber.java
@@ -71,10 +71,8 @@ public class JmsEventSubscriber implements Runnable {
         subscriberThread.start();
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see java.lang.Runnable#run()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void run() {
diff --git a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/jms/TestContext.java b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/jms/TestContext.java
index b8ea0c7fe..a44f84444 100644
--- a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/jms/TestContext.java
+++ b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/jms/TestContext.java
@@ -70,210 +70,210 @@ public class TestContext implements Context {
         }
     }
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#lookup(javax.naming.Name)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public Object lookup(final Name name) throws NamingException {
         return null;
     }
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#lookup(java.lang.String)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public Object lookup(final String name) throws NamingException {
         return testProperties.get(name);
     }
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#bind(javax.naming.Name, java.lang.Object)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void bind(final Name name, final Object obj) throws NamingException {}
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#bind(java.lang.String, java.lang.Object)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void bind(final String name, final Object obj) throws NamingException {}
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#rebind(javax.naming.Name, java.lang.Object)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void rebind(final Name name, final Object obj) throws NamingException {}
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#rebind(java.lang.String, java.lang.Object)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void rebind(final String name, final Object obj) throws NamingException {}
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#unbind(javax.naming.Name)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void unbind(final Name name) throws NamingException {}
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#unbind(java.lang.String)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void unbind(final String name) throws NamingException {}
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#rename(javax.naming.Name, javax.naming.Name)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void rename(final Name oldName, final Name newName) throws NamingException {}
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#rename(java.lang.String, java.lang.String)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void rename(final String oldName, final String newName) throws NamingException {}
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#list(javax.naming.Name)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public NamingEnumeration<NameClassPair> list(final Name name) throws NamingException {
         return null;
     }
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#list(java.lang.String)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public NamingEnumeration<NameClassPair> list(final String name) throws NamingException {
         return null;
     }
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#listBindings(javax.naming.Name)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public NamingEnumeration<Binding> listBindings(final Name name) throws NamingException {
         return null;
     }
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#listBindings(java.lang.String)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public NamingEnumeration<Binding> listBindings(final String name) throws NamingException {
         return null;
     }
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#destroySubcontext(javax.naming.Name)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void destroySubcontext(final Name name) throws NamingException {}
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#destroySubcontext(java.lang.String)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void destroySubcontext(final String name) throws NamingException {}
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#createSubcontext(javax.naming.Name)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public Context createSubcontext(final Name name) throws NamingException {
         return null;
     }
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#createSubcontext(java.lang.String)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public Context createSubcontext(final String name) throws NamingException {
         return null;
     }
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#lookupLink(javax.naming.Name)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public Object lookupLink(final Name name) throws NamingException {
         return null;
     }
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#lookupLink(java.lang.String)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public Object lookupLink(final String name) throws NamingException {
         return null;
     }
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#getNameParser(javax.naming.Name)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public NameParser getNameParser(final Name name) throws NamingException {
         return null;
     }
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#getNameParser(java.lang.String)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public NameParser getNameParser(final String name) throws NamingException {
         return null;
     }
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#composeName(javax.naming.Name, javax.naming.Name)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public Name composeName(final Name name, final Name prefix) throws NamingException {
         return null;
     }
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#composeName(java.lang.String, java.lang.String)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public String composeName(final String name, final String prefix) throws NamingException {
         return null;
     }
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#addToEnvironment(java.lang.String, java.lang.Object)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public Object addToEnvironment(final String propName, final Object propVal) throws NamingException {
         return null;
     }
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#removeFromEnvironment(java.lang.String)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public Object removeFromEnvironment(final String propName) throws NamingException {
         return null;
     }
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#getEnvironment()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public Hashtable<?, ?> getEnvironment() throws NamingException {
         return null;
     }
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#close()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void close() throws NamingException {}
 
-    /* (non-Javadoc)
-     * @see javax.naming.Context#getNameInNamespace()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public String getNameInNamespace() throws NamingException {
diff --git a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/jms/TestInitialContextFactory.java b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/jms/TestInitialContextFactory.java
index d04cd5791..ddd70a3b9 100644
--- a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/jms/TestInitialContextFactory.java
+++ b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/jms/TestInitialContextFactory.java
@@ -42,10 +42,8 @@ public class TestInitialContextFactory implements InitialContextFactory {
      */
     public TestInitialContextFactory() throws NamingException {}
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see javax.naming.spi.InitialContextFactory#getInitialContext(java.util.Hashtable)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public Context getInitialContext(final Hashtable<?, ?> environment) throws NamingException {
diff --git a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/kafka/KafkaEventProducer.java b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/kafka/KafkaEventProducer.java
index 63da4e696..bafce8d06 100644
--- a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/kafka/KafkaEventProducer.java
+++ b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/kafka/KafkaEventProducer.java
@@ -68,10 +68,8 @@ public class KafkaEventProducer implements Runnable {
         producerThread.start();
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see java.lang.Runnable#run()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void run() {
diff --git a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/kafka/KafkaEventSubscriber.java b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/kafka/KafkaEventSubscriber.java
index 54ee9ba92..8db6919f0 100644
--- a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/kafka/KafkaEventSubscriber.java
+++ b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/kafka/KafkaEventSubscriber.java
@@ -72,10 +72,8 @@ public class KafkaEventSubscriber implements Runnable {
         subscriberThread.start();
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see java.lang.Runnable#run()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void run() {
diff --git a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/websocket/WebSocketEventProducerClient.java b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/websocket/WebSocketEventProducerClient.java
index 84a337362..46973290a 100644
--- a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/websocket/WebSocketEventProducerClient.java
+++ b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/websocket/WebSocketEventProducerClient.java
@@ -107,12 +107,8 @@ public class WebSocketEventProducerClient implements WsStringMessageListener {
         System.out.println(WebSocketEventProducerClient.class.getCanonicalName() + ": stopped");
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see
-     * org.onap.policy.apex.core.infrastructure.messaging.stringmessaging.WSStringMessageListener#
-     * receiveString(java.lang.String)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void receiveString(final String eventString) {
diff --git a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/websocket/WebSocketEventProducerServer.java b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/websocket/WebSocketEventProducerServer.java
index 3e5ff714e..b75d99ff0 100644
--- a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/websocket/WebSocketEventProducerServer.java
+++ b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/websocket/WebSocketEventProducerServer.java
@@ -105,12 +105,8 @@ public class WebSocketEventProducerServer implements WsStringMessageListener {
         System.out.println(WebSocketEventProducerServer.class.getCanonicalName() + ": stopped");
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see
-     * org.onap.policy.apex.core.infrastructure.messaging.stringmessaging.WSStringMessageListener#
-     * receiveString(java.lang.String)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void receiveString(final String eventString) {
diff --git a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/websocket/WebSocketEventSubscriberClient.java b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/websocket/WebSocketEventSubscriberClient.java
index 6477a0dc9..fab51529a 100644
--- a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/websocket/WebSocketEventSubscriberClient.java
+++ b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/websocket/WebSocketEventSubscriberClient.java
@@ -47,12 +47,8 @@ public class WebSocketEventSubscriberClient implements WsStringMessageListener {
         client.start(this);
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see
-     * org.onap.policy.apex.core.infrastructure.messaging.stringmessaging.WSStringMessageListener#
-     * receiveString(java.lang.String)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void receiveString(final String eventString) {
diff --git a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/websocket/WebSocketEventSubscriberServer.java b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/websocket/WebSocketEventSubscriberServer.java
index 92329236f..edd6d7961 100644
--- a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/websocket/WebSocketEventSubscriberServer.java
+++ b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/adapt/websocket/WebSocketEventSubscriberServer.java
@@ -49,12 +49,8 @@ public class WebSocketEventSubscriberServer implements WsStringMessageListener {
                 WebSocketEventSubscriberServer.class.getCanonicalName() + ": port " + port + ", waiting for events");
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see
-     * org.onap.policy.apex.core.infrastructure.messaging.stringmessaging.WSStringMessageListener#
-     * receiveString(java.lang.String)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void receiveString(final String eventString) {
diff --git a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/engdep/EngineTestServer.java b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/engdep/EngineTestServer.java
index 9e6ff67ca..585787c28 100644
--- a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/engdep/EngineTestServer.java
+++ b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/engdep/EngineTestServer.java
@@ -75,10 +75,8 @@ public class EngineTestServer implements Runnable, EngineServiceEventInterface {
         this.parameters = parameters;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.lang.Runnable#run()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void run() {
@@ -192,12 +190,8 @@ public class EngineTestServer implements Runnable, EngineServiceEventInterface {
         return starting;
     }
 
-    /*
-     * (non-Javadoc)
-     * 
-     * @see
-     * org.onap.policy.apex.service.engine.runtime.EngineServiceEventInterface#sendEvent(org.onap.
-     * policy.apex.service.engine.event.ApexEvent)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void sendEvent(final ApexEvent event) {
@@ -217,12 +211,8 @@ public class EngineTestServer implements Runnable, EngineServiceEventInterface {
      */
     private final class TestApexListener implements ApexEventListener {
 
-        /*
-         * (non-Javadoc)
-         *
-         * @see
-         * org.onap.policy.apex.service.engine.runtime.ApexEventListener#onApexEvent(org.onap.policy
-         * .apex.service.engine.event.ApexEvent)
+        /**
+         * {@inheritDoc}.
          */
         @Override
         public synchronized void onApexEvent(final ApexEvent apexEvent) {
diff --git a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/engine/ApexServiceModelUpdateTest.java b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/engine/ApexServiceModelUpdateTest.java
index ff6a3a279..3ea4bde84 100644
--- a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/engine/ApexServiceModelUpdateTest.java
+++ b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/engine/ApexServiceModelUpdateTest.java
@@ -364,11 +364,8 @@ public class ApexServiceModelUpdateTest {
      */
     private final class TestListener implements ApexEventListener {
 
-        /*
-         * (non-Javadoc)
-         *
-         * @see org.onap.policy.apex.service.engine.runtime.ApexEventListener#onApexEvent(org.onap.policy
-         * .apex.service.engine.event.ApexEvent)
+        /**
+         * {@inheritDoc}.
          */
         @Override
         public synchronized void onApexEvent(final ApexEvent event) {
diff --git a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/engine/ApexServiceTest.java b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/engine/ApexServiceTest.java
index f8e9f2c37..34893ca5c 100644
--- a/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/engine/ApexServiceTest.java
+++ b/testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/engine/ApexServiceTest.java
@@ -477,12 +477,8 @@ public class ApexServiceTest {
      */
     private static final class TestListener implements ApexEventListener {
 
-        /*
-         * (non-Javadoc)
-         *
-         * @see
-         * org.onap.policy.apex.service.engine.runtime.ApexEventListener#onApexEvent(org.onap.policy
-         * .apex.service.engine.event.ApexEvent)
+        /**
+         * {@inheritDoc}.
          */
         @Override
         public synchronized void onApexEvent(final ApexEvent event) {