Outline of Reference Manual

deanberris · deanberris · commit 66ad9f85704b · 2010-10-30T02:02:30.000+08:00
This is one of the major missing pieces of the documentation. This
commit attempts to note and give an outline of the reference manual for
public-facing functions.

This first commit concentrates on the HTTP client and server interfaces
which would be the higher impact contents of the library.
diff --git a/libs/network/doc/index.rst b/libs/network/doc/index.rst
@@ -96,6 +96,7 @@ Contents
    techniques.rst
    history.rst
    install.rst
+   reference.rst
    references.rst
 
 .. _Boost: http://www.boost.org/
diff --git a/libs/network/doc/reference.rst b/libs/network/doc/reference.rst
@@ -0,0 +1,13 @@
+
+Reference Manual
+================
+
+This reference manual refers to the API documentation of the public interfaces
+to the different client and/or server implementations within :mod:`cpp-netlib`.
+
+.. toctree::
+   :maxdepth: 2
+
+   reference_http_client.rst
+   reference_http_server.rst
+
diff --git a/libs/network/doc/reference_http_client.rst b/libs/network/doc/reference_http_client.rst
@@ -0,0 +1,31 @@
+
+HTTP Client API
+===============
+
+General
+-------
+
+.. FIXME describe the general API for the HTTP Clients
+
+Implementations
+---------------
+
+.. FIXME describe the internal implementation, with diagrams if at all possible
+   and within reasonable efforts.
+
+Synchronous Clients
+~~~~~~~~~~~~~~~~~~~
+
+.. FIXME show the table of tags that enable the synchronous implementation.
+
+Asynchronous Clients
+~~~~~~~~~~~~~~~~~~~~
+
+.. FIXME show the table of tags that enable the asynchronous implementation.
+
+Member Functions
+----------------
+
+.. FIXME show the table of publicly-accessible member functions.
+
+
diff --git a/libs/network/doc/reference_http_server.rst b/libs/network/doc/reference_http_server.rst
@@ -0,0 +1,31 @@
+
+HTTP Server API
+===============
+
+General
+-------
+
+.. FIXME describe the general API for the HTTP Servers
+
+Implementations
+---------------
+
+.. FIXME describe the internal implementation, with diagrams if at all possible
+   and within reasonable efforts.
+
+Synchronous Servers
+~~~~~~~~~~~~~~~~~~~
+
+.. FIXME show the table of tags that enable the synchronous implementation.
+
+Asynchronous Servers
+~~~~~~~~~~~~~~~~~~~~
+
+.. FIXME show the table of tags that enable the asynchronous implementation.
+
+Member Functions
+----------------
+
+.. FIXME show the table of publicly-accessible member functions.
+
+
