Merge pull request #126 from glyptodon/recording-docs

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

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 recordings 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

src/protocols/ssh/settings.c

@@ -150,7 +150,7 @@ enum SSH_ARGS_IDX {
     IDX_RECORDING_PATH,
 
     /**
-     * The name that should be given to screen recording which are written in
+     * The name that should be given to screen recordings which are written in
      * the given path.
      */
     IDX_RECORDING_NAME,

src/protocols/telnet/settings.c

@@ -130,7 +130,7 @@ enum TELNET_ARGS_IDX {
     IDX_RECORDING_PATH,
 
     /**
-     * The name that should be given to screen recording which are written in
+     * The name that should be given to screen recordings which are written in
      * the given path.
      */
     IDX_RECORDING_NAME,

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 recordings 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