diff options
author | Michael Drake <tlsa@netsurf-browser.org> | 2015-07-09 15:27:16 +0100 |
---|---|---|
committer | Michael Drake <tlsa@netsurf-browser.org> | 2015-07-09 17:24:03 +0100 |
commit | cd1949bc964d2b1846f9745d914213548217d2e1 (patch) | |
tree | c96bb5349ee7512729778df0d4e820a899f1bc24 /utils | |
parent | eb962f94c3247c6b64802f12197ac9567315f371 (diff) | |
download | netsurf-cd1949bc964d2b1846f9745d914213548217d2e1.tar.gz netsurf-cd1949bc964d2b1846f9745d914213548217d2e1.tar.bz2 |
Improve component documentation.
Diffstat (limited to 'utils')
-rw-r--r-- | utils/nsurl.c | 15 |
1 files 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; |