diff --git a/src/protocols/vnc/auth.h b/src/protocols/vnc/auth.h index bb716c9e..24a61ef7 100644 --- a/src/protocols/vnc/auth.h +++ b/src/protocols/vnc/auth.h @@ -29,7 +29,15 @@ #include /** - * Handler which returns the configured password. + * Callback which is invoked by libVNCServer when it needs to read the user's + * VNC password. As ths user's password, if any, will be stored in the + * connection settings, this function does nothing more than return that value. + * + * @param client + * The rfbClient associated with the VNC connection requiring the password. + * + * @return + * The password to provide to the VNC server. */ char* guac_vnc_get_password(rfbClient* client);