From f1ea6fb98f284bd08ec3d05c198a0c2ed5cdd44c Mon Sep 17 00:00:00 2001 From: Trustin Lee Date: Mon, 2 Dec 2013 18:58:56 +0900 Subject: [PATCH] Improve documentation for the two-args formatter in LoggingHandler --- .../src/main/java/io/netty/handler/logging/LoggingHandler.java | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/handler/src/main/java/io/netty/handler/logging/LoggingHandler.java b/handler/src/main/java/io/netty/handler/logging/LoggingHandler.java index 3971a1f3dc..73b1f778cd 100644 --- a/handler/src/main/java/io/netty/handler/logging/LoggingHandler.java +++ b/handler/src/main/java/io/netty/handler/logging/LoggingHandler.java @@ -329,7 +329,8 @@ public class LoggingHandler extends ChannelHandlerAdapter { } /** - * 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