Javadoc

src/main/java/org/jboss/netty/channel/ChannelPipelineFactory.java

@@ -26,8 +26,8 @@ package org.jboss.netty.channel;
  * Creates a new {@link ChannelPipeline} for a new {@link Channel}.
  * <p>
  * This interface was introduced to initialize the {@link ChannelPipeline} of
- * the child channel accepted by a server-side, but it is safe to use it for
- * any other purposes.
+ * the child channel accepted by a {@link ServerChannel}, but it is safe to use
+ * it for any other purposes.
  *
  * @author The Netty Project (netty-dev@lists.jboss.org)
  * @author Trustin Lee (tlee@redhat.com)

src/main/java/org/jboss/netty/channel/Channels.java

@@ -41,8 +41,6 @@ import java.util.Map;
  * <li>{@link #pipelineFactory(ChannelPipeline)}</li>
  * <li>{@link #succeededFuture(Channel)}</li>
  * <li>{@link #failedFuture(Channel, Throwable)}</li>
- * <li>{@link #messageEvent(Channel, ChannelFuture, Object)}</li>
- * <li>{@link #messageEvent(Channel, ChannelFuture, Object, SocketAddress)}</li>
  * </ul>
  *
  * <h3>Upstream and downstream event generation</h3>

src/main/java/org/jboss/netty/channel/DownstreamChannelStateEvent.java

@@ -23,7 +23,7 @@
 package org.jboss.netty.channel;
 
 /**
- * The default {@link ChannelStateEvent} implementation.
+ * The default downstream {@link ChannelStateEvent} implementation.
  *
  * @author The Netty Project (netty-dev@lists.jboss.org)
  * @author Trustin Lee (tlee@redhat.com)

src/main/java/org/jboss/netty/channel/DownstreamMessageEvent.java

@@ -27,7 +27,7 @@ import java.net.SocketAddress;
 import org.jboss.netty.util.internal.StringUtil;
 
 /**
- * The default {@link MessageEvent} implementation.
+ * The default downstream {@link MessageEvent} implementation.
  *
  * @author The Netty Project (netty-dev@lists.jboss.org)
  * @author Trustin Lee (tlee@redhat.com)

src/main/java/org/jboss/netty/channel/FixedReceiveBufferSizePredictor.java

@@ -25,7 +25,7 @@ package org.jboss.netty.channel;
 
 /**
  * The {@link ReceiveBufferSizePredictor} that always yields the same buffer
- * size prediction.
+ * size prediction.  This predictor ignores the feed back from the I/O thread.
  *
  * @author The Netty Project (netty-dev@lists.jboss.org)
  * @author Trustin Lee (tlee@redhat.com)

src/main/java/org/jboss/netty/channel/ReceiveBufferSizePredictor.java

@@ -34,8 +34,8 @@ import org.jboss.netty.buffer.ChannelBuffer;
  * effective the memory utilization will be.
  * <p>
  * Once a read operation is performed and the actual number of read bytes is
- * known, an I/O thread should call {@link #previousReceiveBufferSize(int)} to
- * update the predictor so it can predict more accurately.
+ * known, an I/O thread will call {@link #previousReceiveBufferSize(int)} to
+ * update the predictor so it can predict more accurately next time.
  *
  * @author The Netty Project (netty-dev@lists.jboss.org)
  * @author Trustin Lee (tlee@redhat.com)

src/main/java/org/jboss/netty/channel/ServerChannel.java

@@ -22,11 +22,17 @@
  */
 package org.jboss.netty.channel;
 
+import org.jboss.netty.channel.socket.ServerSocketChannel;
+
 /**
+ * A {@link Channel} that accepts an incoming connection attempt and creates
+ * its child {@link Channel}s by accepting them.  {@link ServerSocketChannel} is
+ * a good example.
+ *
  * @author The Netty Project (netty-dev@lists.jboss.org)
  * @author Trustin Lee (tlee@redhat.com)
  * @version $Rev$, $Date$
  */
-public interface ServerChannel extends Channel{
+public interface ServerChannel extends Channel {
     // This is a tag interface.
 }

src/main/java/org/jboss/netty/channel/ServerChannelFactory.java

@@ -22,9 +22,9 @@
  */
 package org.jboss.netty.channel;
 
-
-
 /**
+ * A {@link ChannelFactory} that creates a {@link ServerChannel}.
+ *
  * @author The Netty Project (netty-dev@lists.jboss.org)
  * @author Trustin Lee (tlee@redhat.com)
  *

src/main/java/org/jboss/netty/channel/UpstreamChannelStateEvent.java

@@ -25,7 +25,7 @@ package org.jboss.netty.channel;
 import static org.jboss.netty.channel.Channels.*;
 
 /**
- * The default {@link ChannelStateEvent} implementation.
+ * The default upstream {@link ChannelStateEvent} implementation.
  *
  * @author The Netty Project (netty-dev@lists.jboss.org)
  * @author Trustin Lee (tlee@redhat.com)

src/main/java/org/jboss/netty/channel/UpstreamMessageEvent.java

@@ -29,7 +29,7 @@ import java.net.SocketAddress;
 import org.jboss.netty.util.internal.StringUtil;
 
 /**
- * The default {@link MessageEvent} implementation.
+ * The default upstream {@link MessageEvent} implementation.
  *
  * @author The Netty Project (netty-dev@lists.jboss.org)
  * @author Trustin Lee (tlee@redhat.com)