small improvements to evhttp documentation

svn:r562

diff --git a/ChangeLog b/ChangeLog
index a607749f66ad39c9904048f68e4848aac40bc502..8c993cfc85c8b7b01e0a6f22bc18bc9106f3bc52 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -15,6 +15,7 @@ Changes in current version:
  o Do not mangle socket handles on 64-bit windows.
  o The configure script now takes an --enable-gcc-warnigns option that turns on many optional gcc warnings.  (Nick has been building with these for a while, but they might be useful to other developers.)
  o move EV_PERSIST handling out of the event backends
+ o small improvements to evhttp documentation
 
 
 Changes in 1.4.0:

diff --git a/evhttp.h b/evhttp.h
index a5bf73edfe13c749bb972a9a2d786c731f31530d..6b438831336bc94c55cf41de7cd295089751a5b3 100644 (file)
--- a/evhttp.h
+++ b/evhttp.h
@@ -73,11 +73,12 @@ struct evkeyvalq;
 struct evhttp *evhttp_new(struct event_base *base);
 
 /**
- * Start an HTTP server on the specified address and port.
+ * Binds an HTTP server on the specified address and port.
  *
  * Can be called multiple times to bind the same http server
  * to multiple different ports.
  *
+ * @param http a pointer to an evhttp object
  * @param address a string containing the IP address to listen(2) on
  * @param port the port number to listen on
  * @return 0 on success, -1 on failure.
@@ -145,6 +146,7 @@ void evhttp_send_reply_end(struct evhttp_request *);
 
 /**
  * Start an HTTP server on the specified address and port
+ *
  * DEPRECATED: it does not allow an event base to be specified
  *
  * @param address the address to which the HTTP server should be bound