From 77a88811f1963bc5301c20f43c7bd8037f8849c7 Mon Sep 17 00:00:00 2001 From: Aris Adamantiadis Date: Fri, 7 Mar 2008 03:07:39 +0000 Subject: change doxygen doc for channel_poll git-svn-id: svn+ssh://svn.berlios.de/svnroot/repos/libssh/trunk@145 7dcaeef0-15fb-0310-b436-a5af3365683c --- libssh/channels.c | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'libssh') diff --git a/libssh/channels.c b/libssh/channels.c index a961c7a..ffcac46 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){ -- cgit