aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Schneider <asn@cryptomilk.org>2012-02-19 13:13:59 +0100
committerAndreas Schneider <asn@cryptomilk.org>2012-02-19 13:25:22 +0100
commit72001ff8cc119da36ffc2d33228d45c57c92b7a5 (patch)
tree3cb44df11965e9fb427c76bab3be9651a63d66aa
parentb7507fc85e588c51fde7eacf3dc5dc5197562416 (diff)
downloadlibssh-72001ff8cc119da36ffc2d33228d45c57c92b7a5.tar.gz
libssh-72001ff8cc119da36ffc2d33228d45c57c92b7a5.tar.xz
libssh-72001ff8cc119da36ffc2d33228d45c57c92b7a5.zip
auth: Improve doc of ssh_userauth_kbdint_getprompt().
-rw-r--r--src/auth.c14
1 files changed, 11 insertions, 3 deletions
diff --git a/src/auth.c b/src/auth.c
index fb7c234..2432f9e 100644
--- a/src/auth.c
+++ b/src/auth.c
@@ -1979,11 +1979,19 @@ const char *ssh_userauth_kbdint_getinstruction(ssh_session session) {
*
* @param[in] i The index number of the i'th prompt.
*
- * @param[in] echo When different of NULL, it will obtain a boolean meaning
- * that the resulting user input should be echoed or not
- * (like passwords).
+ * @param[out] echo This is an optional variable. You can obtain a
+ * boolean if the user input should be echoed or
+ * hidden. For passwords it is usually hidden.
*
* @returns A pointer to the prompt. Do not free it.
+ *
+ * @code
+ * const char prompt;
+ * char echo;
+ *
+ * prompt = ssh_userauth_kbdint_getprompt(session, 0, &echo);
+ * if (echo) ...
+ * @endcode
*/
const char *ssh_userauth_kbdint_getprompt(ssh_session session, unsigned int i,
char *echo) {