aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorAris Adamantiadis <aris@0xbadc0de.be>2010-07-23 08:09:57 +0200
committerAris Adamantiadis <aris@0xbadc0de.be>2010-07-23 08:09:57 +0200
commit5aa9cf2fcf3fc062f4560df52e3d48d894e0ba6e (patch)
treee915591576d8c3ac2d450ed078344d5b4a5f2a24 /include
parenta9248690961b96aafb9065916f4263ff6ba48c0c (diff)
downloadlibssh-5aa9cf2fcf3fc062f4560df52e3d48d894e0ba6e.tar.gz
libssh-5aa9cf2fcf3fc062f4560df52e3d48d894e0ba6e.tar.xz
libssh-5aa9cf2fcf3fc062f4560df52e3d48d894e0ba6e.zip
Add consistency check to ssh_set_callbacks
Diffstat (limited to 'include')
-rw-r--r--include/libssh/callbacks.h2
-rw-r--r--include/libssh/legacy.h2
2 files changed, 3 insertions, 1 deletions
diff --git a/include/libssh/callbacks.h b/include/libssh/callbacks.h
index 3ceb385..589c0ae 100644
--- a/include/libssh/callbacks.h
+++ b/include/libssh/callbacks.h
@@ -244,7 +244,7 @@ typedef struct ssh_packet_callbacks_struct *ssh_packet_callbacks;
*
* @param cb The callback itself.
*
- * @return 0 on success, < 0 on error.
+ * @return SSH_OK on success, SSH_ERROR on error.
*/
LIBSSH_API int ssh_set_callbacks(ssh_session session, ssh_callbacks cb);
diff --git a/include/libssh/legacy.h b/include/libssh/legacy.h
index 33ed357..7d2d582 100644
--- a/include/libssh/legacy.h
+++ b/include/libssh/legacy.h
@@ -22,6 +22,8 @@
/* Since libssh.h includes legacy.h, it's important that libssh.h is included
* first. we don't define LEGACY_H now because we want it to be defined when
* included from libssh.h
+ * All function calls declared in this header are deprecated and meant to be
+ * removed in future.
*/
#include "libssh/libssh.h"