Skip to content

Commit d00ad96

Browse files
authored
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 <[email protected]>
1 parent 9231e6d commit d00ad96

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

api/src/main/java/io/cloudevents/rw/CloudEventReader.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,12 @@ public interface CloudEventReader {
3232
/**
3333
* Like {@link #read(CloudEventWriterFactory, CloudEventDataMapper)}, but with the identity {@link CloudEventDataMapper}.
3434
*
35+
* @param <W> The type of the {@link CloudEventWriter} created by writerFactory
36+
* @param <R> The return value of the {@link CloudEventWriter} created by writerFactory
37+
* @param writerFactory a factory that generates a visitor starting from the SpecVersion of the event
3538
* @see #read(CloudEventWriterFactory, CloudEventDataMapper)
39+
* @return the value returned by {@link CloudEventWriter#end()} or {@link CloudEventWriter#end(CloudEventData)}
40+
* @throws CloudEventRWException if something went wrong during the read.
3641
*/
3742
default <W extends CloudEventWriter<R>, R> R read(CloudEventWriterFactory<W, R> writerFactory) throws CloudEventRWException {
3843
return read(writerFactory, CloudEventDataMapper.identity());

pom.xml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,6 @@
163163
<detectLinks/>
164164
<links>
165165
<link>https://docs.spring.io/spring-framework/docs/current/javadoc-api/</link>
166-
<link>https://vertx.io/docs/apidocs/</link>
167166
<link>https://jakarta.ee/specifications/platform/8/apidocs/</link>
168167
<link>https://kafka.apache.org/25/javadoc/</link>
169168
<link>https://qpid.apache.org/releases/qpid-proton-j-0.33.7/api/</link>

0 commit comments

Comments
 (0)