document _libssh2_channel_write's return code

2009-08-30 19:46:42 +02:00
parent 5bb1fb5cbc
commit 692401633a
1 changed files with 2 additions and 1 deletions
--- a/src/channel.c
+++ b/src/channel.c
@@ -1937,7 +1937,8 @@ _libssh2_channel_packet_data_len(LIBSSH2_CHANNEL * channel, int stream_id)
 * send the entire packet, the caller must call this function again with the
 * SAME input arguments.
 *
- * If it returns a negative number, that is the error code!
+ * Returns: number of bytes sent, or if it returns a negative number, that is
+ * the error code!
 */
 ssize_t
 _libssh2_channel_write(LIBSSH2_CHANNEL *channel, int stream_id,