Slightly clarify evbuffer_peek documentation

diff --git a/include/event2/buffer.h b/include/event2/buffer.h
index d28cd2dcca5cd8e6a89d3e91c3a3643339915609..3296356841251884c35aa2c38b8e62afd32a9399 100644 (file)
--- a/include/event2/buffer.h
+++ b/include/event2/buffer.h
@@ -626,8 +626,10 @@ struct evbuffer_ptr evbuffer_search_eol(struct evbuffer *buffer,
     the buffer does not have as much data as you asked to see).
 
     @param buffer the evbuffer to peek into,
-    @param len the number of bytes to try to peek.  If negative, we
-       will try to fill as much of vec_out as we can.
+    @param len the number of bytes to try to peek.  If len is negative, we
+       will try to fill as much of vec_out as we can.  If len is negative
+       and vec_out is not provided, we return the number of evbuffer_iovecs
+       that would be needed to get all the data in the buffer.
     @param start_at an evbuffer_ptr indicating the point at which we
        should start looking for data.  NULL means, "At the start of the
        buffer."