From f5109fe34e3268ea2c874ce10bf6c41be0cc3cdd Mon Sep 17 00:00:00 2001
From: Michael Jumper <mike.jumper@guac-dev.org>
Date: Thu, 3 Mar 2016 12:30:31 -0800
Subject: [PATCH] GUAC-1389: Document logging functions.

---
 src/protocols/vnc/log.h | 19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

diff --git a/src/protocols/vnc/log.h b/src/protocols/vnc/log.h
index e3ca2447..3aa3ae4f 100644
--- a/src/protocols/vnc/log.h
+++ b/src/protocols/vnc/log.h
@@ -43,12 +43,27 @@
 #include <syslog.h>
 
 /**
- * Log handler for informational messages from the VNC client library.
+ * Callback invoked by libVNCServer when an informational message needs to be
+ * logged.
+ *
+ * @param format
+ *     A printf-style format string to log.
+ *
+ * @param ...
+ *     The values to use when filling the conversion specifiers within the
+ *     format string.
  */
 void guac_vnc_client_log_info(const char* format, ...);
 
 /**
- * Log handler for error messages from the VNC client library.
+ * Callback invoked by libVNCServer when an error message needs to be logged.
+ *
+ * @param format
+ *     A printf-style format string to log.
+ *
+ * @param ...
+ *     The values to use when filling the conversion specifiers within the
+ *     format string.
  */
 void guac_vnc_client_log_error(const char* format, ...);