From eef1c1d84d536b9762a3c415469f3eb2f7329be6 Mon Sep 17 00:00:00 2001 From: Trustin Lee Date: Tue, 2 Sep 2008 13:27:40 +0000 Subject: [PATCH] More cross-referencing --- src/main/java/org/jboss/netty/channel/ChannelState.java | 2 +- .../java/org/jboss/netty/channel/ChannelStateEvent.java | 4 +++- .../org/jboss/netty/channel/ChildChannelStateEvent.java | 4 +++- src/main/java/org/jboss/netty/channel/ExceptionEvent.java | 6 ++++-- src/main/java/org/jboss/netty/channel/MessageEvent.java | 4 +++- 5 files changed, 14 insertions(+), 6 deletions(-) diff --git a/src/main/java/org/jboss/netty/channel/ChannelState.java b/src/main/java/org/jboss/netty/channel/ChannelState.java index 95d5c8000a..417e6627cb 100644 --- a/src/main/java/org/jboss/netty/channel/ChannelState.java +++ b/src/main/java/org/jboss/netty/channel/ChannelState.java @@ -25,7 +25,7 @@ package org.jboss.netty.channel; import java.net.SocketAddress; /** - * Represents the current or requested state of a {@link Channel}. + * Represents the current or future state of a {@link Channel}. *

* The state of a {@link Channel} is interpreted differently depending on the * {@linkplain ChannelStateEvent#getValue() value} of a {@link ChannelStateEvent} diff --git a/src/main/java/org/jboss/netty/channel/ChannelStateEvent.java b/src/main/java/org/jboss/netty/channel/ChannelStateEvent.java index 613aa7b30c..d6ad77c482 100644 --- a/src/main/java/org/jboss/netty/channel/ChannelStateEvent.java +++ b/src/main/java/org/jboss/netty/channel/ChannelStateEvent.java @@ -27,7 +27,9 @@ package org.jboss.netty.channel; * A {@link ChannelEvent} which represents the change of the {@link Channel} * state. It can mean the notification of a change or the request for a * change, depending on whether it is a upstream event or a downstream event - * respectively. + * respectively. Please refer to the {@link ChannelEvent} documentation to + * find out what a upstream event and a downstream event are and what + * fundamental differences they have. * * @author The Netty Project (netty-dev@lists.jboss.org) * @author Trustin Lee (tlee@redhat.com) diff --git a/src/main/java/org/jboss/netty/channel/ChildChannelStateEvent.java b/src/main/java/org/jboss/netty/channel/ChildChannelStateEvent.java index ee9efaabd1..891f7e2ffc 100644 --- a/src/main/java/org/jboss/netty/channel/ChildChannelStateEvent.java +++ b/src/main/java/org/jboss/netty/channel/ChildChannelStateEvent.java @@ -24,7 +24,9 @@ package org.jboss.netty.channel; /** * A {@link ChannelEvent} which represents the notification of the state of - * a child {@link Channel}. This event is allowed to go upstream only. + * a child {@link Channel}. This event is for going upstream only. Please + * refer to the {@link ChannelEvent} documentation to find out what a upstream + * event and a downstream event are and what fundamental differences they have. * * @author The Netty Project (netty-dev@lists.jboss.org) * @author Trustin Lee (tlee@redhat.com) diff --git a/src/main/java/org/jboss/netty/channel/ExceptionEvent.java b/src/main/java/org/jboss/netty/channel/ExceptionEvent.java index 3e5c60cc7f..6938b6c344 100644 --- a/src/main/java/org/jboss/netty/channel/ExceptionEvent.java +++ b/src/main/java/org/jboss/netty/channel/ExceptionEvent.java @@ -24,8 +24,10 @@ package org.jboss.netty.channel; /** * A {@link ChannelEvent} which represents the notification of an exception - * raised by a {@link ChannelHandler} or an I/O thread. This event is allowed - * to go upstream only. + * raised by a {@link ChannelHandler} or an I/O thread. This event is for + * going upstream only. Please refer to the {@link ChannelEvent} documentation + * to find out what a upstream event and a downstream event are and what + * fundamental differences they have. * * @author The Netty Project (netty-dev@lists.jboss.org) * @author Trustin Lee (tlee@redhat.com) diff --git a/src/main/java/org/jboss/netty/channel/MessageEvent.java b/src/main/java/org/jboss/netty/channel/MessageEvent.java index 47e35f415d..1cfc8cebb6 100644 --- a/src/main/java/org/jboss/netty/channel/MessageEvent.java +++ b/src/main/java/org/jboss/netty/channel/MessageEvent.java @@ -28,7 +28,9 @@ import java.net.SocketAddress; * A {@link ChannelEvent} which represents the transmission or reception of a * message. It can mean the notification of a received message or the request * for writing a message, depending on whether it is a upstream event or a - * downstream event respectively. + * downstream event respectively. Please refer to the {@link ChannelEvent} + * documentation to find out what a upstream event and a downstream event are + * and what fundamental differences they have. * * @author The Netty Project (netty-dev@lists.jboss.org) * @author Trustin Lee (tlee@redhat.com)