Fixing documentation

Trustin Lee (이희승) trustin at gmail.com
Fri Oct 30 03:58:49 EDT 2009


I reviewed the Javadoc and refactored it to make it easier to
understand.  I did not deploy this update because it will be part of
3.2.0.ALPHA1 which is not released yet.  Here's the Javadoc anyway:

http://fisheye.jboss.org/browse/Netty/trunk/src/main/java/org/jboss/netty/channel/ChannelPipeline.java?r=1852
* Updated diagram
* Made the paragraph below the diagram more detailed.

http://fisheye.jboss.org/browse/Netty/trunk/src/main/java/org/jboss/netty/channel/ChannelEvent.java?r=1852
* Revised the first section to explain what 'downstream' and 'upstream' mean.
* Moved the event description tables from ChannelUpstreamHandler and
ChannelDownstreamHandler

Feed back appreciated

— Trustin Lee, http://gleamynode.net/

On Fri, Oct 30, 2009 at 3:34 PM, Trustin Lee (이희승) <trustin at gmail.com> wrote:
> In the IRC channel:
>
> <appel> Funny thing about documentation, it sometimes just ASSUMES
> that you know this basic knowledge. The pipeline graph is confusing
> also: http://www.jboss.org/file-access/default/members/netty/freezone/api/3.1/org/jboss/netty/channel/ChannelPipeline.html
>
> Please let me know WHAT the missing basic knowledge is.  Also, the
> pipeline graph could be improved if you give me more specific feed
> back.  Why does it confuse you?  Is it missing something or ..?
>
> I hope you read most hyperlinked Javadocs about the related types such
> as ChannelEvent and ChannelUpstream/DownstreamHandler.  If there's
> still some missing pieces, we can fill them in.
>
> — Trustin Lee, http://gleamynode.net/
>



More information about the netty-users mailing list