Fix mvn javadoc:javadoc failure, update javadoc plugin to 3.4.1

Issue-ID: AAI-3527

Signed-off-by: Fiete Ostkamp <Fiete.Ostkamp@telekom.de>
Change-Id: Ie69792925722607ea33e376f01a3d682bc0bd43b

diff --git a/aai-queries/src/main/java/org/onap/aai/queries/GremlinServerSingleton.java b/aai-queries/src/main/java/org/onap/aai/queries/GremlinServerSingleton.java
index dd0db86..2387f04 100644 (file)
--- a/aai-queries/src/main/java/org/onap/aai/queries/GremlinServerSingleton.java
+++ b/aai-queries/src/main/java/org/onap/aai/queries/GremlinServerSingleton.java
@@ -99,9 +99,9 @@ public class GremlinServerSingleton {
 
     /**
      * Gets the query using CustomQueryConfig
-     * 
-     * @param key
-     * @return
+     *
+     * @param key the config key
+     * @return the stored query
      */
     public String getStoredQueryFromConfig(String key) {
         CustomQueryConfig customQueryConfig = queryConfig.getStoredQuery(key);

diff --git a/aai-schema-service/src/main/java/org/onap/aai/schemaservice/healthcheck/EchoResource.java b/aai-schema-service/src/main/java/org/onap/aai/schemaservice/healthcheck/EchoResource.java
index 47552b1..b0c8007 100644 (file)
--- a/aai-schema-service/src/main/java/org/onap/aai/schemaservice/healthcheck/EchoResource.java
+++ b/aai-schema-service/src/main/java/org/onap/aai/schemaservice/healthcheck/EchoResource.java
@@ -48,6 +48,7 @@ public class EchoResource extends RESTAPI {
      *
      * @param headers the headers
      * @param req the req
+     * @param uriInfo uri information
      * @return the response
      */
     @GET

diff --git a/aai-schema-service/src/main/java/org/onap/aai/schemaservice/nodeschema/NodeIngestor.java b/aai-schema-service/src/main/java/org/onap/aai/schemaservice/nodeschema/NodeIngestor.java
index 713b078..e7b9167 100644 (file)
--- a/aai-schema-service/src/main/java/org/onap/aai/schemaservice/nodeschema/NodeIngestor.java
+++ b/aai-schema-service/src/main/java/org/onap/aai/schemaservice/nodeschema/NodeIngestor.java
@@ -20,12 +20,6 @@
 
 package org.onap.aai.schemaservice.nodeschema;
 
-import com.google.common.base.CaseFormat;
-import com.google.common.collect.ArrayListMultimap;
-import com.google.common.collect.Multimap;
-
-import jakarta.xml.bind.JAXBException;
-
 import java.io.ByteArrayInputStream;
 import java.io.File;
 import java.io.FileInputStream;
@@ -64,8 +58,14 @@ import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
 import org.xml.sax.SAXException;
 
+import com.google.common.base.CaseFormat;
+import com.google.common.collect.ArrayListMultimap;
+import com.google.common.collect.Multimap;
+
+import jakarta.xml.bind.JAXBException;
+
 /**
- * NodeIngestor - ingests A&AI OXM files per given config, serves DynamicJAXBContext per version
+ * NodeIngestor - ingests A&AI OXM files per given config, serves DynamicJAXBContext per version
  */
 @Component
 public class NodeIngestor {
@@ -254,7 +254,7 @@ public class NodeIngestor {
     /**
      * Gets the DynamicJAXBContext for the given version
      *
-     * @param v
+     * @param v the schema version
      * @return DynamicJAXBContext
      */
     public DynamicJAXBContext getContextForVersion(SchemaVersion v) {
@@ -266,7 +266,7 @@ public class NodeIngestor {
      *
      * @param nodeType - node type to check, must be in lower hyphen form (ie "type-name")
      * @param v - schema version to check against
-     * @return
+     * @return true if node type is contained in the given version
      */
     public boolean hasNodeType(String nodeType, SchemaVersion v) {
         return typesPerVersion.get(v).contains(nodeType);

diff --git a/aai-schema-service/src/main/java/org/onap/aai/schemaservice/nodeschema/validation/AAISchemaValidationException.java b/aai-schema-service/src/main/java/org/onap/aai/schemaservice/nodeschema/validation/AAISchemaValidationException.java
index 4d35e83..efdc48d 100644 (file)
--- a/aai-schema-service/src/main/java/org/onap/aai/schemaservice/nodeschema/validation/AAISchemaValidationException.java
+++ b/aai-schema-service/src/main/java/org/onap/aai/schemaservice/nodeschema/validation/AAISchemaValidationException.java
@@ -21,7 +21,7 @@
 package org.onap.aai.schemaservice.nodeschema.validation;
 
 /**
- * Indicates that a fatal error in the A&AI schema has been found.
+ * Indicates that a fatal error in the A&AI schema has been found.
  */
 public class AAISchemaValidationException extends IllegalStateException {
     public AAISchemaValidationException(String msg) {

diff --git a/aai-schema-service/src/main/java/org/onap/aai/schemaservice/nodeschema/validation/DefaultDuplicateNodeDefinitionValidationModule.java b/aai-schema-service/src/main/java/org/onap/aai/schemaservice/nodeschema/validation/DefaultDuplicateNodeDefinitionValidationModule.java
index b33fd8d..b6f142f 100644 (file)
--- a/aai-schema-service/src/main/java/org/onap/aai/schemaservice/nodeschema/validation/DefaultDuplicateNodeDefinitionValidationModule.java
+++ b/aai-schema-service/src/main/java/org/onap/aai/schemaservice/nodeschema/validation/DefaultDuplicateNodeDefinitionValidationModule.java
@@ -40,7 +40,7 @@ import org.w3c.dom.NodeList;
 import org.xml.sax.SAXException;
 
 /**
- * Default duplicate rules for A&AI -
+ * Default duplicate rules for A&AI -
  * node types may never have a duplicate definition
  * within the same Version's file set.
  *

diff --git a/aai-schema-service/src/main/java/org/onap/aai/schemaservice/nodeschema/validation/DefaultVersionValidationModule.java b/aai-schema-service/src/main/java/org/onap/aai/schemaservice/nodeschema/validation/DefaultVersionValidationModule.java
index ea7cdd7..aacd66f 100644 (file)
--- a/aai-schema-service/src/main/java/org/onap/aai/schemaservice/nodeschema/validation/DefaultVersionValidationModule.java
+++ b/aai-schema-service/src/main/java/org/onap/aai/schemaservice/nodeschema/validation/DefaultVersionValidationModule.java
@@ -29,7 +29,7 @@ import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
 
 /**
- * By default, A&AI must have schema files for all current
+ * By default, A&AI must have schema files for all current
  * supported Versions in the Version enum
  *
  */

diff --git a/aai-schema-service/src/main/java/org/onap/aai/schemaservice/nodeschema/validation/DuplicateNodeDefinitionValidationModule.java b/aai-schema-service/src/main/java/org/onap/aai/schemaservice/nodeschema/validation/DuplicateNodeDefinitionValidationModule.java
index 7b07ce8..e9d1dfa 100644 (file)
--- a/aai-schema-service/src/main/java/org/onap/aai/schemaservice/nodeschema/validation/DuplicateNodeDefinitionValidationModule.java
+++ b/aai-schema-service/src/main/java/org/onap/aai/schemaservice/nodeschema/validation/DuplicateNodeDefinitionValidationModule.java
@@ -39,6 +39,7 @@ public interface DuplicateNodeDefinitionValidationModule {
      * Finds any duplicates according to the defined rules
      *
      * @param files - the OXM files to use with full directory
+     * @param v - the schema version
      * @return empty String if none found, else a String
      *         with appropriate information about what node types
      *         were found

diff --git a/aai-schema-service/src/main/java/org/onap/aai/schemaservice/nodeschema/validation/SchemaErrorStrategy.java b/aai-schema-service/src/main/java/org/onap/aai/schemaservice/nodeschema/validation/SchemaErrorStrategy.java
index 7d76533..af07361 100644 (file)
--- a/aai-schema-service/src/main/java/org/onap/aai/schemaservice/nodeschema/validation/SchemaErrorStrategy.java
+++ b/aai-schema-service/src/main/java/org/onap/aai/schemaservice/nodeschema/validation/SchemaErrorStrategy.java
@@ -27,7 +27,7 @@ public interface SchemaErrorStrategy {
     /**
      * Gives if it is OK to proceed with whatever process
      * invoked the validation (probably the installation of
-     * the A&AI instance).
+     * the A&AI instance).
      *
      * @return boolean
      */

diff --git a/pom.xml b/pom.xml
index 8f2ef42..21d3990 100644 (file)
--- a/pom.xml
+++ b/pom.xml
@@ -172,7 +172,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
-                <version>2.10.4</version>
+                <version>3.4.1</version>
                 <configuration>
                     <failOnError>false</failOnError>
                     <doclet>org.umlgraph.doclet.UmlGraphDoc</doclet>