From 89853607c565cdee4638ce2d026d8a5575fa8978 Mon Sep 17 00:00:00 2001
From: Andreas Schneider <asn@cryptomilk.org>
Date: Mon, 16 Sep 2013 10:33:14 +0200
Subject: session: Document return value of ssh_get_serverbanner().

BUG: https://red.libssh.org/issues/122
---
 src/session.c | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'src')

diff --git a/src/session.c b/src/session.c
index 0946f4e3..2d6d09e3 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) {
-- 
cgit v1.2.3