minor documentation cleanup

This commit is contained in:
Jeff Pinner 2013-07-19 19:54:09 -07:00 committed by Norman Maurer
parent a4d0341ea1
commit 6c9c151d66
4 changed files with 7 additions and 6 deletions

View File

@ -23,7 +23,7 @@ package io.netty.util;
public interface AttributeMap {
/**
* Get the {@link Attribute} for the given {@link AttributeKey}. This method will never return null, but may return
* an {@link AttributeKey} which has not value set yet.
* an {@link Attribute} which does not have a value set yet.
*/
<T> Attribute<T> attr(AttributeKey<T> key);
}

View File

@ -58,7 +58,7 @@ public final class ChannelOutboundBuffer {
private final Handle handle;
private AbstractChannel channel;
// Flushed messages are stored in a circulas queue.
// Flushed messages are stored in a circular buffer.
private Object[] flushed;
private ChannelPromise[] flushedPromises;
private int[] flushedPendingSizes;

View File

@ -19,6 +19,7 @@ import io.netty.util.concurrent.EventExecutor;
import java.net.ConnectException;
import java.net.SocketAddress;
/**
* Interface which is shared by others which need to execute outbound logic.
*/

View File

@ -31,7 +31,7 @@ interface ChannelPropertyAccess {
ChannelPipeline pipeline();
/**
* Return the assigned {@link ByteBufAllocator} which will be used for allocate {@link ByteBuf}s.
* Return the assigned {@link ByteBufAllocator} which will be used to allocate {@link ByteBuf}s.
*/
ByteBufAllocator alloc();
@ -46,14 +46,14 @@ interface ChannelPropertyAccess {
ChannelProgressivePromise newProgressivePromise();
/**
* Create a new {@link ChannelFuture} which is marked as successes already. So {@link ChannelFuture#isSuccess()}
* Create a new {@link ChannelFuture} which is marked as succeeded already. So {@link ChannelFuture#isSuccess()}
* will return {@code true}. All {@link FutureListener} added to it will be notified directly. Also
* every call of blocking methods will just return without blocking.
*/
ChannelFuture newSucceededFuture();
/**
* Create a new {@link ChannelFuture} which is marked as fakued already. So {@link Future#isSuccess()}
* Create a new {@link ChannelFuture} which is marked as failed already. So {@link ChannelFuture#isSuccess()}
* will return {@code false}. All {@link FutureListener} added to it will be notified directly. Also
* every call of blocking methods will just return without blocking.
*/
@ -67,7 +67,7 @@ interface ChannelPropertyAccess {
* </p>
* <p>
* Be aware that the returned {@link ChannelPromise} will not support most operations and should only be used
* if you want to safe object allocation for every operation. You will not be able to detect if the operation
* if you want to save an object allocation for every write operation. You will not be able to detect if the operation
* was complete, only if it failed as the implementation will call
* {@link ChannelPipeline#fireExceptionCaught(Throwable)} in this case.
* </p>