Add documentation to our uri scanner

1 files changed, 4 insertions, 2 deletions

diff --git a/scan_urlencoded_query.h b/scan_urlencoded_query.h
index 4fa35c4..f0ad781 100644
--- a/scan_urlencoded_query.h
+++ b/scan_urlencoded_query.h
@@ -11,7 +11,8 @@ typedef enum {
   SCAN_SEARCHPATH_TERMINATOR = 8
 } SCAN_SEARCHPATH_FLAG;
 
-/* string     pointer to source, pointer to next scan position on return
+/* string     in: pointer to source
+              out: pointer to next scan position
    deststring pointer to destination
    flags      determines, what to parse
    returns    number of valid converted characters in deststring
@@ -19,7 +20,8 @@ typedef enum {
 */
 ssize_t scan_urlencoded_query(char **string, char *deststring, SCAN_SEARCHPATH_FLAG flags);
 
-/* string     pointer to source, pointer to next scan position on return
+/* string     in: pointer to value of a param=value pair to skip
+              out: pointer to next scan position on return
 */
 void scan_urlencoded_skipvalue( char **string );