diff --git a/doc/qbk/1.1.quicklook.qbk b/doc/qbk/1.1.quicklook.qbk index dbda20cb..e86b86ea 100644 --- a/doc/qbk/1.1.quicklook.qbk +++ b/doc/qbk/1.1.quicklook.qbk @@ -13,6 +13,8 @@ This section is intended to give the reader a brief overview of the features and interface style of the library. Say you have the following URL that you want to parse: + +[teletype] ``` https://user:pass@www.example.com:443/path/to/my%2dfile.txt?id=42&name=John%20Doe#anchor ``` @@ -27,6 +29,7 @@ container resembling a variant that holds either an error or an object. In this case we immediately call `result::value` which throws an exception on a parsing error, otherwise returns an instance of __url_view__ which holds the parsed result. + It is worth noting that __parse_uri__ allocates no memory and throws no exceptions. Like a string view, the __url_view__ does not retain ownership of the underlying string buffer. Constructed URL views always contain a diff --git a/doc/qbk/2.8.authority_view.qbk b/doc/qbk/2.8.authority_view.qbk index f2428cbd..16dfaa77 100644 --- a/doc/qbk/2.8.authority_view.qbk +++ b/doc/qbk/2.8.authority_view.qbk @@ -25,6 +25,8 @@ The authority view provides the subset of observer member functions found in __url_view__ which are relevant to the authority. However, when an authority is parsed on its own, the leading double slashes ("//") are not present. The following authority string is valid for `parse_authority`: + +[teletype] ``` user:pass@www.example.com:443 ``` diff --git a/include/boost/url/authority_view.hpp b/include/boost/url/authority_view.hpp index 23703f59..ad4514d3 100644 --- a/include/boost/url/authority_view.hpp +++ b/include/boost/url/authority_view.hpp @@ -1218,7 +1218,7 @@ parse_authority( @param os The output stream to write to - @param u The URL to write + @param a The URL to write */ BOOST_URL_DECL std::ostream& diff --git a/include/boost/url/ipv6_address.hpp b/include/boost/url/ipv6_address.hpp index 0df48f8f..b04fcf18 100644 --- a/include/boost/url/ipv6_address.hpp +++ b/include/boost/url/ipv6_address.hpp @@ -349,7 +349,7 @@ private: @param os The output stream to write to. - @param addrr The address to write. + @param addr The address to write. */ BOOST_URL_DECL std::ostream& diff --git a/include/boost/url/segments_encoded.hpp b/include/boost/url/segments_encoded.hpp index 6d7273cb..c1b3b88d 100644 --- a/include/boost/url/segments_encoded.hpp +++ b/include/boost/url/segments_encoded.hpp @@ -406,11 +406,6 @@ public: up to and including the last element and @ref end iterators are invalidated. - @par Requires - @code - is_stringlike< String >::value == true - @endcode - @par Example @code url u = parse_relative_uri( "/path/file.txt" ); diff --git a/include/boost/url/string_view.hpp b/include/boost/url/string_view.hpp index d809415a..6fd96cfd 100644 --- a/include/boost/url/string_view.hpp +++ b/include/boost/url/string_view.hpp @@ -11,7 +11,6 @@ #define BOOST_URL_STRING_VIEW_HPP #include -//#include #include namespace boost { @@ -32,7 +31,6 @@ using pos_t = std::size_t; owning the character buffer extends until the string view is no longer referenced. */ -//typedef boost::string_view string_view; typedef boost::core::string_view string_view; } // urls diff --git a/include/boost/url/url.hpp b/include/boost/url/url.hpp index 63d086b8..d80b936c 100644 --- a/include/boost/url/url.hpp +++ b/include/boost/url/url.hpp @@ -156,7 +156,7 @@ public: from `u`. After the move. the state of `u` will be as-if default constructed. - @param Exception Safety + @par Exception Safety Throws nothing. @param u The url to construct from. @@ -188,7 +188,7 @@ public: from `u`. After the move. the state of `u` will be as-if default constructed. - @param Exception Safety + @par Exception Safety Throws nothing. @param u The url to assign from.