Fix #403 - Contradictory JavaDoc in setWriteBufferHighWaterMark

This commit is contained in:
Trustin Lee 2012-06-24 13:04:20 +09:00
parent fa886dbc80
commit 3fc7730b2c

View File

@ -30,14 +30,14 @@ public interface NioChannelConfig extends ChannelConfig {
/** /**
* Returns the high water mark of the write buffer. If the number of bytes * Returns the high water mark of the write buffer. If the number of bytes
* queued in the write buffer exceeds this value, {@link Channel#isWritable()} * queued in the write buffer exceeds this value, {@link Channel#isWritable()}
* will start to return {@code true}. * will start to return {@code false}.
*/ */
int getWriteBufferHighWaterMark(); int getWriteBufferHighWaterMark();
/** /**
* Sets the high water mark of the write buffer. If the number of bytes * Sets the high water mark of the write buffer. If the number of bytes
* queued in the write buffer exceeds this value, {@link Channel#isWritable()} * queued in the write buffer exceeds this value, {@link Channel#isWritable()}
* will start to return {@code true}. * will start to return {@code false}.
*/ */
void setWriteBufferHighWaterMark(int writeBufferHighWaterMark); void setWriteBufferHighWaterMark(int writeBufferHighWaterMark);
@ -45,8 +45,8 @@ public interface NioChannelConfig extends ChannelConfig {
* Returns the low water mark of the write buffer. Once the number of bytes * Returns the low water mark of the write buffer. Once the number of bytes
* queued in the write buffer exceeded the * queued in the write buffer exceeded the
* {@linkplain #setWriteBufferHighWaterMark(int) high water mark} and then * {@linkplain #setWriteBufferHighWaterMark(int) high water mark} and then
* dropped down below this value, {@link Channel#isWritable()} will return * dropped down below this value, {@link Channel#isWritable()} will start to return
* {@code false} again. * {@code true} again.
*/ */
int getWriteBufferLowWaterMark(); int getWriteBufferLowWaterMark();
@ -54,8 +54,8 @@ public interface NioChannelConfig extends ChannelConfig {
* Sets the low water mark of the write buffer. Once the number of bytes * Sets the low water mark of the write buffer. Once the number of bytes
* queued in the write buffer exceeded the * queued in the write buffer exceeded the
* {@linkplain #setWriteBufferHighWaterMark(int) high water mark} and then * {@linkplain #setWriteBufferHighWaterMark(int) high water mark} and then
* dropped down below this value, {@link Channel#isWritable()} will return * dropped down below this value, {@link Channel#isWritable()} will start toreturn
* {@code false} again. * {@code true} again.
*/ */
void setWriteBufferLowWaterMark(int writeBufferLowWaterMark); void setWriteBufferLowWaterMark(int writeBufferLowWaterMark);