Permalink
Browse files

from trunk: improve evhttp_parse_query documentation

svn:r1161
  • Loading branch information...
1 parent c1bd938 commit 1a51887386e4005fdd8faee02da76f04ffd6b7b8 @provos provos committed Apr 12, 2009
Showing with 13 additions and 4 deletions.
  1. +13 −3 evhttp.h
  2. +0 −1 http.c
View
@@ -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);
/**
View
1 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

0 comments on commit 1a51887

Please sign in to comment.