GUACAMOLE-547: Document return value of credential handler.

2019-06-18 17:59:33 -04:00 · 2019-06-18 17:59:33 -04:00 · 22874e2388
commit 22874e2388
parent 3511991e2f
1 changed files with 3 additions and 0 deletions
--- a/src/common-ssh/common-ssh/ssh.h
+++ b/src/common-ssh/common-ssh/ssh.h
@ -36,6 +36,9 @@
 *     The name of the credential being requested, which will be shared
 *     with the client in order to generate a meaningful prompt.
 * 
+ * @return
+ *     The credential provided by the user, which should be a dynamically-
+ *     allocated such that it can be freed as required.
 */
 typedef char* guac_ssh_credential_handler(guac_client* client, char* cred_name);