added comment regarding query strings (#767)

This commit is contained in:
Guenter Obiltschnig 2015-09-14 10:19:08 +02:00
parent 32956fe044
commit 2603c7a0d4

View File

@ -42,8 +42,15 @@ class Foundation_API URI
/// The class automatically performs a few normalizations on
/// all URIs and URI parts passed to it:
/// * scheme identifiers are converted to lower case
/// * percent-encoded characters are decoded
/// * percent-encoded characters are decoded (except for the query string)
/// * optionally, dot segments are removed from paths (see normalize())
///
/// Note that dealing with query strings requires some precautions, as, internally,
/// query strings are stored in percent-encoded form, while all other parts of the URI
/// are stored in decoded form. While parsing query strings from properly encoded URLs
/// generally works, explicitly setting query strings with setQuery() or extracting
/// query strings with getQuery() may lead to ambiguities. See the descriptions of
/// setQuery(), setRawQuery(), getQuery() and getRawQuery() for more information.
{
public:
typedef std::vector<std::pair<std::string, std::string> > QueryParameters;