Clean up boost-format documentation.

This commit is contained in:
chris_kohlhoff 2005-12-04 10:27:40 +00:00
parent f56823386d
commit 0e7504cbd1
6 changed files with 36 additions and 32 deletions

View File

@ -315,6 +315,8 @@ sub copy_docs
"$boost_dir/libs/asio/doc/reference/asio.css");
copy_source_file("src/doc/boost/asio.css",
"$boost_dir/libs/asio/doc/tutorial/asio.css");
copy_source_file("src/doc/external.doxytags",
"$boost_dir/libs/asio/doc/doxygen/external.doxytags");
}
sub create_root_html

View File

@ -193,7 +193,7 @@ public:
return *this;
}
/// Get the string for the type of exception.
/// Get a string representation of the exception.
virtual const char* what() const throw ()
{
#if defined(BOOST_WINDOWS)

View File

@ -64,7 +64,7 @@ public:
return *this;
}
/// Get the string for the type of exception.
/// Get a string representation of the exception.
virtual const char* what() const throw ()
{
#if defined(BOOST_WINDOWS)

View File

@ -51,9 +51,20 @@
required. OpenSSL is not necessary to use the rest of Boost.Asio.
</p>
<h2>Getting Started</h2>
<p>
The <a href="tutorial/index.html">tutorial</a> introduces the fundamental
concepts required to use Boost.Asio, and show how to use Boost.Asio to
develop simple client and server programs.
</p>
<p>
The <a href="examples/index.html">annotated examples</a> illustrate the
use of Boost.Asio in more complex applications.
</p>
<h2>Supported Platforms</h2>
<p>
The following platforms and compilers are supported:
The following platforms and compilers have been tested:
<ul>
<li>
Win32 using Visual C++ 7.1 and Visual C++ 8.0.

View File

@ -194,7 +194,7 @@ SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration::additions related to external references
#---------------------------------------------------------------------------
TAGFILES =
TAGFILES = ./external.doxytags
GENERATE_TAGFILE = ./asio.doxytags
ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES
@ -208,7 +208,8 @@ HAVE_DOT = YES
CLASS_GRAPH = YES
COLLABORATION_GRAPH = NO
GROUP_GRAPHS = NO
UML_LOOK = YES
UML_LOOK = NO
COMPACT_UML_LOOK = YES
TEMPLATE_RELATIONS = YES
INCLUDE_GRAPH = NO
INCLUDED_BY_GRAPH = NO

View File

@ -3,11 +3,6 @@
\brief The boost::asio namespace defines all user-accessible classes and templates.
*/
/**
\namespace boost::asio::io_control
\brief The boost::asio::io_control namespace defines IO control helper templates.
*/
/**
\namespace boost::asio::ipv4
\brief The boost::asio::ipv4 namespace defines the classes associated with IP version 4.
@ -19,30 +14,12 @@
multicast.
*/
/**
\namespace boost::asio::ipv4::multicast::socket_option
\brief The boost::asio::ipv4::multicast::socket_option namespace defines socket
options helper templates.
*/
/**
\namespace boost::asio::ipv4::socket_option
\brief The boost::asio::ipv4::socket_option namespace defines socket options helper
templates.
*/
/**
\namespace boost::asio::placeholders
\brief The boost::asio::placeholders namespace defines argument placeholders for use
with \ref boost_bind.
*/
/**
\namespace boost::asio::socket_option
\brief The boost::asio::socket_option namespace defines socket options helper
templates.
*/
/**
\namespace boost::asio::ssl
\brief The boost::asio::ssl namespace defines templates and classes for SSL.
@ -54,6 +31,16 @@ See the <a href="http://www.boost.org/libs/bind/bind.html">Boost: bind.hpp
documentation</a> for more information on how to use <tt>boost::bind</tt>.
*/
/**
\page noncopyable noncopyable
Prevents copy construction and assignment.
*/
/**
\page stdexception std::exception
Standard exception class.
*/
/**
\mainpage Reference Index
@ -64,13 +51,9 @@ documentation</a> for more information on how to use <tt>boost::bind</tt>.
<H2>Namespaces</H2>
\li boost::asio
\li boost::asio::io_control
\li boost::asio::ipv4
\li boost::asio::ipv4::multicast
\li boost::asio::ipv4::multicast::socket_option
\li boost::asio::ipv4::socket_option
\li boost::asio::placeholders
\li boost::asio::socket_option
\li boost::asio::ssl
<H2>Classes</H2>
@ -145,13 +128,20 @@ documentation</a> for more information on how to use <tt>boost::bind</tt>.
\li Async_Object
\li Async_Read_Stream
\li Async_Write_Stream
\li Boolean_Socket_Option
\li Boolean_IO_Control_Command
\li Const_Buffers
\li Dispatcher
\li Endpoint
\li Error_Source
\li Integer_Socket_Option
\li IO_Control_Command
\li IPv4_Address_Socket_Option
\li IPv4_MReq_Socket_Option
\li Linger_Socket_Option
\li Mutable_Buffers
\li Protocol
\li Size_IO_Control_Command
\li Socket_Option
\li Stream
\li Sync_Read_Stream