r19301@catbus: nickm | 2008-04-10 14:54:46 -0400

 Forward-port: Correct the documentation on evbuffer_add_[v]printf: Fix for bug 1914464.

svn:r705

diff --git a/ChangeLog b/ChangeLog
index a70f4d8c014198f9fb211ef286eabc2a66390d7e..fb87671e260416ee050e02bfeeb4e56a5defb864 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -62,7 +62,9 @@ Changes in current version:
  o make event methods static so that they are not exported; from Andrei Nigmatulin
  o make RPC replies use application/octet-stream as mime type
  o do not delete uninitialized timeout event in evdns
-       
+ o Correct the documentation on buffer printf functions.
+
+
 Changes in 1.4.0:
  o allow \r or \n individually to separate HTTP headers instead of the standard "\r\n"; from Charles Kerr.
  o demote most http warnings to debug messages

diff --git a/include/event2/buffer.h b/include/event2/buffer.h
index 09276538ebd06b166987b3e3494622544f2ca739..f6e0e247d1b092898ebea2f8ed44e6ca5a6e1b67 100644 (file)
--- a/include/event2/buffer.h
+++ b/include/event2/buffer.h
@@ -196,7 +196,8 @@ int evbuffer_add_buffer(struct evbuffer *outbuf, struct evbuffer *inbuf);
   @param buf the evbuffer that will be appended to
   @param fmt a format string
   @param ... arguments that will be passed to printf(3)
-  @return 0 if successful, or -1 if an error occurred
+  @return The number of bytes added if successful, or -1 if an error occurred.
+
  */
 int evbuffer_add_printf(struct evbuffer *buf, const char *fmt, ...)
 #ifdef __GNUC__
@@ -211,7 +212,7 @@ int evbuffer_add_printf(struct evbuffer *buf, const char *fmt, ...)
   @param buf the evbuffer that will be appended to
   @param fmt a format string
   @param ap a varargs va_list argument array that will be passed to vprintf(3)
-  @return 0 if successful, or -1 if an error occurred
+  @return The number of bytes added if successful, or -1 if an error occurred.
  */
 int evbuffer_add_vprintf(struct evbuffer *buf, const char *fmt, va_list ap);