Updated documentation.

Author: glynos

README.rst

@@ -105,10 +105,9 @@ you will need. These are:
   * 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/
+.. note:: This assumes that you have cpp-netlib at the top-level of
+          your home directory.
+  [#] http://www.cmake.org/
 
 Hacking on cpp-netlib
 ---------------------

libs/network/doc/atom_reader.rst

@@ -4,12 +4,44 @@
  Atom reader
 *************
 
-The Code
+The code
 ========
 
+.. code-block:: c++
 
-Building and Running The Code
-=============================
+   #include "atom.hpp"
+   #include <boost/network/protocol/http/client.hpp>
+   #include <boost/foreach.hpp>
+   #include <iostream>
 
-Diving into the Code
+   int main(int argc, char * argv[]) {
+       using namespace boost::network;
+
+       if (argc != 2) {
+           std::cout << "Usage: " << argv[0] << " <url>" << std::endl;
+           return 1;
+       }
+
+       try {
+           http::client client;
+           http::client::request request(argv[1]);
+           request << header("Connection", "close");
+           http::client::response response = client.get(request);
+           atom::feed feed(response);
+
+           std::cout << "Feed: " << feed.title()
+	   	     << " (" << feed.subtitle() << ")" << std::endl;
+           BOOST_FOREACH(const atom::entry &entry, feed) {
+               std::cout << entry.title()
+	       		 << " (" << entry.published() << ")" << std::endl;
+           }
+       }
+       catch (std::exception &e) {
+           std::cerr << e.what() << std::endl;
+       }
+
+       return 0;
+   }
+
+Diving into the code
 ====================

libs/network/doc/examples_http.rst

@@ -8,10 +8,10 @@ embedded into larger applications.
 .. toctree::
    :maxdepth: 2
 
-   http_client.rst
+   simple_wget.rst
    hello_world_server.rst
    hello_world_client.rst
-   simple_wget.rst
+   fileserver.rst
    atom_reader.rst
    rss_reader.rst
    twitter_search.rst

libs/network/doc/fileserver.rst

@@ -0,0 +1,11 @@
+.. _fileserver_http:
+
+*******************
+ Fileserver (HTTP)
+*******************
+
+The code
+========
+
+Diving into the code
+====================

libs/network/doc/getting_started.rst

@@ -158,7 +158,7 @@ Building On Windows
 If you're using the Microsoft Visual C++ compiler or the Microsoft Visual Studio
 IDE and you would like to build cpp-netlib from within Visual Studio, you can
 look for the solution and project files as the artifacts of the call to
-``cmake`` -- the file should be named ``cpp-netlib.sln`` (the solution) along
+``cmake`` -- the file should be named ``CPP-NETLIB.sln`` (the solution) along
 with a number of project files for Visual Studio.
 
 Reporting Issues, Getting Support
@@ -173,5 +173,5 @@ for the project at http://github.com/cpp-netlib/cpp-netlib/issues.
 
 You can also opt to join the developers mailing list for a more personal
 interaction with the developers of the project. You can join the mailing list
-through https://groups.google.com/group/cpp-netlib.
+through http://groups.google.com/forum/#!forum/cpp-netlib.
 

libs/network/doc/hello_world_client.rst

@@ -51,7 +51,7 @@ Just like with the HTTP Server and HTTP client example before, we can build this
 example by doing the following on the shell:
 
 .. code-block:: bash
-    
+
     $ cd ~/cpp-netlib
     $ g++ -o hello_world_client \
     >     libs/network/example/http/hello_world_client.cpp  \
@@ -70,7 +70,7 @@ This example can be run from the command line as follows:
 .. note:: This assumes that you have the ``hello_world_server`` running on
    localhost port 8000.
 
-Diving into the Code
+Diving into the code
 ====================
 
 All this example shows is how easy it is to write an HTTP client that connects
@@ -92,7 +92,7 @@ perform the request via HTTP:
 
     http::client client;
     http::client::request request("http://my.webservice.com/");
-    http::client::response = 
+    http::client::response =
         client.post(request, "application/xml", some_xml_string);
     std::data = body(response);
 

libs/network/doc/hello_world_server.rst

@@ -59,7 +59,7 @@ simple response to any HTTP request.
 
 This is about a straightforward as server programming will get in C++.
 
-Building the Server
+Building the server
 ===================
 
 Just like with the HTTP client, we can build this example by doing the following
@@ -86,7 +86,7 @@ a command line as follows:
 .. note:: If you're going to run the server on port 80, you may have to run it
    as an administrator.
 
-Diving into the Code
+Diving into the code
 ====================
 
 Let's take a look at the code listing above in greater detail.

libs/network/doc/index.rst

@@ -123,7 +123,6 @@ Contents
    in_depth.rst
    techniques.rst
    history.rst
-   install.rst
    reference.rst
    references.rst
 

libs/network/doc/install.rst

@@ -35,7 +35,7 @@ Handler function object.
 There are two different Handler concepts, one concept for `Synchronous Servers`_
 and another for `Asynchronous Servers`.
 
-The SynchronusHandler concept for `Synchronous Servers`_ is described by the
+The SynchronousHandler concept for `Synchronous Servers`_ is described by the
 following table:
 
 ---------------
@@ -145,7 +145,7 @@ API Documentation
 The following sections assume that the following file has been included:
 
 .. code-block:: c++
-    
+
     #include <boost/network/include/http/server.hpp>
 
 And that the following typedef's have been put in place:
@@ -226,14 +226,14 @@ Constructor
 To use the above supported named parameters, you'll have code that looks like the following:
 
 .. code-block:: c++
-    
+
     using namespace boost::network::http; // parameters are in this namespace
     boost::asio::io_service my_io_service;
     boost::network::utils::thread_pool pool(2);
     handler handler_instance;
     async_server<handler> instance(_address="0.0.0.0", _port="80", _handler=handler_instance,
                                    _io_service=my_io_service, _thread_pool=pool,
-                                   _reuse_address=true); 
+                                   _reuse_address=true);
     instance.run();
 
 Public Members
@@ -270,8 +270,8 @@ helpful in certain simple situations.
 
 ``response = http_server::response::stock_reply(status, body)``
     Code like the above should go inside the handler's ``operator()`` overload.
-    The body parameter is an ``std::string``. The status parameter is any of 
-    the following values from the ``http_server::response`` enum 
+    The body parameter is an ``std::string``. The status parameter is any of
+    the following values from the ``http_server::response`` enum
     ``status_type``:
 
 .. code-block:: c++
@@ -313,7 +313,7 @@ which can be directly manipulated by the handler.
 .. [#] A header is a struct of type
    ``response_header<http::tags::http_server>``. An instance always has the
    members ``name`` and ``value`` both of which are of type ``string_type``.
-.. [#] ``string_type`` is 
+.. [#] ``string_type`` is
    ``boost::network::string<http::tags::http_server>::type``.
 
 Asynchronous Servers
@@ -358,7 +358,7 @@ synchronous server implementation.
 The general pattern for using the ``async_server`` template is shown below:
 
 .. code-block:: c++
-    
+
     struct handler;
     typedef boost::network::http::async_server<handler> http_server;
 
@@ -367,7 +367,7 @@ The general pattern for using the ``async_server`` template is shown below:
             http_server::request const & req,
             http_server::connection_ptr connection
         ) {
-            // handle the request here, and use the connection to 
+            // handle the request here, and use the connection to
             // either read more data or write data out to the client
         }
     };

libs/network/doc/reference_http_server.rst

@@ -14,10 +14,12 @@ Other sources
 * `HTTP 1.0`_: The HTTP 1.0 specification.
 * `HTTP 1.1 (RFC 2616)`_: The HTTP 1.1 specification.
 * `URI Generic Syntax (RFC 3986)`_: Generic URI syntax specification.
+* `Format for Literal IPv6 Addresses in URLs (RFC 2732)`_: Literal IPv6 Addresses in URLs.
 
 .. _`BoostCon 2010 Slides`: http://www.filetolink.com/b0e89d06
 .. _`BoostCon 2010 Paper`: http://github.com/downloads/mikhailberis/cpp-netlib-boostcon-paper/cpp-netlib.pdf
 .. _`Template Metaprogramming`: http://www.boostpro.com/mplbook/
 .. _`HTTP 1.0`: http://www.w3.org/Protocols/HTTP/1.0/spec.html
 .. _`HTTP 1.1 (RFC 2616)`: http://www.w3.org/Protocols/rfc2616/rfc2616.html
 .. _`URI Generic Syntax (RFC 3986)`: http://www.ietf.org/rfc/rfc3986.txt
+.. _`Format for Literal IPv6 Addresses in URLs (RFC 2732)`: http://www.ietf.org/rfc/rfc2732.txt

libs/network/doc/references.rst

@@ -4,12 +4,41 @@
  RSS reader
 ************
 
-The Code
-========
+.. code-block:: c++
 
+   #include "rss.hpp"
+   #include <boost/network/protocol/http/client.hpp>
+   #include <boost/foreach.hpp>
+   #include <iostream>
 
-Building and Running The Code
-=============================
+   int main(int argc, char * argv[]) {
+       using namespace boost::network;
 
-Diving into the Code
+       if (argc != 2) {
+           std::cout << "Usage: " << argv[0] << " <url>" << std::endl;
+           return 1;
+       }
+
+       try {
+           http::client client;
+           http::client::request request(argv[1]);
+           request << header("Connection", "close");
+           http::client::response response = client.get(request);
+           rss::channel channel(response);
+
+           std::cout << "Channel: " << channel.title()
+	   	     << " (" << channel.description() << ")" << std::endl;
+           BOOST_FOREACH(const rss::item &item, channel) {
+               std::cout << item.title()
+	       		 << " (" << item.author() << ")" << std::endl;
+           }
+       }
+       catch (std::exception &e) {
+           std::cerr << e.what() << std::endl;
+       }
+
+       return 0;
+   }
+
+Diving into the code
 ====================