clean up javadoc

Author: hauner

io-interfaces/src/main/java/io/openapiprocessor/interfaces/Writer.java

@@ -18,6 +18,5 @@ public interface Writer {
      * @param document the document
      * @throws IOException if writing fails.
      */
-
     void write(Object document) throws IOException;
 }

json-schema-validator/src/main/java/io/openapiprocessor/jsonschema/ouput/OutputUnit.java

@@ -12,22 +12,30 @@
 public interface OutputUnit {
 
     /**
-     * validation result
+     * The validation result.
+     *
+     * @return the validation result.
      */
     boolean isValid ();
 
     /**
-     * relative location of the validating keyword
+     * The relative location of the validating keyword.
+     *
+     * @return the relative location of the validating keyword.
      */
     String getKeywordLocation ();
 
     /**
-     * The location of the validated JSON value within the instance
+     * The location of the validated JSON value within the instance.
+     *
+     * @return the location of the validated JSON value within the instance.
      */
     String getInstanceLocation ();
 
     /**
-     * The absolute, dereferenced location of the validating keyword
+     * The absolute, dereferenced location of the validating keyword.
+     *
+     * @return the absolute, dereferenced location of the validating keyword.
      */
     String getAbsoluteKeywordLocation ();
 
@@ -36,12 +44,16 @@ public interface OutputUnit {
     @Nullable Object getAnnotation ();
 
     /**
-     * errors or annotation produced by a failed validation
+     * The errors or annotation produced by a failed validation.
+     *
+     * @return the errors or annotation produced by a failed validation.
      */
     @Nullable Collection<OutputUnit> getErrors ();
 
     /**
-     * errors or annotation produced by a successful validation
+     * The errors or annotation produced by a successful validation.
+     *
+     * @return the errors or annotation produced by a successful validation.
      */
     @Nullable Collection<OutputUnit> getAnnotations ();
 }

json-schema-validator/src/main/java/io/openapiprocessor/jsonschema/ouput/OutputUnitWrite.java

@@ -10,37 +10,58 @@
 public interface OutputUnitWrite {
 
     /**
-     * set validation result
+     * Set the validation result.
+     *
+     * @param valid the validation result.
      */
     void setValid (boolean valid);
 
     /**
-     * relative location of the validating keyword
+     * Set the relative location of the validating keyword.
+     *
+     * @param location the relative location of the validating keyword.
      */
     void setKeywordLocation (String location);
 
     /**
-     * The location of the validated JSON value within the instance
+     * The location of the validated JSON value within the instance.
+     *
+     * @param location the location of the validated JSON value within the instance.
      */
     void setInstanceLocation (String location);
 
     /**
-     * The absolute, dereferenced location of the validating keyword
+     * The absolute, dereferenced location of the validating keyword.
+     *
+     * @param location the absolute, dereferenced location of the validating keyword.
      */
     void setAbsoluteKeywordLocation (String location);
 
+    /**
+     * Set error or annotation produced by a failed validation.
+     *
+     * @param error the error or annotation produced by a failed validation.
+     */
     void setError (String error);
 
+    /**
+     * Set the error or annotation produced by a successful validation.
+     *
+     * @param annotation the error or annotation produced by a successful validation.
+     */
     void setAnnotation (Object annotation);
 
     /**
-     * errors or annotation produced by a failed validation
+     * Set errors or annotation produced by a failed validation.
+     *
+     * @param errors the errors or annotation produced by a failed validation.
      */
     void setErrors (Collection<OutputUnit> errors);
 
     /**
-     * errors or annotation produced by a successful validation
+     * Set the errors or annotation produced by a successful validation.
+     *
+     * @param annotations the errors or annotations produced by a successful validation.
      */
     void setAnnotations (Collection<OutputUnit> annotations);
 }
-

json-schema-validator/src/main/java/io/openapiprocessor/jsonschema/validator/steps/ValidationStep.java

@@ -35,6 +35,8 @@ public interface ValidationStep {
     /**
      * If true this step is used to calculate the final validation result. 'if' is the only keyword that is not
      * validatable.
+     *
+     * @return true if validatable, else false
      */
     default boolean isValidatable () {
         return true;

openapi-parser/src/main/java/io/openapiparser/OpenApiResult.java

@@ -56,6 +56,7 @@ enum Version { V30, V31 }
      * can be used to create a single file document.
      *
      * @param writer the target writer
+     * @throws IOException if writing failed
      */
     @Experimental
     void write(Writer writer) throws IOException;