From 69aac1be3ec0545e104046f83f6e1c179a1ca979 Mon Sep 17 00:00:00 2001 From: chris Date: Thu, 15 Apr 2004 07:08:25 +0000 Subject: [PATCH] Some improvements to doxygen comments. --- asio/include/asio/basic_demuxer.hpp | 4 ++-- asio/include/asio/basic_dgram_socket.hpp | 2 +- asio/include/asio/basic_locking_dispatcher.hpp | 4 ++-- asio/include/asio/basic_socket_acceptor.hpp | 2 +- asio/include/asio/basic_socket_connector.hpp | 3 ++- asio/include/asio/basic_stream_socket.hpp | 2 +- asio/include/asio/basic_timer.hpp | 2 +- 7 files changed, 10 insertions(+), 9 deletions(-) diff --git a/asio/include/asio/basic_demuxer.hpp b/asio/include/asio/basic_demuxer.hpp index 5e71f679..6784f997 100644 --- a/asio/include/asio/basic_demuxer.hpp +++ b/asio/include/asio/basic_demuxer.hpp @@ -32,8 +32,8 @@ namespace asio { /// The basic_demuxer class template provides the core event demultiplexing /// functionality for users of the asynchronous I/O objects, such as -/// stream_socket, and also to developers of custom asynchronous services. Most -/// applications will use the demuxer typedef. +/// asio::stream_socket, and also to developers of custom asynchronous +/// services. Most applications will use the asio::demuxer typedef. template class basic_demuxer : private boost::noncopyable diff --git a/asio/include/asio/basic_dgram_socket.hpp b/asio/include/asio/basic_dgram_socket.hpp index ce9c480e..b5c31419 100644 --- a/asio/include/asio/basic_dgram_socket.hpp +++ b/asio/include/asio/basic_dgram_socket.hpp @@ -28,7 +28,7 @@ namespace asio { /// The basic_dgram_socket class template provides asynchronous and blocking /// datagram-oriented socket functionality. Most applications will use the -/// dgram_socket typedef. +/// asio::dgram_socket typedef. template class basic_dgram_socket : private boost::noncopyable diff --git a/asio/include/asio/basic_locking_dispatcher.hpp b/asio/include/asio/basic_locking_dispatcher.hpp index 1e5bf186..c415674e 100644 --- a/asio/include/asio/basic_locking_dispatcher.hpp +++ b/asio/include/asio/basic_locking_dispatcher.hpp @@ -27,8 +27,8 @@ namespace asio { /// The basic_locking_dispatcher class template provides the ability to post /// and dispatch handlers with the guarantee that none of those handlers will -/// execute concurrently. Most applications will use the locking_dispatcher -/// typedef. +/// execute concurrently. Most applications will use the +/// asio::locking_dispatcher typedef. template class basic_locking_dispatcher { diff --git a/asio/include/asio/basic_socket_acceptor.hpp b/asio/include/asio/basic_socket_acceptor.hpp index 98ea1340..200ead7a 100644 --- a/asio/include/asio/basic_socket_acceptor.hpp +++ b/asio/include/asio/basic_socket_acceptor.hpp @@ -27,7 +27,7 @@ namespace asio { /// The basic_socket_acceptor class template is used for accepting new socket -/// connections. Most applications would use the socket_acceptor typedef. +/// connections. Most applications would use the asio::socket_acceptor typedef. template class basic_socket_acceptor : private boost::noncopyable diff --git a/asio/include/asio/basic_socket_connector.hpp b/asio/include/asio/basic_socket_connector.hpp index 96364815..a38832b4 100644 --- a/asio/include/asio/basic_socket_connector.hpp +++ b/asio/include/asio/basic_socket_connector.hpp @@ -27,7 +27,8 @@ namespace asio { /// The basic_socket_connector class template is used to connect a socket to a -/// remote endpoint. Most applications will use the socket_connector typedef. +/// remote endpoint. Most applications will use the asio::socket_connector +/// typedef. template class basic_socket_connector : private boost::noncopyable diff --git a/asio/include/asio/basic_stream_socket.hpp b/asio/include/asio/basic_stream_socket.hpp index 8340c1c6..1fc4eada 100644 --- a/asio/include/asio/basic_stream_socket.hpp +++ b/asio/include/asio/basic_stream_socket.hpp @@ -28,7 +28,7 @@ namespace asio { /// The basic_stream_socket class template provides asynchronous and blocking /// stream-oriented socket functionality. Most applications will use the -/// stream_socket typedef. +/// asio::stream_socket typedef. template class basic_stream_socket : private boost::noncopyable diff --git a/asio/include/asio/basic_timer.hpp b/asio/include/asio/basic_timer.hpp index b62870db..2f41839a 100644 --- a/asio/include/asio/basic_timer.hpp +++ b/asio/include/asio/basic_timer.hpp @@ -27,7 +27,7 @@ namespace asio { /// The basic_timer class template provides asynchronous timer functionality. -/// Most applications will use the timer typedef. +/// Most applications will use the asio::timer typedef. template class basic_timer : public timer_base,