From d2060ee3f194445aab0463ed0f4a08ca1af8169e Mon Sep 17 00:00:00 2001
From: Norman Maurer <nmaurer@redhat.com>
Date: Thu, 20 Dec 2012 15:45:49 +0100
Subject: [PATCH] Add more javadocs

---
 .../netty/handler/timeout/ReadTimeoutHandler.java   |  4 ++--
 .../netty/handler/timeout/WriteTimeoutHandler.java  |  4 ++--
 .../java/io/netty/channel/ChannelInitializer.java   | 13 +++++++++++++
 3 files changed, 17 insertions(+), 4 deletions(-)

diff --git a/handler/src/main/java/io/netty/handler/timeout/ReadTimeoutHandler.java b/handler/src/main/java/io/netty/handler/timeout/ReadTimeoutHandler.java
index 7033a648cf..2acfd487f6 100644
--- a/handler/src/main/java/io/netty/handler/timeout/ReadTimeoutHandler.java
+++ b/handler/src/main/java/io/netty/handler/timeout/ReadTimeoutHandler.java
@@ -35,8 +35,8 @@ import java.util.concurrent.TimeUnit;
  *
  * public class MyChannelInitializer extends {@link ChannelInitializer} {
  *     public void initChannel({@link Channel} channel) {
- *         {@link Channel}.pipeline().addLast("readTimeoutHandler", new {@link ReadTimeoutHandler}(30);
- *         {@link Channel}.pipeline().addLast("myHandler", new MyHandler());
+ *         channel.pipeline().addLast("readTimeoutHandler", new {@link ReadTimeoutHandler}(30);
+ *         channel.pipeline().addLast("myHandler", new MyHandler());
  *     }
  * }
  *
diff --git a/handler/src/main/java/io/netty/handler/timeout/WriteTimeoutHandler.java b/handler/src/main/java/io/netty/handler/timeout/WriteTimeoutHandler.java
index 2558bdba18..2ec9ade400 100644
--- a/handler/src/main/java/io/netty/handler/timeout/WriteTimeoutHandler.java
+++ b/handler/src/main/java/io/netty/handler/timeout/WriteTimeoutHandler.java
@@ -38,8 +38,8 @@ import java.util.concurrent.TimeUnit;
  *
  * public class MyChannelInitializer extends {@link ChannelInitializer} {
  *     public void initChannel({@link Channel} channel) {
- *         {@link Channel}.pipeline().addLast("writeTimeoutHandler", new {@link WriteTimeoutHandler}(30);
- *         {@link Channel}.pipeline().addLast("myHandler", new MyHandler());
+ *         channel.pipeline().addLast("writeTimeoutHandler", new {@link WriteTimeoutHandler}(30);
+ *         channel.pipeline().addLast("myHandler", new MyHandler());
  *     }
  * }
  *
diff --git a/transport/src/main/java/io/netty/channel/ChannelInitializer.java b/transport/src/main/java/io/netty/channel/ChannelInitializer.java
index e6a1287ac8..46c913e0a8 100644
--- a/transport/src/main/java/io/netty/channel/ChannelInitializer.java
+++ b/transport/src/main/java/io/netty/channel/ChannelInitializer.java
@@ -29,6 +29,19 @@ import io.netty.logging.InternalLoggerFactory;
  * {@link ServerBootstrap#handler(ChannelHandler)} and {@link ServerBootstrap#childHandler(ChannelHandler)} to
  * setup the {@link ChannelPipeline} of a {@link Channel}.
  *
+ * <pre>
+ *
+ * public class MyChannelInitializer extends {@link ChannelInitializer} {
+ *     public void initChannel({@link Channel} channel) {
+ *         channel.pipeline().addLast("myHandler", new MyHandler());
+ *     }
+ * }
+ *
+ * {@link ServerBootstrap} bootstrap = ...;
+ * ...
+ * bootstrap.childHandler(new MyChannelInitializer());
+ * ...
+ * </pre>
  * Be aware that this class is marked as {@link Sharable} and so the implementation must be safe to be re-used.
  *
  * @param <C>   A sub-type of {@link Channel}