From 534d0e580e4936def3cf1b5ed729c7fafde9ce7e Mon Sep 17 00:00:00 2001
From: Michael Jumper <mike.jumper@guac-dev.org>
Date: Wed, 16 Mar 2016 10:26:10 -0700
Subject: [PATCH] GUAC-236: Add missing documentation for screen recording
 parameters of VNC and RDP.

---
 src/protocols/rdp/rdp_settings.c | 14 ++++++++++++++
 src/protocols/vnc/settings.c     | 14 ++++++++++++++
 2 files changed, 28 insertions(+)

diff --git a/src/protocols/rdp/rdp_settings.c b/src/protocols/rdp/rdp_settings.c
index 0e90f4dc..728c9a64 100644
--- a/src/protocols/rdp/rdp_settings.c
+++ b/src/protocols/rdp/rdp_settings.c
@@ -356,8 +356,22 @@ enum RDP_ARGS_IDX {
 
 #endif
 
+    /**
+     * The full absolute path to the directory in which screen recordings
+     * should be written.
+     */
     IDX_RECORDING_PATH,
+
+    /**
+     * The name that should be given to screen recording which are written in
+     * the given path.
+     */
     IDX_RECORDING_NAME,
+
+    /**
+     * Whether the specified screen recording path should automatically be
+     * created if it does not yet exist.
+     */
     IDX_CREATE_RECORDING_PATH,
 
     RDP_ARGS_COUNT
diff --git a/src/protocols/vnc/settings.c b/src/protocols/vnc/settings.c
index ffff5623..c1839069 100644
--- a/src/protocols/vnc/settings.c
+++ b/src/protocols/vnc/settings.c
@@ -232,8 +232,22 @@ enum VNC_ARGS_IDX {
     IDX_SFTP_DIRECTORY,
 #endif
 
+    /**
+     * The full absolute path to the directory in which screen recordings
+     * should be written.
+     */
     IDX_RECORDING_PATH,
+
+    /**
+     * The name that should be given to screen recording which are written in
+     * the given path.
+     */
     IDX_RECORDING_NAME,
+
+    /**
+     * Whether the specified screen recording path should automatically be
+     * created if it does not yet exist.
+     */
     IDX_CREATE_RECORDING_PATH,
 
     VNC_ARGS_COUNT