From b169ea0f6e6968cd21e52f2e8538589eb379993b Mon Sep 17 00:00:00 2001
From: Michael Jumper <mike.jumper@guac-dev.org>
Date: Wed, 2 Mar 2016 16:32:09 -0800
Subject: [PATCH] GUAC-1389: Document creation of SSL-wrapped guac_socket.

---
 src/guacd/socket-ssl.h | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/src/guacd/socket-ssl.h b/src/guacd/socket-ssl.h
index e1cdc804..7af9c2f5 100644
--- a/src/guacd/socket-ssl.h
+++ b/src/guacd/socket-ssl.h
@@ -56,6 +56,17 @@ typedef struct guac_socket_ssl_data {
 /**
  * Creates a new guac_socket which will use SSL for all communication. Freeing
  * this guac_socket will automatically close the associated file descriptor.
+ *
+ * @param context
+ *     The SSL_CTX structure describing the desired SSL configuration.
+ *
+ * @param fd
+ *     The file descriptor to use for the SSL connection underlying the
+ *     created guac_socket.
+ *
+ * @return
+ *     A newly-allocated guac_socket which will transparently use SSL for
+ *     all communication.
  */
 guac_socket* guac_socket_open_secure(SSL_CTX* context, int fd);