fixes #1073 Resolve javadoc warning messages

networknt · Jun 21, 2024 · b97ab80 · b97ab80
1 parent 622475b
commit b97ab80
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 10 deletions.
diff --git a/src/main/java/com/networknt/schema/SchemaValidatorsConfig.java b/src/main/java/com/networknt/schema/SchemaValidatorsConfig.java
@@ -190,11 +190,11 @@ public class SchemaValidatorsConfig {
      *     .nullableKeywordEnabled(true)
      *     .build();
      * </pre>
-     * <p><ul>
+     * <ul>
      * <li> customMessageSupported (errorMessageKeyword): change from message to null
      * <li> pathType: changed from PathType.LEGACY to PathType.JSON_POINTER.
      * <li> handleNullableField (nullableKeywordEnabled): changed from true to false
-     * </ul><p>
+     * </ul>
      */
     @Deprecated
     public SchemaValidatorsConfig() {
@@ -948,6 +948,7 @@ public Builder keywordWalkListeners(Map<String, List<JsonSchemaWalkListener>> ke
          * Defaults to use {@link Locale#getDefault()}.
          *
          * @param locale The locale.
+         * @return the builder
          */
         public Builder locale(Locale locale) {
             this.locale = locale;

diff --git a/src/main/java/com/networknt/schema/ValidationMessageHandler.java b/src/main/java/com/networknt/schema/ValidationMessageHandler.java
@@ -100,7 +100,7 @@ protected ErrorMessageType getErrorMessageType() {
 
     /**
      * Gets the custom error message to use.
-     * 
+     * @param errorMessageKeyword the error message keyword
      * @param schemaNode the schema node
      * @param keyword    the keyword
      * @return the custom error message

diff --git a/src/main/java/com/networknt/schema/serialization/JsonNodeReader.java b/src/main/java/com/networknt/schema/serialization/JsonNodeReader.java
@@ -32,17 +32,17 @@ public interface JsonNodeReader {
      * @param content     the content
      * @param inputFormat the input format
      * @return the node
-     * @throws IOException
+     * @throws IOException IOException
      */
     JsonNode readTree(String content, InputFormat inputFormat) throws IOException;
 
     /**
      * Deserialize content as a tree.
      * 
-     * @param content
-     * @param inputFormat
+     * @param content input stream
+     * @param inputFormat input format
      * @return the node
-     * @throws IOException
+     * @throws IOException IOException
      */
     JsonNode readTree(InputStream content, InputFormat inputFormat) throws IOException;
 

diff --git a/src/main/java/com/networknt/schema/utils/JsonNodes.java b/src/main/java/com/networknt/schema/utils/JsonNodes.java
@@ -35,7 +35,8 @@
 public class JsonNodes {
     /**
      * Gets the node found at the path.
-     * 
+     *
+     * @param <T> the type of the node
      * @param node the node
      * @param path the path
      * @return the node found at the path or null
@@ -57,7 +58,8 @@ public static <T extends JsonNode> T get(JsonNode node, JsonNodePath path) {
 
     /**
      * Gets the node given the property or index.
-     * 
+     *
+     * @param <T> the type of the node
      * @param node the node
      * @param propertyOrIndex the property or index
      * @return the node given the property or index

diff --git a/src/main/java/com/networknt/schema/walk/WalkEvent.java b/src/main/java/com/networknt/schema/walk/WalkEvent.java
@@ -83,7 +83,7 @@ public JsonNodePath getInstanceLocation() {
 
     /**
      * Gets the validator that corresponds with the keyword.
-     * 
+     * @param <T> the type of the validator
      * @return the validator
      */
     @SuppressWarnings("unchecked")