From d00ad967c097390b46a22d4d032292923522d054 Mon Sep 17 00:00:00 2001 From: Pierangelo Di Pilato Date: Wed, 17 Nov 2021 16:55:27 +0100 Subject: [PATCH] Fix the Java Doc build (#424) - https://vertx.io/docs/apidocs/ returns 404, so removing it - Fix Java Doc error for missing `@param` Signed-off-by: Pierangelo Di Pilato --- api/src/main/java/io/cloudevents/rw/CloudEventReader.java | 5 +++++ pom.xml | 1 - 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/api/src/main/java/io/cloudevents/rw/CloudEventReader.java b/api/src/main/java/io/cloudevents/rw/CloudEventReader.java index bcd008b1..d2af1694 100644 --- a/api/src/main/java/io/cloudevents/rw/CloudEventReader.java +++ b/api/src/main/java/io/cloudevents/rw/CloudEventReader.java @@ -32,7 +32,12 @@ public interface CloudEventReader { /** * Like {@link #read(CloudEventWriterFactory, CloudEventDataMapper)}, but with the identity {@link CloudEventDataMapper}. * + * @param The type of the {@link CloudEventWriter} created by writerFactory + * @param The return value of the {@link CloudEventWriter} created by writerFactory + * @param writerFactory a factory that generates a visitor starting from the SpecVersion of the event * @see #read(CloudEventWriterFactory, CloudEventDataMapper) + * @return the value returned by {@link CloudEventWriter#end()} or {@link CloudEventWriter#end(CloudEventData)} + * @throws CloudEventRWException if something went wrong during the read. */ default , R> R read(CloudEventWriterFactory writerFactory) throws CloudEventRWException { return read(writerFactory, CloudEventDataMapper.identity()); diff --git a/pom.xml b/pom.xml index a124a66a..64be1102 100644 --- a/pom.xml +++ b/pom.xml @@ -163,7 +163,6 @@ https://docs.spring.io/spring-framework/docs/current/javadoc-api/ - https://vertx.io/docs/apidocs/ https://jakarta.ee/specifications/platform/8/apidocs/ https://kafka.apache.org/25/javadoc/ https://qpid.apache.org/releases/qpid-proton-j-0.33.7/api/