From 4c62b60f714841d55e7ecbe731667bf9b7b3bf02 Mon Sep 17 00:00:00 2001
From: Michael Jumper <mike.jumper@guac-dev.org>
Date: Thu, 3 Mar 2016 11:58:21 -0800
Subject: [PATCH] GUAC-1389: Document VNC password retrieval.

---
 src/protocols/vnc/auth.h | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/src/protocols/vnc/auth.h b/src/protocols/vnc/auth.h
index bb716c9e..24a61ef7 100644
--- a/src/protocols/vnc/auth.h
+++ b/src/protocols/vnc/auth.h
@@ -29,7 +29,15 @@
 #include <rfb/rfbproto.h>
 
 /**
- * Handler which returns the configured password.
+ * Callback which is invoked by libVNCServer when it needs to read the user's
+ * VNC password. As ths user's password, if any, will be stored in the
+ * connection settings, this function does nothing more than return that value.
+ *
+ * @param client
+ *     The rfbClient associated with the VNC connection requiring the password.
+ *
+ * @return
+ *     The password to provide to the VNC server.
  */
 char* guac_vnc_get_password(rfbClient* client);