improve the description of parameter to evbuffer_read()

azat · Sep 22, 2019 · 5aae74d · 5aae74d
1 parent 6769f69
commit 5aae74d
Showing 1 changed file with 2 additions and 1 deletion.
diff --git 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()
  */