src/lib/url.h
changeset 14 115067dfba55
parent 13 385b9a10d096
child 15 a8d183e79ed9
--- a/src/lib/url.h	Tue Oct 07 18:38:03 2008 +0300
+++ b/src/lib/url.h	Tue Oct 07 20:31:35 2008 +0300
@@ -4,7 +4,7 @@
 /*
  * A trivial parser for simple URLs
  *
- * [ <scheme> [ "+" <scheme> [ ... ] ] "://" ] [ <username> [ ":" <password> ] "@" ] <hostname> [ ":" <service> ] [ "/" <path> ] [ "?" [ <key> [ "=" <value> ] ] [ "&" [ <key> [ "="     <value> ] ] [ ... ] ]
+ * [ <scheme> [ "+" <scheme> [ ... ] ] "://" ] [ <username> [ ":" <password> ] "@" ] [ <hostname> ] [ ":" <service> ] [ "/" <path> ] [ "?" [ <key> [ "=" <value> ] ] [ "&" [ <key> [ "="     <value> ] ] [ ... ] ]
  *
  *  example.com
  *  tcp://example.com:7348/
@@ -47,6 +47,8 @@
 /*
  * Parse the given `text` as an URL, returning the result in `url`. Optional fields that are missing in the text will
  * cause those values to be returned unmodified.
+ *
+ * Returns zero if the url was valid and was parsed, nonzero if it was invalid.
  */
 int url_parse (struct url *url, const char *text);