improve javadoc

Author: hauner

src/main/java/io/openapiprocessor/api/v2/OpenApiProcessor.java

@@ -12,10 +12,9 @@
  * plugin) it must implement this interface and have a
  * {@code META-INF/services/io.openapiprocessor.api.v1.OpenApiProcessor} property file in the
  * resources with the class name of the implementing class.
- *
  * <p>
  * A consumer should be able to provide access to any processor that is found on the class path.
- *
+ * <p>
  * The gradle plugin uses the name provided by the api to configure the processor and to provide a
  * task to run it. This task will find and run an openapi-processor by using the
  * {@code OpenApiProcessor} service interface. By using an interface it does not need an explicit
@@ -26,11 +25,9 @@ public interface OpenApiProcessor {
     /**
      * The identifying name of the openapi-processor. *Should* be globally unique so a consumer of
      * this interface can distinguish between different openapi-processors.
-     *
      * <p>
      * It is recommended to return here the last part of the full openapi-processor name. If the
      * processor jar name is {@code openapi-processor-spring} the name should be {@code spring}.
-     * </p>
      *
      * @return the unique name of the openapi-processor
      */

src/main/java/io/openapiprocessor/api/v2/OpenApiProcessorVersion.java

@@ -5,10 +5,14 @@
 
 package io.openapiprocessor.api.v2;
 
+/**
+ * Interface to provide (optional) version information of a processor. This must be implemented by
+ * the same class that implements {@link OpenApiProcessor}.
+ */
 public interface OpenApiProcessorVersion {
 
     /**
-     * The version of this openapi-processor.
+     * The version of this openapi-processor. E.g. 2023.1
      *
      * @return the version of this processor
      */

src/main/java/io/openapiprocessor/api/v2/Version.java

@@ -7,8 +7,28 @@
 
 import java.time.Instant;
 
+/**
+ * details of a version.
+ */
 public interface Version {
+    /**
+     * the version of this openapi-processor. E.g. 2023.1
+     *
+     * @return the version of this processor
+     */
     String getName();
+
+    /**
+     * the published date of this version.
+     *
+     * @return publish date
+     */
     Instant getPublishedAt();
+
+    /**
+     * the version information.
+     *
+     * @return version information.
+     */
     String getText();
 }