Documentation patch: Fix description for ssh_get_error*

[Alan Dunn <amdunn@xxxxxxxxx>]

Hi folks,

I noticed the documentation for ssh_get_error* seems to be slightly off.  I
wrote a patch fixing it, which is attached.

Thanks,
- Alan

From 0cf30af8afce8854fd2db9620680e11b9530cb86 Mon Sep 17 00:00:00 2001
From: Alan Dunn <amdunn@xxxxxxxxx>
Date: Tue, 21 Jan 2014 13:29:29 -0600
Subject: [PATCH] doc: Fix description of error parameter for ssh_get_error*
To: libssh@xxxxxxxxxx

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@xxxxxxxxx>
---
 src/error.c |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/error.c b/src/error.c
index fbe0e78..bd755c4 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
-- 
1.7.9.5