From 7eff8893847270da1e05300d7c26734d04c0b375 Mon Sep 17 00:00:00 2001 From: Alan Dunn Date: Tue, 21 Jan 2014 13:29:29 -0600 Subject: doc: Fix description of error parameter for ssh_get_error* ssh_get_error can actually work on anything with an ssh_common_struct as its first member. It is already used in examples in the distribution with ssh_sessions and ssh_binds. Signed-off-by: Alan Dunn Reviewed-by: Andreas Schneider --- src/error.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'src') diff --git a/src/error.c b/src/error.c index fbe0e787..bd755c4f 100644 --- a/src/error.c +++ b/src/error.c @@ -104,7 +104,7 @@ void _ssh_set_error_invalid(void *error, const char *function) /** * @brief Retrieve the error text message from the last error. * - * @param error The SSH session pointer. + * @param error An ssh_session or ssh_bind. * * @return A static string describing the error. */ @@ -117,7 +117,7 @@ const char *ssh_get_error(void *error) { /** * @brief Retrieve the error code from the last error. * - * @param error The SSH session pointer. + * @param error An ssh_session or ssh_bind. * * \return SSH_NO_ERROR No error occurred\n * SSH_REQUEST_DENIED The last request was denied but situation is -- cgit