[PATCH] doc: Document expected return value of channel data callback

[Audrius Butkevicius <audrius.butkevicius@xxxxxxxxxxxxxxxx>]

Hi,

A tiny patch to improve the docs, as I have managed to trip on this.

Regards,
Audrius.

From fda25e1a8918eb1da459d567e1bab65177ccfd6e Mon Sep 17 00:00:00 2001
From: Audrius Butkevicius <audrius.butkevicius@xxxxxxxxx>
Date: Sun, 26 Jan 2014 03:16:36 +0000
Subject: [PATCH] doc: Document expected return value of channel data callback


Signed-off-by: Audrius Butkevicius <audrius.butkevicius@xxxxxxxxx>
---
 include/libssh/callbacks.h |    2 ++
 1 files changed, 2 insertions(+), 0 deletions(-)

diff --git a/include/libssh/callbacks.h b/include/libssh/callbacks.h
index 9aa8bab..6bd8c57 100644
--- a/include/libssh/callbacks.h
+++ b/include/libssh/callbacks.h
@@ -495,6 +495,8 @@ LIBSSH_API int ssh_set_callbacks(ssh_session session, ssh_callbacks cb);
  * @param len the length of the data
  * @param is_stderr is 0 for stdout or 1 for stderr
  * @param userdata Userdata to be passed to the callback function.
+ * @returns number of bytes processed by the callee. The remaining bytes will
+ * be sent in the next callback message, when more data is available.
  */
 typedef int (*ssh_channel_data_callback) (ssh_session session,
                                            ssh_channel channel,
-- 
1.7.2.5