Updating the documentation.

Author: glynos

README.rst

@@ -15,8 +15,8 @@ cpp-netlib offers the following implementations:
      generate message objects from strings.
   *  Adapters and Wrappers -- A collection of Adapters and wrappers aimed
      towards making the message type STL friendly.
-  *  Network protocol client and server implementations -- A collection 
-     of network protocol implementations that include embeddable client 
+  *  Network protocol client and server implementations -- A collection
+     of network protocol implementations that include embeddable client
      and server types.
 
 This library is released under the Boost Software License (please see
@@ -47,30 +47,15 @@ The recommended installation procedure would be to follow the steps below::
     $ sudo mkdir -p /usr/local/include/cpp-netlib
     $ sudo cp -r cpp-netlib/boost /usr/local/include/cpp-netlib
 
-Now don't forget to add ``/usr/local/include/cpp-netlib`` in your project's
-compiler include directories to start using cpp-netlib in your projects.
-
-Running Tests
--------------
-
-If you want to run the tests that come with cpp-netlib, there are a few things
-you will need. These are:
-
-  * A compiler (GCC 4.x or Clang 2.8)
-  * A build tool (CMake [#]_ recommended, Boost.Build also an option)
-  * OpenSSL headers (optional with CMake, mandatory for Boost.Build)
-  * Python 2.6
-
-.. note:: This assumes that you have the cpp-netlib distribution package
-   unpacked somwhere in your home directory. This specifically assumes that you
-   have cpp-netlib at the toplevel of your home directory.
-.. [#] http://www.cmake.org/
+Don't forget to add ``/usr/local/include/cpp-netlib`` in your project's
+compiler include directories to start using cpp-netlib.
 
 Building with CMake
 ~~~~~~~~~~~~~~~~~~~
 
-To build and run the tests with CMake, you will need to have CMake version 2.8
-or higher installed appropriately in your system.
+To build the libraries and run the tests with CMake, you will need to
+have CMake version 2.8 or higher installed appropriately in your
+system.
 
 ::
 
@@ -81,16 +66,11 @@ Inside the cpp-netlib directory, you can issue the following statements to
 configure and generate the Makefiles, and build the tests::
 
     $ cd ~/cpp-netlib      # we're assuming it's where cpp-netlib is
-    $ cmake -DCMAKE_BUILD_TYPE=Debug \
-    >    -CMAKE_C_COMPILER=clang     \
-    >    -CMAKE_CXX_COMPILER=clang++ \
+    $ cmake -DCMAKE_BUILD_TYPE=Debug     \
+    >       -DCMAKE_C_COMPILER=clang     \
+    >       -DCMAKE_CXX_COMPILER=clang++ \
     >    .
 
-.. note:: This uses the source directory as the build directory as well. At the
-   time of this writing, cpp-netlib is meant to be tested in the same directory
-   where the source files are, because of the way the tests depend on Python
-   being installed and having access to Python scripts during the build.
-
 Once CMake is done with generating the Makefiles and configuring the project,
 you can now build the tests and run them::
 
@@ -102,7 +82,7 @@ If for some reason some of the tests fail, you can send the files in
 ``Testing/Temporary/`` as attachments to the cpp-netlib `developers mailing
 list`_.
 
-.. _`developers mailing list`: https://lists.sourceforge.net/lists/listinfo/cpp-netlib-devel
+.. _`developers mailing list`: cpp-netlib@googlegroups.com
 
 Building with Boost.Build
 ~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -113,7 +93,7 @@ to copy the ``bjam`` executable to a directory that is already in your ``PATH``
 so that you don't have to go hunting for it all the time. A good place to put it
 is in ``/usr/local/bin``.
 
-.. [#] http://www.boost.org/doc/libs/1_44_0/more/getting_started/index.html
+.. [#] http://www.boost.org/doc/libs/release/more/getting_started/
 
 Building and running the tests can be as simple as doing the following::
 
@@ -130,7 +110,22 @@ please do the following::
 And then attach the ``build-test.log`` file to the email you will send to the
 cpp-netlib `developers mailing list`_.
 
-.. _`developers mailing list`: https://lists.sourceforge.net/lists/listinfo/cpp-netlib-devel
+.. _`developers mailing list`: [email protected]
+
+Running Tests
+-------------
+
+If you want to run the tests that come with cpp-netlib, there are a few things
+you will need. These are:
+
+  * A compiler (GCC 4.x, Clang 2.8, MSVC 2008)
+  * A build tool (CMake [#]_ recommended, Boost.Build also an option)
+  * OpenSSL headers (optional)
+
+.. note:: This assumes that you have the cpp-netlib distribution package
+   unpacked somwhere in your home directory. This specifically assumes that you
+   have cpp-netlib at the toplevel of your home directory.
+.. [#] http://www.cmake.org/
 
 Hacking on cpp-netlib
 ---------------------
@@ -174,14 +169,10 @@ In case you have any questions or would like to make feature requests, you can
 contact the development team through the `developers mailing list`_
 or by filing issues at http://github.com/cpp-netlib/cpp-netlib/issues.
 
-.. _`developers mailing list`:
-   https://lists.sourceforge.net/lists/listinfo/cpp-netlib-devel
+.. _`developers mailing list`: [email protected]
 
 You can reach the maintainers of the project through::
 
     Dean Michael Berris ([email protected])
 
-    Glyn Matthews
-
-    Mike Dickey
-
+    Glyn Matthews ([email protected])

libs/network/doc/CMakeLists.txt

@@ -0,0 +1,15 @@
+.. _atom_reader:
+
+*************
+ Atom reader
+*************
+
+The Code
+========
+
+
+Building and Running The Code
+=============================
+
+Diving into the Code
+====================

libs/network/doc/atom_reader.rst

@@ -61,7 +61,7 @@
 # The short X.Y version.
 version = '0.9'
 # The full version, including alpha/beta/rc tags.
-release = '0.9'
+release = '0.9.3'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -74,7 +74,7 @@
 #today_fmt = '%B %d, %Y'
 
 # List of documents that shouldn't be included in the build.
-unused_docs = [ 'http_client_tags.rst' ]
+unused_docs = [ '' ]
 
 # List of directories, relative to source directory, that shouldn't be searched
 # for source files.

libs/network/doc/conf.py

@@ -5,10 +5,10 @@ The :mod:`cpp-netlib` is a practical library that is designed to aid
 the development of applications for that need to communicate using
 common networking protocols.  The following set of examples describe a
 series of realistic examples that use the :mod:`cpp-netlib` for these
-kinds of application.
+kinds of application.  All examples are built using CMake.
 
 .. toctree::
    :maxdepth: 2
 
    examples_http.rst
-..   examples_xmpp.rst
+

libs/network/doc/examples.rst

@@ -11,3 +11,7 @@ embedded into larger applications.
    http_client.rst
    hello_world_server.rst
    hello_world_client.rst
+   simple_wget.rst
+   atom_reader.rst
+   rss_reader.rst
+   twitter_search.rst

libs/network/doc/examples_http.rst

@@ -99,7 +99,7 @@ returns, in the default case, a multimap of strings to strings:
     response_headers headers_ = headers(response);
     for (iterator it = headers_.begin(); it != headers_.end(); ++it) {
         std::cout << it->first << ": " << it->second << std::endl;
-    }    
+    }
     std::cout << std::endl;
 
 
@@ -145,9 +145,9 @@ implementation while the user-visible implementation is the
     namespace boost { namespace network { namespace http {
 
         template <class RequestHandler>
-        class server : 
+        class server :
             public basic_server<default_, RequestHandler> {};
-    
+
     }}}
 
 To use the forwarding server type you just supply the request handler
@@ -178,36 +178,3 @@ Here, all we're doing is returning the original request body with an
 HTTP OK response (200). We are also printing the IP address from where the
 request came from. Notice that we are using a wrapper to access the source of
 the request.
-
-HTTP URI
-````````
-
-:mod:`cpp-netlib` provides a specialization and ``typedef`` for an
-HTTP URI:
-
-.. code-block:: c++
-
-    namespace http {
-    template <class T> class basic_uri;
-    typedef basic_uri<default_> uri;
-    }
-    
-``basic_uri`` provides a parser which breaks down a URI string passed
-to it's constructor into different parts.
-
-.. code-block:: c++
-
-    using namespace boost::network::uri;
-    http::uri uri_("http://www.boost.org/");
-    assert(valid(uri_));
-    assert(scheme(uri_) == "http");
-    assert(host(uri_) == "www.boost.org")
-    assert(port(uri_) == 80)
-    assert(path(uri_) == "/");
-
-The syntax of the HTTP URI are defined in RFC 1738 section 3.3 [#]_
-and the default URI provided with cpp-netlib conforms to this.  In
-such a way, specializations that conform to any URI scheme can be
-provided.
-
-.. [#] http://tools.ietf.org/html/rfc1738

libs/network/doc/http.rst

@@ -7,10 +7,10 @@
 The first code example is the simplest thing you can do with the
 :mod:`cpp-netlib`.  The application is a simple HTTP client, which can
 be found in the subdirectory ``libs/network/example/http_client.cpp``.
-All we are doing is creating and sending an HTTP request to a server
-and printing the response body.  
+All this example doing is creating and sending an HTTP request to a server
+and printing the response body.
 
-The Code
+The code
 ========
 
 Without further ado, the code to do this is as follows:
@@ -19,45 +19,34 @@ Without further ado, the code to do this is as follows:
 
     #include <boost/network/protocol/http/client.hpp>
     #include <iostream>
-    
+
     int main(int argc, char *argv[]) {
         using namespace boost::network;
-	
+
 	if (argc != 2) {
 	    std::cout << "Usage: " << argv[0] << " [url]" << std::endl;
     	    return 1;
         }
-	
+
         http::client client;
         http::client::request request(argv[1]);
 	request << header("Connection", "close");
 	http::client::response response = client.get(request);
 	std::cout << body(response) << std::endl;
-	
+
   	return 0;
     }
 
-Building and Running The Code
-=============================
-
-To be build this example, you can follow the steps below without having to build
-the whole :mod:`cpp-netlib` distribution::
-
-    $ cd ~/cpp-netlib
-    $ g++ -o http_client1 libs/network/example/http_client1.cpp \
-    >     -I.                                                   \
-    >     -I$BOOST_ROOT                                         \
-    >     -L$BOOST_ROOT/stage/lib                               \
-    >     -lboost_system                                        \
-    >     -pthread
+Running the example
+===================
 
 You can then run this to get the Boost_ website::
 
     $ ./http_client1 http://www.boost.org/
 
 .. _Boost: http://www.boost.org/
 
-Diving into the Code
+Diving into the code
 ====================
 
 Since this is the first example, each line will be presented and

libs/network/doc/http_client.rst

@@ -0,0 +1,15 @@
+.. _rss_reader:
+
+************
+ RSS reader
+************
+
+The Code
+========
+
+
+Building and Running The Code
+=============================
+
+Diving into the Code
+====================