From 1a51887386e4005fdd8faee02da76f04ffd6b7b8 Mon Sep 17 00:00:00 2001
From: Niels Provos <provos@gmail.com>
Date: Sun, 12 Apr 2009 23:00:52 +0000
Subject: [PATCH] from trunk: improve evhttp_parse_query documentation

svn:r1161
---
 evhttp.h | 16 +++++++++++++---
 http.c   |  1 -
 2 files changed, 13 insertions(+), 4 deletions(-)

diff --git a/evhttp.h b/evhttp.h
index 83325882..99d16a2f 100644
--- a/evhttp.h
+++ b/evhttp.h
@@ -335,10 +335,20 @@ char *evhttp_decode_uri(const char *uri);
 
 /**
  * Helper function to parse out arguments in a query.
- * The arguments are separated by key and value.
- * URI should already be decoded.
+ *
+ * Parsing a uri like
+ *
+ *    http://foo.com/?q=test&s=some+thing
+ *
+ * will result in two entries in the key value queue.
+
+ * The first entry is: key="q", value="test"
+ * The second entry is: key="s", value="some thing"
+ *
+ * @param uri the request URI
+ * @param headers the head of the evkeyval queue
  */
-void evhttp_parse_query(const char *uri, struct evkeyvalq *);
+void evhttp_parse_query(const char *uri, struct evkeyvalq *headers);
 
 
 /**
diff --git a/http.c b/http.c
index 491e3c3e..71353395 100644
--- a/http.c
+++ b/http.c
@@ -2115,7 +2115,6 @@ evhttp_decode_uri(const char *uri)
 /* 
  * Helper function to parse out arguments in a query.
  * The arguments are separated by key and value.
- * URI should already be decoded.
  */
 
 void