From b0b05d95d930b4bffa2953a637b0d293e5ce7729 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=CC=88rg=20Prante?= Date: Wed, 20 May 2020 15:18:02 +0200 Subject: [PATCH] javadoc fixes for Java 13 --- .gitignore | 3 ++- .../netty/channel/ChannelOperations.java | 8 ------- .../reactivex/netty/channel/Connection.java | 2 -- .../http/server/HttpServerResponse.java | 3 --- .../http/server/ResponseContentWriter.java | 24 ------------------- 5 files changed, 2 insertions(+), 38 deletions(-) diff --git a/.gitignore b/.gitignore index 3d0280a..4b9b334 100644 --- a/.gitignore +++ b/.gitignore @@ -10,4 +10,5 @@ /.gradle build out -*~ \ No newline at end of file +*~ +*.iml diff --git a/netty-http-rx/src/main/java/io/reactivex/netty/channel/ChannelOperations.java b/netty-http-rx/src/main/java/io/reactivex/netty/channel/ChannelOperations.java index 0b98c7c..4ee215a 100644 --- a/netty-http-rx/src/main/java/io/reactivex/netty/channel/ChannelOperations.java +++ b/netty-http-rx/src/main/java/io/reactivex/netty/channel/ChannelOperations.java @@ -64,8 +64,6 @@ public interface ChannelOperations { /** * On subscription of the returned {@link Observable}, writes the passed message stream on the underneath channel. * - *

Flush.

- * * All writes will be flushed on completion of the passed {@code Observable} * * @param msgs Stream of messages to write. @@ -108,8 +106,6 @@ public interface ChannelOperations { /** * On subscription of the returned {@link Observable}, writes the passed message stream on the underneath channel. * - *

Flush.

- * * All writes will be flushed on completion of the passed {@code Observable} * * @param msgs Stream of messages to write. @@ -152,8 +148,6 @@ public interface ChannelOperations { /** * On subscription of the returned {@link Observable}, writes the passed message stream on the underneath channel. * - *

Flush.

- * * All writes will be flushed on completion of the passed {@code Observable} * * @param msgs Stream of messages to write. @@ -196,8 +190,6 @@ public interface ChannelOperations { /** * On subscription of the returned {@link Observable}, writes the passed message stream on the underneath channel. * - *

Flush.

- * * All writes will be flushed on completion of the passed {@code Observable} * * @param msgs Stream of messages to write. diff --git a/netty-http-rx/src/main/java/io/reactivex/netty/channel/Connection.java b/netty-http-rx/src/main/java/io/reactivex/netty/channel/Connection.java index cd7d86d..086ee69 100644 --- a/netty-http-rx/src/main/java/io/reactivex/netty/channel/Connection.java +++ b/netty-http-rx/src/main/java/io/reactivex/netty/channel/Connection.java @@ -289,8 +289,6 @@ public abstract class Connection implements ChannelOperations { /** * Returns the underlying netty {@link Channel} for this connection. * - *

Why unsafe?

- * * It is advisable to use this connection abstraction for all interactions with the channel, however, advanced users * may find directly using the netty channel useful in some cases. * diff --git a/netty-http-rx/src/main/java/io/reactivex/netty/protocol/http/server/HttpServerResponse.java b/netty-http-rx/src/main/java/io/reactivex/netty/protocol/http/server/HttpServerResponse.java index 164b88e..93577f7 100644 --- a/netty-http-rx/src/main/java/io/reactivex/netty/protocol/http/server/HttpServerResponse.java +++ b/netty-http-rx/src/main/java/io/reactivex/netty/protocol/http/server/HttpServerResponse.java @@ -300,7 +300,6 @@ public abstract class HttpServerResponse extends ResponseContentWriter { /** * This is a performance optimization to not flush the channel on every response send. * - *

When NOT to use

* This can be used * only when the processing for a server is not asynchronous, in which case, one would have to flush the responses * written explicitly (done on completion of the {@link Observable} written). Something like this: @@ -312,8 +311,6 @@ public abstract class HttpServerResponse extends ResponseContentWriter { ) * - *

When to use

- * * This can be used when the response is written synchronously from a {@link RequestHandler}, something like: *
diff --git a/netty-http-rx/src/main/java/io/reactivex/netty/protocol/http/server/ResponseContentWriter.java b/netty-http-rx/src/main/java/io/reactivex/netty/protocol/http/server/ResponseContentWriter.java
index 5f8f73c..82cdba6 100644
--- a/netty-http-rx/src/main/java/io/reactivex/netty/protocol/http/server/ResponseContentWriter.java
+++ b/netty-http-rx/src/main/java/io/reactivex/netty/protocol/http/server/ResponseContentWriter.java
@@ -38,8 +38,6 @@ public abstract class ResponseContentWriter extends Observable {
     /**
      * On subscription of the returned {@link Observable}, writes the passed message stream on the underneath channel.
      *
-     * 

Flush

- * * The writes are flushed when the passed stream completes. * * @param msgs Stream of messages to write. @@ -57,14 +55,10 @@ public abstract class ResponseContentWriter extends Observable { * {@code trailerMutator} will be invoked for every item emitted from the content source, giving a chance to modify * the trailing headers instance. * - *

Multiple invocations

- * * This method can not be invoked multiple times for the same response as on completion of the passed * source, it writes the trailing headers and trailing headers can only be written once for an HTTP response. * So, any subsequent invocation of this method will always emit an error when subscribed. * - *

Flush

- * * The writes are flushed when the passed stream completes. * * @param contentSource Content source for the response. @@ -85,8 +79,6 @@ public abstract class ResponseContentWriter extends Observable { * {@code trailerMutator} will be invoked for every item emitted from the content source, giving a chance to modify * the trailing headers instance. * - *

Multiple invocations

- * * This method can not be invoked multiple times for the same response as on completion of the passed * source, it writes the trailing headers and trailing headers can only be written once for an HTTP response. * So, any subsequent invocation of this method will always emit an error when subscribed. @@ -137,8 +129,6 @@ public abstract class ResponseContentWriter extends Observable { /** * On subscription of the returned {@link Observable}, writes the passed message stream on the underneath channel. * - *

Flush

- * * The writes are flushed when the passed stream completes. * * @param msgs Stream of messages to write. @@ -156,14 +146,10 @@ public abstract class ResponseContentWriter extends Observable { * {@code trailerMutator} will be invoked for every item emitted from the content source, giving a chance to modify * the trailing headers instance. * - *

Multiple invocations

- * * This method can not be invoked multiple times for the same response as on completion of the passed * source, it writes the trailing headers and trailing headers can only be written once for an HTTP response. * So, any subsequent invocation of this method will always emit an error when subscribed. * - *

Flush

- * * The writes are flushed when the passed stream completes. * * @param contentSource Content source for the response. @@ -184,8 +170,6 @@ public abstract class ResponseContentWriter extends Observable { * {@code trailerMutator} will be invoked for every item emitted from the content source, giving a chance to modify * the trailing headers instance. * - *

Multiple invocations

- * * This method can not be invoked multiple times for the same response as on completion of the passed * source, it writes the trailing headers and trailing headers can only be written once for an HTTP response. * So, any subsequent invocation of this method will always emit an error when subscribed. @@ -236,8 +220,6 @@ public abstract class ResponseContentWriter extends Observable { /** * On subscription of the returned {@link Observable}, writes the passed message stream on the underneath channel. * - *

Flush

- * * The writes are flushed when the passed stream completes. * * @param msgs Stream of messages to write. @@ -255,14 +237,10 @@ public abstract class ResponseContentWriter extends Observable { * {@code trailerMutator} will be invoked for every item emitted from the content source, giving a chance to modify * the trailing headers instance. * - *

Multiple invocations

- * * This method can not be invoked multiple times for the same response as on completion of the passed * source, it writes the trailing headers and trailing headers can only be written once for an HTTP response. * So, any subsequent invocation of this method will always emit an error when subscribed. * - *

Flush

- * * The writes are flushed when the passed stream completes. * * @param contentSource Content source for the response. @@ -283,8 +261,6 @@ public abstract class ResponseContentWriter extends Observable { * {@code trailerMutator} will be invoked for every item emitted from the content source, giving a chance to modify * the trailing headers instance. * - *

Multiple invocations

- * * This method can not be invoked multiple times for the same response as on completion of the passed * source, it writes the trailing headers and trailing headers can only be written once for an HTTP response. * So, any subsequent invocation of this method will always emit an error when subscribed.