Improve documentation for the two-args formatter in LoggingHandler

2013-12-02 18:58:56 +09:00 · 2013-12-02 18:58:56 +09:00 · 3d874f0bd7
commit 3d874f0bd7
parent fbed62249c
1 changed files with 2 additions and 1 deletions
--- a/handler/src/main/java/io/netty/handler/logging/LoggingHandler.java
+++ b/handler/src/main/java/io/netty/handler/logging/LoggingHandler.java
@ -334,7 +334,8 @@ public class LoggingHandler extends ChannelDuplexHandler {
    }

    /**
-     * Formats an event and returns the formatted message.
+     * Formats an event and returns the formatted message.  This method is currently only used for formatting
+     * {@link ChannelHandler#connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise)}.
     *
     * @param eventName the name of the event
     * @param firstArg  the first argument of the event