diff options
author | Aris Adamantiadis <aris@0xbadc0de.be> | 2008-03-07 03:07:39 +0000 |
---|---|---|
committer | Aris Adamantiadis <aris@0xbadc0de.be> | 2008-03-07 03:07:39 +0000 |
commit | 77a88811f1963bc5301c20f43c7bd8037f8849c7 (patch) | |
tree | 077204aaf31dd413cef2aa3966a16edf28c3f882 | |
parent | 99cfb696107efe1be5f1db3732810b1e795d21d1 (diff) | |
download | libssh-77a88811f1963bc5301c20f43c7bd8037f8849c7.tar.gz libssh-77a88811f1963bc5301c20f43c7bd8037f8849c7.tar.xz libssh-77a88811f1963bc5301c20f43c7bd8037f8849c7.zip |
change doxygen doc for channel_poll
git-svn-id: svn+ssh://svn.berlios.de/svnroot/repos/libssh/trunk@145 7dcaeef0-15fb-0310-b436-a5af3365683c
-rw-r--r-- | libssh/channels.c | 3 |
1 files changed, 1 insertions, 2 deletions
diff --git a/libssh/channels.c b/libssh/channels.c index a961c7a7..ffcac465 100644 --- a/libssh/channels.c +++ b/libssh/channels.c @@ -805,8 +805,7 @@ int channel_read(CHANNEL *channel, BUFFER *buffer,int bytes,int is_stderr){ * \return number of bytes available for reading\n * 0 if nothing is available\n * SSH_ERROR on error - * \warning don't forget to check for EOF as it would - * return 0 here + * \warning When the channel is in EOF state, the function returns 1 * \see channel_is_eof() */ int channel_poll(CHANNEL *channel, int is_stderr){ |