From f203cf4e22e4f774e362559278d0385ea9e0ac22 Mon Sep 17 00:00:00 2001 From: Trustin Lee Date: Mon, 1 Sep 2008 16:06:40 +0000 Subject: [PATCH] More JavaDoc in the buffer package --- .../org/jboss/netty/buffer/ChannelBufferIndexFinder.java | 7 ++++++- .../java/org/jboss/netty/buffer/WrappedChannelBuffer.java | 3 ++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/src/main/java/org/jboss/netty/buffer/ChannelBufferIndexFinder.java b/src/main/java/org/jboss/netty/buffer/ChannelBufferIndexFinder.java index d205438afc..d59f876461 100644 --- a/src/main/java/org/jboss/netty/buffer/ChannelBufferIndexFinder.java +++ b/src/main/java/org/jboss/netty/buffer/ChannelBufferIndexFinder.java @@ -27,7 +27,12 @@ package org.jboss.netty.buffer; * Locates an index of data in {@link ChannelBuffer}. *

* This interface enables the sequential search for the data which meets more - * complex and dynamic condition than just a simple value matching. + * complex and dynamic condition than just a simple value matching. Please + * refer to {@link ChannelBuffer#indexOf(int, int, ChannelBufferIndexFinder)}, + * {@link ChannelBuffer#readBytes(ChannelBufferIndexFinder)}, + * {@link ChannelBuffer#readSlice(ChannelBufferIndexFinder)}, and + * {@link ChannelBuffer#skipBytes(ChannelBufferIndexFinder)} + * for more explanation. * * @author The Netty Project (netty-dev@lists.jboss.org) * @author Trustin Lee (tlee@redhat.com) diff --git a/src/main/java/org/jboss/netty/buffer/WrappedChannelBuffer.java b/src/main/java/org/jboss/netty/buffer/WrappedChannelBuffer.java index da139d08ea..754064e4c0 100644 --- a/src/main/java/org/jboss/netty/buffer/WrappedChannelBuffer.java +++ b/src/main/java/org/jboss/netty/buffer/WrappedChannelBuffer.java @@ -23,7 +23,8 @@ package org.jboss.netty.buffer; /** - * Common interface for buffer wrappers and derived buffers. + * Common interface for buffer wrappers and derived buffers. Most users won't + * need to use this interface. It's used internally in most cases. * * @author The Netty Project (netty-dev@lists.jboss.org) * @author Trustin Lee (tlee@redhat.com)