Mark channel_read_buffer as deprecated in doxygen

This commit is contained in:
Aris Adamantiadis
2010-08-29 00:12:01 +02:00
parent bf9a82ad9a
commit b30aff6d4d

View File

@@ -1948,10 +1948,6 @@ error:
} }
/* TODO : fix the delayed close thing */
/* TODO : fix the blocking behaviours */
/** /**
* @brief Read data from a channel into a buffer. * @brief Read data from a channel into a buffer.
* *
@@ -1967,6 +1963,8 @@ error:
* *
* @return The number of bytes read, 0 on end of file or SSH_ERROR * @return The number of bytes read, 0 on end of file or SSH_ERROR
* on error. * on error.
* @deprecated Please use ssh_channel_read instead
* @see ssh_channel_read
*/ */
int channel_read_buffer(ssh_channel channel, ssh_buffer buffer, uint32_t count, int channel_read_buffer(ssh_channel channel, ssh_buffer buffer, uint32_t count,
int is_stderr) { int is_stderr) {