From 10009a05fbd218a8912a21a67beae7323fcf800a Mon Sep 17 00:00:00 2001 From: Trustin Lee Date: Thu, 18 Jun 2009 12:30:38 +0000 Subject: [PATCH] Javadoc --- .../handler/codec/frame/DelimiterBasedFrameDecoder.java | 7 +++---- .../handler/codec/frame/FixedLengthFrameDecoder.java | 5 ++--- .../codec/frame/LengthFieldBasedFrameDecoder.java | 9 ++++----- 3 files changed, 9 insertions(+), 12 deletions(-) diff --git a/src/main/java/org/jboss/netty/handler/codec/frame/DelimiterBasedFrameDecoder.java b/src/main/java/org/jboss/netty/handler/codec/frame/DelimiterBasedFrameDecoder.java index a38359f416..f854859c96 100644 --- a/src/main/java/org/jboss/netty/handler/codec/frame/DelimiterBasedFrameDecoder.java +++ b/src/main/java/org/jboss/netty/handler/codec/frame/DelimiterBasedFrameDecoder.java @@ -27,10 +27,9 @@ import org.jboss.netty.channel.Channel; import org.jboss.netty.channel.ChannelHandlerContext; /** - * A decoder that decodes the received {@link ChannelBuffer}s into the - * {@link ChannelBuffer}s split by one or more delimiters. It is particularly - * useful for decoding the frames which ends with a delimiter such as - * {@link Delimiters#nulDelimiter() NUL} or + * A decoder that splits the received {@link ChannelBuffer}s by one or more + * delimiters. It is particularly useful for decoding the frames which ends + * with a delimiter such as {@link Delimiters#nulDelimiter() NUL} or * {@linkplain Delimiters#lineDelimiter() newline characters}. * *

Predefined delimiters

diff --git a/src/main/java/org/jboss/netty/handler/codec/frame/FixedLengthFrameDecoder.java b/src/main/java/org/jboss/netty/handler/codec/frame/FixedLengthFrameDecoder.java index 5659f2d8e7..93a0ff7978 100644 --- a/src/main/java/org/jboss/netty/handler/codec/frame/FixedLengthFrameDecoder.java +++ b/src/main/java/org/jboss/netty/handler/codec/frame/FixedLengthFrameDecoder.java @@ -27,9 +27,8 @@ import org.jboss.netty.channel.Channel; import org.jboss.netty.channel.ChannelHandlerContext; /** - * A decoder that decodes the received {@link ChannelBuffer}s into the - * {@link ChannelBuffer}s of the fixed length. For example, if you received - * the following four fragmented packets: + * A decoder that splits the received {@link ChannelBuffer}s by the fixed number + * of bytes. For example, if you received the following four fragmented packets: *
  * +---+----+------+----+
  * | A | BC | DEFG | HI |
diff --git a/src/main/java/org/jboss/netty/handler/codec/frame/LengthFieldBasedFrameDecoder.java b/src/main/java/org/jboss/netty/handler/codec/frame/LengthFieldBasedFrameDecoder.java
index b87f9d0f17..694cbbad07 100644
--- a/src/main/java/org/jboss/netty/handler/codec/frame/LengthFieldBasedFrameDecoder.java
+++ b/src/main/java/org/jboss/netty/handler/codec/frame/LengthFieldBasedFrameDecoder.java
@@ -27,11 +27,10 @@ import org.jboss.netty.channel.Channel;
 import org.jboss.netty.channel.ChannelHandlerContext;
 
 /**
- * A decoder that decodes the received {@link ChannelBuffer}s with a frame
- * length field into a meaningfully framed {@link ChannelBuffer}.  It is
- * particularly useful when you decode a binary message which has an integer
- * header field that represents the length of the message body or the whole
- * message.
+ * A decoder that splits the received {@link ChannelBuffer}s dynamically by the
+ * value of the length field in the message.  It is particularly useful when you
+ * decode a binary message which has an integer header field that represents the
+ * length of the message body or the whole message.
  * 

* {@link LengthFieldBasedFrameDecoder} has many configuration parameters so * that it can decode any message with a length field, which is often seen in