From 3a4aec3708c2040d105e5c4808c983d07ce80988 Mon Sep 17 00:00:00 2001
From: Michael Jumper <mike.jumper@guac-dev.org>
Date: Mon, 14 Mar 2016 18:32:03 -0700
Subject: [PATCH] GUAC-1389: Document parameters of SSH client thread.

---
 src/protocols/ssh/ssh.h | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/protocols/ssh/ssh.h b/src/protocols/ssh/ssh.h
index 7611d0f2..a773fe44 100644
--- a/src/protocols/ssh/ssh.h
+++ b/src/protocols/ssh/ssh.h
@@ -100,6 +100,14 @@ typedef struct guac_ssh_client {
 
 /**
  * Main SSH client thread, handling transfer of SSH output to STDOUT.
+ *
+ * @param data
+ *     The guac_client to associate with a new SSH session, once the SSH
+ *     connection succeeds.
+ *
+ * @return
+ *     NULL in all cases. The return value of this thread is expected to be
+ *     ignored.
  */
 void* ssh_client_thread(void* data);