Made some improvements to the doxygen-generated documentation.

This commit is contained in:
chris 2004-04-13 04:03:12 +00:00
parent 85d8814be8
commit e95c4ba207
8 changed files with 55 additions and 9 deletions

View File

@ -49,12 +49,39 @@ static boost::arg<3> total_bytes_recvd;
#else
/// An argument placeholder, for use with \ref boost_bind, that corresponds to
/// the error argument of a handler for any of the asynchronous socket-related
/// functions.
boost::arg<1> error;
/// An argument placeholder, for use with \ref boost_bind, that corresponds to
/// the bytes_sent argument of a handler for asynchronous functions such as
/// asio::async_send or asio::stream_socket::async_send.
boost::arg<2> bytes_sent;
/// An argument placeholder, for use with \ref boost_bind, that corresponds to
/// the last_bytes_sent argument of a handler for the asio::async_send_n
/// function.
boost::arg<2> last_bytes_sent;
/// An argument placeholder, for use with \ref boost_bind, that corresponds to
/// the bytes_recvd argument of a handler for asynchronous functions such as
/// asio::async_recv or asio::stream_socket::async_recv.
boost::arg<2> bytes_recvd;
/// An argument placeholder, for use with \ref boost_bind, that corresponds to
/// the last_bytes_recvd argument of a handler for the asio::async_recv_n
/// function.
boost::arg<2> last_bytes_recvd;
/// An argument placeholder, for use with \ref boost_bind, that corresponds to
/// the total_bytes_sent argument of a handler for the asio::async_send_n
/// function.
boost::arg<3> total_bytes_sent;
/// An argument placeholder, for use with \ref boost_bind, that corresponds to
/// the total_bytes_recvd argument of a handler for the asio::async_recv_n
/// function.
boost::arg<3> total_bytes_recvd;
#endif

View File

@ -457,7 +457,7 @@ public:
* function signature of the handler must be:
* @code void handler(
* const asio::socket_error& error, // Result of operation
* size_t bytes_received // Number of bytes received
* size_t bytes_recvd // Number of bytes received
* ); @endcode
*/
template <typename Address, typename Handler>

View File

@ -418,7 +418,7 @@ public:
* function signature of the handler must be:
* @code void handler(
* const asio::socket_error& error, // Result of operation
* size_t bytes_received // Number of bytes received
* size_t bytes_recvd // Number of bytes received
* ); @endcode
*
* @note The recv operation may not receive all of the requested number of

View File

@ -27,16 +27,19 @@ namespace ipv4 {
class tcp
{
public:
/// Obtain an identifier for the type of the protocol.
int type() const
{
return SOCK_STREAM;
}
/// Obtain an identifier for the protocol.
int protocol() const
{
return IPPROTO_TCP;
}
/// Obtain an identifier for the protocol family.
int family() const
{
return PF_INET;

View File

@ -26,16 +26,19 @@ namespace ipv4 {
class udp
{
public:
/// Obtain an identifier for the type of the protocol.
int type() const
{
return SOCK_DGRAM;
}
/// Obtain an identifier for the protocol.
int protocol() const
{
return IPPROTO_UDP;
}
/// Obtain an identifier for the protocol family.
int family() const
{
return PF_INET;

View File

@ -107,9 +107,9 @@ size_t recv(Stream& s, void* data, size_t max_length,
* function signature of the handler must be:
* @code template <typename Error>
* void handler(
* const Error& error, // Result of operation (the actual type is dependent
* // on the underlying stream's recv operation)
* size_t bytes_received // Number of bytes received
* const Error& error, // Result of operation (the actual type is dependent
* // on the underlying stream's recv operation)
* size_t bytes_recvd // Number of bytes received
* ); @endcode
*
* @note The recv operation may not receive all of the requested number of

View File

@ -170,7 +170,7 @@ SHORT_NAMES = NO
# will show members with their full class and namespace scopes in the
# documentation. If set to YES the scope will be hidden.
HIDE_SCOPE_NAMES = YES
HIDE_SCOPE_NAMES = NO
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
# will put a list of the files that are included by a file in the documentation

View File

@ -5,7 +5,7 @@
/**
\namespace asio::ipv4
\brief The asio namespace defines all user-accessible classes and templates.
\brief The asio namespace defines the classes associated with IP version 4.
*/
/**
@ -13,6 +13,18 @@
\brief The asio::socket_option namespace defines the supported socket options.
*/
/**
\namespace asio::arg
\brief The asio::arg namespace defines argument placeholders for use with
\ref boost_bind.
*/
/**
\page boost_bind boost::bind
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>.
*/
/**
\mainpage
@ -23,8 +35,9 @@
<H2>Namespaces</H2>
\li ::asio
\li ::asio::ipv4
\li ::asio::socket_option
\li asio::arg
\li asio::ipv4
\li asio::socket_option
<H2>Core Classes</H2>