fixed javadoc errors discovered in release build

Signed-off-by: Thomas Jaeckle <thomas.jaeckle@bosch.io>
eclipse-ditto · May 6, 2021 · 9caa968 · 9caa968
1 parent 18e493c
commit 9caa968
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 6 deletions.
diff --git a/.../src/main/java/org/eclipse/ditto/base/model/exceptions/UnsupportedMediaTypeException.java b/.../src/main/java/org/eclipse/ditto/base/model/exceptions/UnsupportedMediaTypeException.java
@@ -20,10 +20,10 @@
  import javax.annotation.concurrent.Immutable;
  import javax.annotation.concurrent.NotThreadSafe;
 
- import org.eclipse.ditto.json.JsonObject;
  import org.eclipse.ditto.base.model.common.HttpStatus;
  import org.eclipse.ditto.base.model.headers.DittoHeaders;
  import org.eclipse.ditto.base.model.json.JsonParsableException;
+ import org.eclipse.ditto.json.JsonObject;
 
  /**
   * Thrown if a request with an unsupported media-type is made.
@@ -96,6 +96,7 @@ public static DittoRuntimeExceptionBuilder<UnsupportedMediaTypeException> withDe
       * about the actual used media-type and the description information about media-types are supported for the
       * requested resource.
       *
+      * @param callersMediaType the actually used media-type.
       * @param mediaTypeSupportedByCalledResource media-types which are supported.
       * @return the new UnsupportedMediaTypeException.
       */

diff --git a/base/model/src/main/java/org/eclipse/ditto/base/model/signals/acks/Acknowledgement.java b/base/model/src/main/java/org/eclipse/ditto/base/model/signals/acks/Acknowledgement.java
@@ -222,6 +222,7 @@ public Optional<JsonValue> getEntity(final JsonSchemaVersion schemaVersion) {
     /**
      * Sets the optional payload of the Acknowledgement.
      *
+     * @param payload the payload to set as entity.
      * @return the Acknowledgement with set payload.
      * @since 1.2.0
      */

diff --git a/.../eclipse/ditto/base/model/signals/commands/exceptions/GatewayTimeoutInvalidException.java b/.../eclipse/ditto/base/model/signals/commands/exceptions/GatewayTimeoutInvalidException.java
@@ -20,12 +20,12 @@
 import javax.annotation.concurrent.Immutable;
 import javax.annotation.concurrent.NotThreadSafe;
 
-import org.eclipse.ditto.json.JsonObject;
 import org.eclipse.ditto.base.model.common.HttpStatus;
 import org.eclipse.ditto.base.model.exceptions.DittoRuntimeException;
 import org.eclipse.ditto.base.model.exceptions.DittoRuntimeExceptionBuilder;
 import org.eclipse.ditto.base.model.headers.DittoHeaders;
 import org.eclipse.ditto.base.model.json.JsonParsableException;
+import org.eclipse.ditto.json.JsonObject;
 
 /**
  * This exception indicates that the configured {@code "timeout"} of a HTTP call was not valid or within its allowed
@@ -60,6 +60,8 @@ private GatewayTimeoutInvalidException(final DittoHeaders dittoHeaders,
     /**
      * A mutable builder for a {@code GatewayTimeoutInvalidException}.
      *
+     * @param timeout the applied timeout.
+     * @param maxTimeout the configured max timeout.
      * @return the builder.
      */
     public static Builder newBuilder(final Duration timeout, final Duration maxTimeout) {

diff --git a/.../model/src/main/java/org/eclipse/ditto/base/model/signals/events/GlobalEventRegistry.java b/.../model/src/main/java/org/eclipse/ditto/base/model/signals/events/GlobalEventRegistry.java
@@ -16,16 +16,18 @@
 
 import javax.annotation.concurrent.Immutable;
 
-import org.eclipse.ditto.json.JsonMissingFieldException;
-import org.eclipse.ditto.json.JsonObject;
 import org.eclipse.ditto.base.model.json.JsonParsableEvent;
 import org.eclipse.ditto.base.model.signals.AbstractAnnotationBasedJsonParsableFactory;
 import org.eclipse.ditto.base.model.signals.AbstractGlobalJsonParsableRegistry;
 import org.eclipse.ditto.base.model.signals.JsonParsable;
+import org.eclipse.ditto.json.JsonMissingFieldException;
+import org.eclipse.ditto.json.JsonObject;
 
 /**
  * Contains all strategies to deserialize subclasses of {@link Event} from a combination of
  * {@link org.eclipse.ditto.json.JsonObject} and {@link org.eclipse.ditto.base.model.headers.DittoHeaders}.
+ *
+ * @param <T> the event's type.
  */
 @Immutable
 public final class GlobalEventRegistry<T extends Event<?>>
@@ -40,6 +42,7 @@ private GlobalEventRegistry() {
     /**
      * Gets an instance of GlobalEventRegistry.
      *
+     * @param <T> the event's type.
      * @return the instance of GlobalEventRegistry.
      */
     public static <T extends Event<?>> GlobalEventRegistry<T> getInstance() {

diff --git a/pom.xml b/pom.xml
@@ -284,10 +284,10 @@
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-javadoc-plugin</artifactId>
-                    <version>3.1.1</version>
+                    <version>3.2.0</version>
                     <configuration>
                         <javadocExecutable>${java.home}/bin/javadoc</javadocExecutable>
-                        <source>11</source>
+                        <detectJavaApiLink>false</detectJavaApiLink>
                     </configuration>
                 </plugin>
                 <plugin>
@@ -726,6 +726,32 @@
             </build>
         </profile>
 
+        <profile>
+            <id>createJavadoc</id>
+            <activation>
+                <property>
+                    <name>createJavadoc</name>
+                    <value>true</value>
+                </property>
+            </activation>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.apache.maven.plugins</groupId>
+                        <artifactId>maven-javadoc-plugin</artifactId>
+                        <executions>
+                            <execution>
+                                <id>attach-javadocs</id>
+                                <goals>
+                                    <goal>jar</goal>
+                                </goals>
+                            </execution>
+                        </executions>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
+
         <profile>
             <id>performRelease</id>
             <activation>