From fb6ce4989a9c572c3423707153c42412c902810c Mon Sep 17 00:00:00 2001
From: Norman Maurer <nmaurer@redhat.com>
Date: Fri, 26 Oct 2012 22:38:06 +0200
Subject: [PATCH] Javadoc fixes

---
 .../java/io/netty/handler/ssl/SslHandler.java   | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/handler/src/main/java/io/netty/handler/ssl/SslHandler.java b/handler/src/main/java/io/netty/handler/ssl/SslHandler.java
index b60bb76765..2462ef0100 100644
--- a/handler/src/main/java/io/netty/handler/ssl/SslHandler.java
+++ b/handler/src/main/java/io/netty/handler/ssl/SslHandler.java
@@ -277,6 +277,10 @@ public class SslHandler
         return engine;
     }
 
+    /**
+     * Starts the SSL / TLS handshake and returns a {@link ChannelFuture} that will
+     * get notified once the handshake completes.
+     */
     public ChannelFuture handshake() {
         return handshake(ctx.newFuture());
     }
@@ -340,6 +344,11 @@ public class SslHandler
         return close(ctx.newFuture());
     }
 
+
+    /**
+     * See {@link #close()}
+
+     */
     public ChannelFuture close(final ChannelFuture future) {
         final ChannelHandlerContext ctx = this.ctx;
         ctx.executor().execute(new Runnable() {
@@ -856,6 +865,9 @@ public class SslHandler
         }
     }
 
+    /**
+     * Notify all the handshake futures about the successfully handshake
+     */
     private void setHandshakeSuccess() {
         for (;;) {
             ChannelFuture f = handshakeFutures.poll();
@@ -866,6 +878,9 @@ public class SslHandler
         }
     }
 
+    /**
+     * Notify all the handshake futures about the failure during the handshake.
+     */
     private void setHandshakeFailure(Throwable cause) {
         // Release all resources such as internal buffers that SSLEngine
         // is managing.
@@ -967,7 +982,7 @@ public class SslHandler
                 @Override
                 public void run() {
                     logger.warn(
-                            ctx.channel() + " last lssssswrite attempt timed out." +
+                            ctx.channel() + " last write attempt timed out." +
                                             " Force-closing the connection.");
                     ctx.close(closeFuture);
                 }