GUAC-236: Add missing documentation for screen recording parameters of VNC and 
RDP.


Project: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/repo
Commit: 
http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/commit/534d0e58
Tree: 
http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/tree/534d0e58
Diff: 
http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/diff/534d0e58

Branch: refs/heads/master
Commit: 534d0e580e4936def3cf1b5ed729c7fafde9ce7e
Parents: f5f77fe
Author: Michael Jumper <[email protected]>
Authored: Wed Mar 16 10:26:10 2016 -0700
Committer: Michael Jumper <[email protected]>
Committed: Wed Mar 16 10:26:10 2016 -0700

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


http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/blob/534d0e58/src/protocols/rdp/rdp_settings.c
----------------------------------------------------------------------
diff --git a/src/protocols/rdp/rdp_settings.c b/src/protocols/rdp/rdp_settings.c
index 0e90f4d..728c9a6 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

http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/blob/534d0e58/src/protocols/vnc/settings.c
----------------------------------------------------------------------
diff --git a/src/protocols/vnc/settings.c b/src/protocols/vnc/settings.c
index ffff562..c183906 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

Reply via email to