From cd1949bc964d2b1846f9745d914213548217d2e1 Mon Sep 17 00:00:00 2001
From: Michael Drake <tlsa@netsurf-browser.org>
Date: Thu, 9 Jul 2015 15:27:16 +0100
Subject: Improve component documentation.

---
 utils/nsurl.c | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)

diff --git a/utils/nsurl.c b/utils/nsurl.c
index 4454ba8a1..9e19275cc 100644
--- a/utils/nsurl.c
+++ b/utils/nsurl.c
@@ -150,7 +150,18 @@ enum scheme_type {
 };
 
 
-/** nsurl components */
+/**
+ * nsurl components
+ *
+ * [scheme]://[username]:[password]@[host]:[port][path][?query]#[fragment]
+ *
+ * Note:
+ *   "path" string includes preceding '/', if needed for the scheme
+ *   "query" string always includes preceding '?'
+ *
+ * The other spanned punctuation is to be inserted when building URLs from
+ * components.
+ */
 struct nsurl_components {
 	lwc_string *scheme;
 	lwc_string *username;
@@ -167,8 +178,6 @@ struct nsurl_components {
 
 /**
  * NetSurf URL object
- *
- * [scheme]://[username][:password]@[host]:[port][/path][?query][#fragment]
  */
 struct nsurl {
 	struct nsurl_components components;
-- 
cgit v1.2.3