From f996be932a5a80861493c8b1cced3d360d48cd39 Mon Sep 17 00:00:00 2001 From: Trustin Lee Date: Wed, 17 Dec 2008 08:55:57 +0000 Subject: [PATCH] Updated Javadoc --- .../jboss/netty/handler/codec/oneone/OneToOneDecoder.java | 2 +- .../jboss/netty/handler/codec/oneone/OneToOneEncoder.java | 4 ++-- .../org/jboss/netty/handler/codec/string/StringDecoder.java | 4 ++-- .../org/jboss/netty/handler/codec/string/StringEncoder.java | 6 ++++-- 4 files changed, 9 insertions(+), 7 deletions(-) diff --git a/src/main/java/org/jboss/netty/handler/codec/oneone/OneToOneDecoder.java b/src/main/java/org/jboss/netty/handler/codec/oneone/OneToOneDecoder.java index 603ee6cdb8..eda75e46e6 100644 --- a/src/main/java/org/jboss/netty/handler/codec/oneone/OneToOneDecoder.java +++ b/src/main/java/org/jboss/netty/handler/codec/oneone/OneToOneDecoder.java @@ -38,7 +38,7 @@ import org.jboss.netty.handler.codec.frame.FrameDecoder; * Transforms a received message into another message. Please note that this * decoder must be used with a proper {@link FrameDecoder} such as * {@link DelimiterBasedFrameDecoder} if you are using a stream-based transport - * such as TCP/IP. A typical decoder setup would be: + * such as TCP/IP. A typical setup for TCP/IP would be: *
  * {@link ChannelPipeline} pipeline = ...;
  *
diff --git a/src/main/java/org/jboss/netty/handler/codec/oneone/OneToOneEncoder.java b/src/main/java/org/jboss/netty/handler/codec/oneone/OneToOneEncoder.java
index dced91e78d..81460e14cd 100644
--- a/src/main/java/org/jboss/netty/handler/codec/oneone/OneToOneEncoder.java
+++ b/src/main/java/org/jboss/netty/handler/codec/oneone/OneToOneEncoder.java
@@ -34,8 +34,8 @@ import org.jboss.netty.handler.codec.frame.DelimiterBasedFrameDecoder;
 import org.jboss.netty.handler.codec.frame.Delimiters;
 
 /**
- * Transforms a received message into another message.  A typical decoder setup
- * would be:
+ * Transforms a received message into another message.  A typical setup for
+ * TCP/IP would be:
  * 
  * {@link ChannelPipeline} pipeline = ...;
  *
diff --git a/src/main/java/org/jboss/netty/handler/codec/string/StringDecoder.java b/src/main/java/org/jboss/netty/handler/codec/string/StringDecoder.java
index b2d53d3d5f..e6cb5d107a 100644
--- a/src/main/java/org/jboss/netty/handler/codec/string/StringDecoder.java
+++ b/src/main/java/org/jboss/netty/handler/codec/string/StringDecoder.java
@@ -38,8 +38,8 @@ import org.jboss.netty.handler.codec.oneone.OneToOneDecoder;
  * Decodes a received {@link ChannelBuffer} into a {@link String}.  Please
  * note that this decoder must be used with a proper {@link FrameDecoder}
  * such as {@link DelimiterBasedFrameDecoder} if you are using a stream-based
- * transport such as TCP/IP.  A typical decoder setup for a text-based line
- * protocol in a TCP/IP socket would be:
+ * transport such as TCP/IP.  A typical setup for a text-based line protocol
+ * in a TCP/IP socket would be:
  * 
  * {@link ChannelPipeline} pipeline = ...;
  *
diff --git a/src/main/java/org/jboss/netty/handler/codec/string/StringEncoder.java b/src/main/java/org/jboss/netty/handler/codec/string/StringEncoder.java
index e8b7febba3..b13cf5beaa 100644
--- a/src/main/java/org/jboss/netty/handler/codec/string/StringEncoder.java
+++ b/src/main/java/org/jboss/netty/handler/codec/string/StringEncoder.java
@@ -37,8 +37,7 @@ import org.jboss.netty.handler.codec.oneone.OneToOneEncoder;
 
 /**
  * Encodes the requested {@link String} into a {@link ChannelBuffer}.
- * The typical decoder setup for a text-based line protocol in a TCP/IP socket
- * would be:
+ * The typical setup for a text-based line protocol in a TCP/IP socket would be:
  * 
  * {@link ChannelPipeline} pipeline = ...;
  *
@@ -70,6 +69,9 @@ public class StringEncoder extends OneToOneEncoder {
 
     private final String charsetName;
 
+    /**
+     * Creates a new instance with the current system character set.
+     */
     public StringEncoder() {
         this(Charset.defaultCharset());
     }