From 348745608faae89c33d5dbae40be8e81b239177d Mon Sep 17 00:00:00 2001
From: Norman Maurer <norman_maurer@apple.com>
Date: Fri, 4 Aug 2017 19:52:01 +0200
Subject: [PATCH] Fix incorrect javadocs in Http2RemoteFlowController

Motivation:

The javadocs of Http2RemoteFlowController.isWritable(...) are incorrect.

Modifications:

Update javadocs to reflect reality.

Result:

Correct javadocs.
---
 .../handler/codec/http2/Http2RemoteFlowController.java   | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/codec-http2/src/main/java/io/netty/handler/codec/http2/Http2RemoteFlowController.java b/codec-http2/src/main/java/io/netty/handler/codec/http2/Http2RemoteFlowController.java
index cd26addc64..28296a7db8 100644
--- a/codec-http2/src/main/java/io/netty/handler/codec/http2/Http2RemoteFlowController.java
+++ b/codec-http2/src/main/java/io/netty/handler/codec/http2/Http2RemoteFlowController.java
@@ -67,11 +67,12 @@ public interface Http2RemoteFlowController extends Http2FlowController {
     /**
      * Determine if the {@code stream} has bytes remaining for use in the flow control window.
      * <p>
-     * Note that this only takes into account HTTP/2 flow control. It does <strong>not</strong> take into account
-     * the underlying {@link io.netty.channel.Channel#isWritable()}.
+     * Note that this method respects channel writability. The channel must be writable for this method to
+     * return {@code true}.
+     *
      * @param stream The stream to test.
-     * @return {@code true} if if the {@code stream} has bytes remaining for use in the flow control window.
-     * {@code false} otherwise.
+     * @return {@code true} if the {@code stream} has bytes remaining for use in the flow control window and the
+     * channel is writable, {@code false} otherwise.
      */
     boolean isWritable(Http2Stream stream);