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

This commit is contained in:
Michael Jumper 2016-03-16 10:26:10 -07:00
parent f5f77fea35
commit 534d0e580e
2 changed files with 28 additions and 0 deletions

View File

@ -356,8 +356,22 @@ enum RDP_ARGS_IDX {
#endif #endif
/**
* The full absolute path to the directory in which screen recordings
* should be written.
*/
IDX_RECORDING_PATH, IDX_RECORDING_PATH,
/**
* The name that should be given to screen recording which are written in
* the given path.
*/
IDX_RECORDING_NAME, IDX_RECORDING_NAME,
/**
* Whether the specified screen recording path should automatically be
* created if it does not yet exist.
*/
IDX_CREATE_RECORDING_PATH, IDX_CREATE_RECORDING_PATH,
RDP_ARGS_COUNT RDP_ARGS_COUNT

View File

@ -232,8 +232,22 @@ enum VNC_ARGS_IDX {
IDX_SFTP_DIRECTORY, IDX_SFTP_DIRECTORY,
#endif #endif
/**
* The full absolute path to the directory in which screen recordings
* should be written.
*/
IDX_RECORDING_PATH, IDX_RECORDING_PATH,
/**
* The name that should be given to screen recording which are written in
* the given path.
*/
IDX_RECORDING_NAME, IDX_RECORDING_NAME,
/**
* Whether the specified screen recording path should automatically be
* created if it does not yet exist.
*/
IDX_CREATE_RECORDING_PATH, IDX_CREATE_RECORDING_PATH,
VNC_ARGS_COUNT VNC_ARGS_COUNT