From a26ebc2bc1a2a85ed748296c12e997ef017f78e5 Mon Sep 17 00:00:00 2001
From: Trustin Lee <trustin@gmail.com>
Date: Thu, 18 Jun 2009 12:21:46 +0000
Subject: [PATCH] Javadoc

---
 .../frame/LengthFieldBasedFrameDecoder.java   | 32 +++++++++----------
 1 file changed, 16 insertions(+), 16 deletions(-)

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 2238384c2b..b87f9d0f17 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
@@ -38,26 +38,12 @@ import org.jboss.netty.channel.ChannelHandlerContext;
  * proprietary client-server protocols.  Here are some example that will give
  * you the basic idea on which option does what.
  *
- * <h3>4 bytes length field at offset 0, strip header</h3>
- * <pre>
- * <b>lengthFieldOffset</b>   = <b>0</b>
- * <b>lengthFieldLength</b>   = <b>4</b>
- * <b>lengthAdjustment</b>    = <b>0</b>
- * <b>initialBytesToStrip</b> = <b>4</b>
- *
- * BEFORE DECODE (16 bytes)               AFTER DECODE (12 bytes)
- * +--------------+----------------+      +----------------+
- * | Length Field | Actual Content |----->| Actual Content |
- * |  0x0000000C  | "HELLO, WORLD" |      | "HELLO, WORLD" |
- * +--------------+----------------+      +----------------+
- * </pre>
- *
  * <h3>2 bytes length field at offset 0, do not strip header</h3>
  * <pre>
  * <b>lengthFieldOffset</b>   = <b>0</b>
  * <b>lengthFieldLength</b>   = <b>2</b>
- * <b>lengthAdjustment</b>    = <b>0</b>
- * <b>initialBytesToStrip</b> = <b>0</b>
+ * <b>lengthAdjustment</b>    = <b>0</b> (default)
+ * <b>initialBytesToStrip</b> = <b>0</b> (default)
  *
  * BEFORE DECODE (14 bytes)         AFTER DECODE (14 bytes)
  * +--------+----------------+      +--------+----------------+
@@ -66,6 +52,20 @@ import org.jboss.netty.channel.ChannelHandlerContext;
  * +--------+----------------+      +--------+----------------+
  * </pre>
  *
+ * <h3>2 bytes length field at offset 0, strip header</h3>
+ * <pre>
+ * <b>lengthFieldOffset</b>   = <b>0</b>
+ * <b>lengthFieldLength</b>   = <b>2</b>
+ * <b>lengthAdjustment</b>    = <b>0</b>
+ * <b>initialBytesToStrip</b> = <b>2</b>
+ *
+ * BEFORE DECODE (14 bytes)         AFTER DECODE (12 bytes)
+ * +--------+----------------+      +----------------+
+ * | Length | Actual Content |----->| Actual Content |
+ * | 0x000C | "HELLO, WORLD" |      | "HELLO, WORLD" |
+ * +--------+----------------+      +----------------+
+ * </pre>
+ *
  * <h3>3 bytes length field at the end of 5 bytes header, strip header</h3>
  * <pre>
  * <b>lengthFieldOffset</b>   = <b>2</b> (= 5 - 3)