Checking in changes for documenting the URI type; adding myself to documentation copyright holders.

mikhail_beris · mikhail_beris · commit a7056e9b4f13 · 2009-12-08T12:16:31.000Z
diff --git a/libs/network/doc/network.qbk b/libs/network/doc/network.qbk
@@ -8,8 +8,8 @@
 [article C++ Network Library
     [quickbook 1.4]
     [version 0.4]
-    [authors [Matthews, Glyn]]
-    [copyright 2008, 2009 Glyn Matthews]
+    [authors [Matthews, Glyn], [Berris, Dean Michael]]
+    [copyright 2008, 2009 Glyn Matthews Dean Michael Berris]
     [purpose C++ library for general network programming]
     [category text]
     [license
diff --git a/libs/network/doc/uri.qbk b/libs/network/doc/uri.qbk
@@ -20,15 +20,68 @@ supports absolute URIs that start with either 'http' or 'https'.
 
 [section:concepts URI Concepts]
 
+This page describes the URI Concepts implemented within cpp-netlib.
+The following concepts are also implemented as Boost.Concept_check
+types enforced by the URI library.
+
+URI Concepts are organized into a hierarchy of conepts.
+
 [section:uri_concept URI]
 
-TODO: document the URI concept.
+[heading Description]
+
+A type models the URI Concept if the type adheres to the following
+usage semantics, and is DefaultConstructible and EqualityComparable.
+
+[variablelist Notation
+    [[`U`] [A URI Type.]]
+    [[`u`,`u_`] [A URI Type instance.]]
+    [[`S`] [A String Type.]]
+    [[`s`] [A String Type instance.]]
+]
+
+[heading Valid Expressions]
+
+For any URI, the following expressions must be valid:
+
+[table
+    [[Expression]   [Return Type]   [Description]]
+    [[`U u_(u)`]      []              [U must be Copy constructible.]]
+    [[`U u_(s)`]      []              [U can be constructed from a string `s`.]]
+    [[`swap(u,u_)`]   [void]          [Swap should be availabe via ADL.]]
+    [[`protocol(u)`]  [S]             [Return the protocol part of the URI.]]
+    [[`rest(u)`]      [S]             [Return the rest of the URI, excluding the protocol part.]]
+    [[`valid(u)`]     [bool]          [Return true whether the URI is a valid URI.]]
+    [[`U::string_type`] [S]           [U should have a nested type `string_type` of type `S`.]]
+]
 
 [endsect] [/uri_concept]
 
 [section:http_uri HTTP URI]
 
-TODO: document the HTTP URI concept.
+A type models the HTTP URI Concept if the type adheres to the following
+usage semantics, and if the type also models the URI Concept.
+
+[variablelist Notation
+    [[`H`] [An HTTP URI Type.]]
+    [[`h`,`h_`] [An HTTP URI Type instance.]]
+    [[`S`] [A String Type.]]
+    [[`s`] [A String Type instance.]]
+]
+
+[heading Valid Expressions]
+
+For any HTTP URI, the following expressions must be valid:
+
+[table
+    [[Expression]   [Return Type]   [Description]]
+    [[`user_info(h)`] [S]           [Retrieve the user-info part of the HTTP URI.]]
+    [[`host(h)`]    [S]             [Retrieve the host part of the HTTP URI.]]
+    [[`port(h)`]    [uint32_t]      [Retrieve the port part of the HTTP URI.]]
+    [[`path(h)`]    [S]             [Retrieve the path part of the HTTP URI.]]
+    [[`query(h)`]   [S]             [Retrieve the query part of the HTTP URI.]]
+    [[`fragment(h)`][S]             [Retrieve the fragment part of the HTTP URI.]]
+]
 
 [endsect] [/http_uri]
 
