improve the description of parameter to evbuffer_read()

1 files changed, 2 insertions, 1 deletions

diff --git a/include/event2/buffer.h b/include/event2/buffer.h
index 1fb30eca..a9afc3c6 100644
--- a/include/event2/buffer.h
+++ b/include/event2/buffer.h
@@ -748,7 +748,8 @@ int evbuffer_write_atmost(struct evbuffer *buffer, evutil_socket_t fd,
 
   @param buffer the evbuffer to store the result
   @param fd the file descriptor to read from
-  @param howmuch the number of bytes to be read
+  @param howmuch the number of bytes to be read. If the given number is negative
+  or out of maximum bytes per one read, as many bytes as we can will be read.
   @return the number of bytes read, or -1 if an error occurred
   @see evbuffer_write()
  */