More JavaDoc in the buffer package

This commit is contained in:
Trustin Lee 2008-09-01 16:06:40 +00:00
parent f4ce86a12d
commit f203cf4e22
2 changed files with 8 additions and 2 deletions

View File

@ -27,7 +27,12 @@ package org.jboss.netty.buffer;
* Locates an index of data in {@link ChannelBuffer}.
* <p>
* 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)

View File

@ -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)