summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndreas Schneider <asn@cryptomilk.org>2013-09-16 10:33:14 +0200
committerAndreas Schneider <asn@cryptomilk.org>2013-09-16 10:38:14 +0200
commit89853607c565cdee4638ce2d026d8a5575fa8978 (patch)
treefabffeed5a7be7eaa9e99d9e9c815241a8ca8f3b
parent20658abc78e908ec704809c2f3a140c4e26e9ef8 (diff)
downloadlibssh-89853607c565cdee4638ce2d026d8a5575fa8978.tar.gz
libssh-89853607c565cdee4638ce2d026d8a5575fa8978.tar.xz
libssh-89853607c565cdee4638ce2d026d8a5575fa8978.zip
session: Document return value of ssh_get_serverbanner().
BUG: https://red.libssh.org/issues/122
-rw-r--r--src/session.c3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/session.c b/src/session.c
index 0946f4e..2d6d09e 100644
--- a/src/session.c
+++ b/src/session.c
@@ -268,7 +268,10 @@ void ssh_free(ssh_session session) {
/**
* @brief get the server banner
+ *
* @param[in] session The SSH session
+ *
+ * @return Returns the server banner string or NULL.
*/
const char* ssh_get_serverbanner(ssh_session session) {
if(!session) {