diff options
| author | Alan Dunn <amdunn@gmail.com> | 2014-01-21 13:29:29 -0600 |
|---|---|---|
| committer | Andreas Schneider <asn@cryptomilk.org> | 2014-01-22 09:46:00 +0100 |
| commit | 15bede0c0e03b4065fc8a156f11f1d1d87f0e7e8 (patch) | |
| tree | decd0f4ceb33a0a0e52c56feb80b906a6fa59dcb | |
| parent | 92dde09a37f6eb35839fb26b36093ddc05439ed7 (diff) | |
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 <amdunn@gmail.com>
Reviewed-by: Andreas Schneider <asn@cryptomilk.org>
| -rw-r--r-- | src/error.c | 4 |
1 files changed, 2 insertions, 2 deletions
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 |