aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAris Adamantiadis <aris@0xbadc0de.be>2009-11-09 13:24:47 +0100
committerAris Adamantiadis <aris@0xbadc0de.be>2009-11-09 13:24:47 +0100
commit30266f76273ce99f0d8be688f8d51e2f40d2598a (patch)
tree6e65d45602086f9506c0e92a56e941cec7e28fd6
parent10b625e18030144f30a68556321a4c3d11fa7e25 (diff)
downloadlibssh-30266f76273ce99f0d8be688f8d51e2f40d2598a.tar.gz
libssh-30266f76273ce99f0d8be688f8d51e2f40d2598a.tar.xz
libssh-30266f76273ce99f0d8be688f8d51e2f40d2598a.zip
Added explanation in ssh_silent_disconnect doxygen
-rw-r--r--libssh/session.c3
1 files changed, 2 insertions, 1 deletions
diff --git a/libssh/session.c b/libssh/session.c
index a06c4f68..a3e2ed85 100644
--- a/libssh/session.c
+++ b/libssh/session.c
@@ -174,7 +174,8 @@ void ssh_free(ssh_session session) {
SAFE_FREE(session);
}
-/** \brief disconnect impolitely from remote host
+/** \brief disconnect impolitely from remote host by closing the socket.
+ * Suitable if you forked and want to destroy this session.
* \param session current ssh session
*/
void ssh_silent_disconnect(ssh_session session) {