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>

8 files changed, 36 insertions, 76 deletions

diff --git a/examples/examples-aadm/src/test/java/org/onap/policy/apex/examples/aadm/TestApexActionListener.java b/examples/examples-aadm/src/test/java/org/onap/policy/apex/examples/aadm/TestApexActionListener.java
index 60fa169dd..03372d745 100644
--- a/examples/examples-aadm/src/test/java/org/onap/policy/apex/examples/aadm/TestApexActionListener.java
+++ b/examples/examples-aadm/src/test/java/org/onap/policy/apex/examples/aadm/TestApexActionListener.java
@@ -61,11 +61,8 @@ public class TestApexActionListener implements EnEventListener {
         return resultEvents.remove(0);
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see
-     * org.onap.policy.apex.core.engine.engine.EnEventListener#onEnEvent(org.onap.policy.apex.core.engine.event.EnEvent)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void onEnEvent(final EnEvent actionEvent) {
diff --git a/examples/examples-adaptive/src/main/java/org/onap/policy/apex/examples/adaptive/concepts/AnomalyDetection.java b/examples/examples-adaptive/src/main/java/org/onap/policy/apex/examples/adaptive/concepts/AnomalyDetection.java
index 9dbfe266f..6ff5ebccc 100644
--- a/examples/examples-adaptive/src/main/java/org/onap/policy/apex/examples/adaptive/concepts/AnomalyDetection.java
+++ b/examples/examples-adaptive/src/main/java/org/onap/policy/apex/examples/adaptive/concepts/AnomalyDetection.java
@@ -174,10 +174,8 @@ public class AnomalyDetection implements Serializable {
         frequencyForecasted = null;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.lang.Object#toString()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public String toString() {
@@ -185,10 +183,8 @@ public class AnomalyDetection implements Serializable {
                 + anomalyScores + ", frequencyForecasted=" + frequencyForecasted + "]";
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.lang.Object#hashCode()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public int hashCode() {
@@ -201,10 +197,8 @@ public class AnomalyDetection implements Serializable {
         return result;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.lang.Object#equals(java.lang.Object)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public boolean equals(final Object obj) {
diff --git a/examples/examples-adaptive/src/main/java/org/onap/policy/apex/examples/adaptive/concepts/AutoLearn.java b/examples/examples-adaptive/src/main/java/org/onap/policy/apex/examples/adaptive/concepts/AutoLearn.java
index 968b20499..dd5bf0c45 100644
--- a/examples/examples-adaptive/src/main/java/org/onap/policy/apex/examples/adaptive/concepts/AutoLearn.java
+++ b/examples/examples-adaptive/src/main/java/org/onap/policy/apex/examples/adaptive/concepts/AutoLearn.java
@@ -133,20 +133,16 @@ public class AutoLearn implements Serializable {
         counts = null;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.lang.Object#toString()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public String toString() {
         return "AutoLearn [avDiffs=" + avDiffs + ", counts=" + counts + "]";
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.lang.Object#hashCode()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public int hashCode() {
@@ -157,10 +153,8 @@ public class AutoLearn implements Serializable {
         return result;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.lang.Object#equals(java.lang.Object)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public boolean equals(final Object obj) {
diff --git a/examples/examples-adaptive/src/test/java/org/onap/policy/apex/examples/adaptive/TestApexActionListener.java b/examples/examples-adaptive/src/test/java/org/onap/policy/apex/examples/adaptive/TestApexActionListener.java
index 006d3de6f..cd1327123 100644
--- a/examples/examples-adaptive/src/test/java/org/onap/policy/apex/examples/adaptive/TestApexActionListener.java
+++ b/examples/examples-adaptive/src/test/java/org/onap/policy/apex/examples/adaptive/TestApexActionListener.java
@@ -61,11 +61,8 @@ public class TestApexActionListener implements EnEventListener {
         return resultEvents.remove(0);
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see
-     * org.onap.policy.apex.core.engine.engine.EnEventListener#onEnEvent(org.onap.policy.apex.core.engine.event.EnEvent)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void onEnEvent(final EnEvent actionEvent) {
diff --git a/examples/examples-myfirstpolicy/src/test/java/org/onap/policy/apex/examples/myfirstpolicy/TestMfpModelCreator.java b/examples/examples-myfirstpolicy/src/test/java/org/onap/policy/apex/examples/myfirstpolicy/TestMfpModelCreator.java
index d77405d9e..540d1e341 100644
--- a/examples/examples-myfirstpolicy/src/test/java/org/onap/policy/apex/examples/myfirstpolicy/TestMfpModelCreator.java
+++ b/examples/examples-myfirstpolicy/src/test/java/org/onap/policy/apex/examples/myfirstpolicy/TestMfpModelCreator.java
@@ -31,40 +31,32 @@ import org.onap.policy.apex.model.policymodel.concepts.AxPolicyModel;
  */
 public abstract class TestMfpModelCreator implements TestApexModelCreator<AxPolicyModel> {
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.model.basicmodel.test.TestApexModelCreator#getMalstructuredModel()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public AxPolicyModel getMalstructuredModel() {
         return null;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.model.basicmodel.test.TestApexModelCreator#getObservationModel()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public AxPolicyModel getObservationModel() {
         return null;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.model.basicmodel.test.TestApexModelCreator#getWarningModel()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public AxPolicyModel getWarningModel() {
         return getModel();
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.onap.policy.apex.model.basicmodel.test.TestApexModelCreator#getInvalidModel()
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public AxPolicyModel getInvalidModel() {
@@ -76,10 +68,8 @@ public abstract class TestMfpModelCreator implements TestApexModelCreator<AxPoli
      */
     public static class TestMfp1ModelCreator extends TestMfpModelCreator {
 
-        /*
-         * (non-Javadoc)
-         *
-         * @see org.onap.policy.apex.model.basicmodel.handling.ApexModelCreator#getModel()
+        /**
+         * {@inheritDoc}.
          */
         @Override
         public AxPolicyModel getModel() {
@@ -92,15 +82,12 @@ public abstract class TestMfpModelCreator implements TestApexModelCreator<AxPoli
      */
     public static class TestMfp2ModelCreator extends TestMfpModelCreator {
 
-        /*
-         * (non-Javadoc)
-         *
-         * @see org.onap.policy.apex.model.basicmodel.handling.ApexModelCreator#getModel()
+        /**
+         * {@inheritDoc}.
          */
         @Override
         public AxPolicyModel getModel() {
             return new MfpDomainModelFactory().getMfp2PolicyModel();
         }
     }
-
 }
diff --git a/examples/examples-myfirstpolicy/src/test/java/org/onap/policy/apex/examples/myfirstpolicy/TestSaleAuthListener.java b/examples/examples-myfirstpolicy/src/test/java/org/onap/policy/apex/examples/myfirstpolicy/TestSaleAuthListener.java
index b2722fd78..3fce59c93 100644
--- a/examples/examples-myfirstpolicy/src/test/java/org/onap/policy/apex/examples/myfirstpolicy/TestSaleAuthListener.java
+++ b/examples/examples-myfirstpolicy/src/test/java/org/onap/policy/apex/examples/myfirstpolicy/TestSaleAuthListener.java
@@ -63,11 +63,8 @@ public class TestSaleAuthListener implements EnEventListener {
         return resultEvents.remove(0);
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see
-     * org.onap.policy.apex.core.engine.engine.EnEventListener#onEnEvent(org.onap.policy.apex.core.engine.event.EnEvent)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void onEnEvent(final EnEvent saleauthEvent) {
diff --git a/examples/examples-onap-vcpe/src/test/java/org/onap/policy/apex/domains/onap/vcpe/AppcResponseCreator.java b/examples/examples-onap-vcpe/src/test/java/org/onap/policy/apex/domains/onap/vcpe/AppcResponseCreator.java
index f5f2b2792..4a12b3baa 100644
--- a/examples/examples-onap-vcpe/src/test/java/org/onap/policy/apex/domains/onap/vcpe/AppcResponseCreator.java
+++ b/examples/examples-onap-vcpe/src/test/java/org/onap/policy/apex/domains/onap/vcpe/AppcResponseCreator.java
@@ -63,10 +63,8 @@ public class AppcResponseCreator {
     }
 
     private class AppcTimerTask extends TimerTask {
-        /*
-         * (non-Javadoc)
-         * 
-         * @see java.util.TimerTask#run()
+        /**
+         * {@inheritDoc}.
          */
         @Override
         public void run() {
diff --git a/examples/examples-servlet/src/main/java/org/onap/policy/apex/examples/servlet/ApexServletListener.java b/examples/examples-servlet/src/main/java/org/onap/policy/apex/examples/servlet/ApexServletListener.java
index 78871c385..859d1b00f 100644
--- a/examples/examples-servlet/src/main/java/org/onap/policy/apex/examples/servlet/ApexServletListener.java
+++ b/examples/examples-servlet/src/main/java/org/onap/policy/apex/examples/servlet/ApexServletListener.java
@@ -46,10 +46,8 @@ public class ApexServletListener implements ServletContextListener {
     // The Apex engine reference
     private ApexMain apexMain;
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see javax.servlet.ServletContextListener#contextInitialized(javax.servlet.ServletContextEvent)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void contextInitialized(final ServletContextEvent servletContextEvent) {
@@ -83,10 +81,8 @@ public class ApexServletListener implements ServletContextListener {
     }
 
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see javax.servlet.ServletContextListener#contextDestroyed(javax.servlet.ServletContextEvent)
+    /**
+     * {@inheritDoc}.
      */
     @Override
     public void contextDestroyed(final ServletContextEvent servletContextEvent) {