GUAC-1389: Document parameters of SSH client thread.

This commit is contained in:
Michael Jumper 2016-03-14 18:32:03 -07:00
parent fa43a94e02
commit 3a4aec3708

View File

@ -100,6 +100,14 @@ typedef struct guac_ssh_client {
/** /**
* Main SSH client thread, handling transfer of SSH output to STDOUT. * 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); void* ssh_client_thread(void* data);