Fix javadoc tags to fix the jdk 1.8 javadoc lint checker

- Move maven-javadoc-plugins <tags> to odlparent-lite
- Resolves missing javadoc strings

Change-Id: I5883003366b4d17b5b3547d2a3c0652db7bc0cb0
Also-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Signed-off-by: Pradeeban Kathiravelu <kk.pradeeban@gmail.com>
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

diff --git a/features-test/src/main/java/org/opendaylight/odlparent/featuretest/PerFeatureRunNotifier.java b/features-test/src/main/java/org/opendaylight/odlparent/featuretest/PerFeatureRunNotifier.java
index e64146b5ee965215b9fa5ee296ddef7bf0ed842b..cfb0bc85823dfbbdf0dfe0aee312dd12d8ea9880 100644 (file)
--- a/features-test/src/main/java/org/opendaylight/odlparent/featuretest/PerFeatureRunNotifier.java
+++ b/features-test/src/main/java/org/opendaylight/odlparent/featuretest/PerFeatureRunNotifier.java
@@ -34,7 +34,7 @@ public class PerFeatureRunNotifier extends RunNotifier {
     }
 
     /**
-     * @param listener
+     * @param listener RunListener instance
      * @see org.junit.runner.notification.RunNotifier#addListener(org.junit.runner.notification.RunListener)
      */
     @Override
@@ -43,7 +43,7 @@ public class PerFeatureRunNotifier extends RunNotifier {
     }
 
     /**
-     * @param listener
+     * @param listener RunListener instance
      * @see org.junit.runner.notification.RunNotifier#removeListener(org.junit.runner.notification.RunListener)
      */
     @Override
@@ -52,7 +52,7 @@ public class PerFeatureRunNotifier extends RunNotifier {
     }
 
     /**
-     * @return
+     * @return the hashCode of the delegate
      * @see java.lang.Object#hashCode()
      */
     @Override
@@ -61,7 +61,7 @@ public class PerFeatureRunNotifier extends RunNotifier {
     }
 
     /**
-     * @param description
+     * @param description Description instance
      * @see org.junit.runner.notification.RunNotifier#fireTestRunStarted(org.junit.runner.Description)
      */
     @Override
@@ -70,7 +70,7 @@ public class PerFeatureRunNotifier extends RunNotifier {
     }
 
     /**
-     * @param result
+     * @param result Result instance
      * @see org.junit.runner.notification.RunNotifier#fireTestRunFinished(org.junit.runner.Result)
      */
     @Override
@@ -79,8 +79,8 @@ public class PerFeatureRunNotifier extends RunNotifier {
     }
 
     /**
-     * @param description
-     * @throws StoppedByUserException
+     * @param description Description instance
+     * @throws StoppedByUserException throws this exception, if the fireTest is stopped by user.
      * @see org.junit.runner.notification.RunNotifier#fireTestStarted(org.junit.runner.Description)
      */
     @Override
@@ -90,8 +90,8 @@ public class PerFeatureRunNotifier extends RunNotifier {
     }
 
     /**
-     * @param obj
-     * @return
+     * @param obj a generic Object instance
+     * @return true, if equals
      * @see java.lang.Object#equals(java.lang.Object)
      */
     @Override
@@ -100,7 +100,7 @@ public class PerFeatureRunNotifier extends RunNotifier {
     }
 
     /**
-     * @param failure
+     * @param failure Failure instance
      * @see org.junit.runner.notification.RunNotifier#fireTestFailure(org.junit.runner.notification.Failure)
      */
     @Override
@@ -109,7 +109,7 @@ public class PerFeatureRunNotifier extends RunNotifier {
     }
 
     /**
-     * @param failure
+     * @param failure Failure instance
      * @see org.junit.runner.notification.RunNotifier#fireTestAssumptionFailed(org.junit.runner.notification.Failure)
      */
     @Override
@@ -118,7 +118,7 @@ public class PerFeatureRunNotifier extends RunNotifier {
     }
 
     /**
-     * @param description
+     * @param description Description instance
      * @see org.junit.runner.notification.RunNotifier#fireTestIgnored(org.junit.runner.Description)
      */
     @Override
@@ -127,7 +127,7 @@ public class PerFeatureRunNotifier extends RunNotifier {
     }
 
     /**
-     * @param description
+     * @param description Description instance
      * @see org.junit.runner.notification.RunNotifier#fireTestFinished(org.junit.runner.Description)
      */
     @Override
@@ -145,7 +145,7 @@ public class PerFeatureRunNotifier extends RunNotifier {
     }
 
     /**
-     * @param listener
+     * @param listener RunListener instance
      * @see org.junit.runner.notification.RunNotifier#addFirstListener(org.junit.runner.notification.RunListener)
      */
     @Override
@@ -154,7 +154,7 @@ public class PerFeatureRunNotifier extends RunNotifier {
     }
 
     /**
-     * @return
+     * @return value of the delegate as a String.
      * @see java.lang.Object#toString()
      */
     @Override

diff --git a/features-test/src/main/java/org/opendaylight/odlparent/featuretest/PerFeatureRunner.java b/features-test/src/main/java/org/opendaylight/odlparent/featuretest/PerFeatureRunner.java
index 6ebb453aa2abd9f79a8bc0f5c0b6f8d6b4c0add9..1d46ca0819a2d8779b43ae95f551a9ff353e4368 100644 (file)
--- a/features-test/src/main/java/org/opendaylight/odlparent/featuretest/PerFeatureRunner.java
+++ b/features-test/src/main/java/org/opendaylight/odlparent/featuretest/PerFeatureRunner.java
@@ -56,7 +56,7 @@ public class PerFeatureRunner extends Runner {
     }
 
     /**
-     * @return
+     * @return test count, int value
      * @see org.junit.runner.Runner#testCount()
      */
     @Override
@@ -65,8 +65,8 @@ public class PerFeatureRunner extends Runner {
     }
 
     /**
-     * @param filter
-     * @throws NoTestsRemainException
+     * @param filter, Filter instance
+     * @throws NoTestsRemainException if filtering fails.
      * @see org.ops4j.pax.exam.junit.PaxExam#filter(org.junit.runner.manipulation.Filter)
      */
     public void filter(final Filter filter) throws NoTestsRemainException {
@@ -74,7 +74,7 @@ public class PerFeatureRunner extends Runner {
     }
 
     /**
-     * @param sorter
+     * @param sorter, Sorter instance
      * @see org.ops4j.pax.exam.junit.PaxExam#sort(org.junit.runner.manipulation.Sorter)
      */
     public void sort(final Sorter sorter) {
@@ -82,7 +82,7 @@ public class PerFeatureRunner extends Runner {
     }
 
     /**
-     * @return
+     * @return string value of the delegate.
      * @see java.lang.Object#toString()
      */
     @Override

diff --git a/features-test/src/main/java/org/opendaylight/odlparent/featuretest/PerRepoTestRunner.java b/features-test/src/main/java/org/opendaylight/odlparent/featuretest/PerRepoTestRunner.java
index 844add13c1c9a1c3b20c9a9121dd9811194f2970..58ce8c8dd955a505848374d755ccefe08a3a55cb 100644 (file)
--- a/features-test/src/main/java/org/opendaylight/odlparent/featuretest/PerRepoTestRunner.java
+++ b/features-test/src/main/java/org/opendaylight/odlparent/featuretest/PerRepoTestRunner.java
@@ -82,10 +82,10 @@ public class PerRepoTestRunner extends ParentRunner<PerFeatureRunner> {
     }
 
     /**
-     * @param repoURL
-     * @return
-     * @throws JAXBException
-     * @throws IOException
+     * @param repoURL url of the repo
+     * @return features
+     * @throws JAXBException exception during unmarshalling.
+     * @throws IOException IOException in getting the features.
      */
     protected Features getFeatures(final URL repoURL) throws JAXBException,
             IOException {

diff --git a/features-test/src/main/java/org/opendaylight/odlparent/featuretest/Util.java b/features-test/src/main/java/org/opendaylight/odlparent/featuretest/Util.java
index 6f3dba1ff0806e3230486bbd47f9f2794b58bd6c..fddd5ca4c9031c5e24b4328c84d3181cc987424f 100644 (file)
--- a/features-test/src/main/java/org/opendaylight/odlparent/featuretest/Util.java
+++ b/features-test/src/main/java/org/opendaylight/odlparent/featuretest/Util.java
@@ -23,6 +23,12 @@ public final class Util {
      *
      * This is done so that when a test fails, we can get information about which repoURL, featureName, and featureVersion
      * can come back with the Failure.
+     *
+     * @param repoURL, URL of the repository.
+     * @param featureName the name of the feature.
+     * @param featureVersion the version of the feature.
+     * @param description original description of the feature.
+     * @return the final description of the feature with the information of repoUrl, featureName, and featureVersion included.
      */
     public static final Description convertDescription(final URL repoURL, final String featureName,
             final String featureVersion, final Description description) {

diff --git a/odlparent-lite/pom.xml b/odlparent-lite/pom.xml
index 41d02eb52716733169400f9bdc6e9ae107e3444d..c34ab5c9e90ff52b9c49d77214ca8c3d9aa9a29a 100644 (file)
--- a/odlparent-lite/pom.xml
+++ b/odlparent-lite/pom.xml
@@ -71,6 +71,32 @@
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-javadoc-plugin</artifactId>
           <version>2.10.3</version>
+          <configuration>
+            <tags>
+              <!-- support for HelpMojo generated by the maven-plugin-plugin -->
+              <tag>
+                <name>goal</name>
+                <placement>t</placement>
+                <head>Goal:</head>
+              </tag>
+              <tag>
+                <name>requiresProject</name>
+                <placement>t</placement>
+                <head>Requires project:</head>
+              </tag>
+              <tag>
+                <name>threadSafe</name>
+                <placement>t</placement>
+                <head>Threadsafe</head>
+              </tag>
+              <tag>
+                <name>phase</name>
+                <placement>t</placement>
+                <head>Phase:</head>
+              </tag>
+              <!-- end HelpMojo support -->
+            </tags>
+          </configuration>
         </plugin>
       </plugins>
     </pluginManagement>

diff --git a/odlparent/pom.xml b/odlparent/pom.xml
index 2aab736fbf688fb42b6da739a2ffdc4ec6ba1faf..9dd50699009f2aa5b4876b8356ca6ff222c61a64 100644 (file)
--- a/odlparent/pom.xml
+++ b/odlparent/pom.xml
@@ -985,30 +985,6 @@
           <configuration>
             <!-- Keep things quiet except for warnings/errors -->
             <quiet>true</quiet>
-            <tags>
-              <!-- support for HelpMojo generated by the maven-plugin-plugin -->
-              <tag>
-                <name>goal</name>
-                <placement>t</placement>
-                <head>Goal:</head>
-              </tag>
-              <tag>
-                <name>requiresProject</name>
-                <placement>t</placement>
-                <head>Requires project:</head>
-              </tag>
-              <tag>
-                <name>threadSafe</name>
-                <placement>t</placement>
-                <head>Threadsafe</head>
-              </tag>
-              <tag>
-                <name>phase</name>
-                <placement>t</placement>
-                <head>Phase:</head>
-              </tag>
-              <!-- end HelpMojo support -->
-            </tags>
           </configuration>
           <executions>
             <execution>