Some documentation fixes.
This commit is contained in:
parent
1e8818607f
commit
83634b0939
@ -30,9 +30,9 @@
|
||||
namespace asio {
|
||||
|
||||
/// The basic_demuxer class template provides the core event demultiplexing
|
||||
/// functionality for both users of the asynchronous I/O objects, such as
|
||||
/// stream_socket, and to developers of custom asynchronous services. Most
|
||||
/// applications will simply use the demuxer typedef.
|
||||
/// 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.
|
||||
template <typename Demuxer_Service>
|
||||
class basic_demuxer
|
||||
: private boost::noncopyable
|
||||
|
@ -27,8 +27,8 @@
|
||||
namespace asio {
|
||||
|
||||
/// The basic_dgram_socket class template provides asynchronous and blocking
|
||||
/// datagram-oriented socket functionality. Most applications will simply use
|
||||
/// the dgram_socket typedef.
|
||||
/// datagram-oriented socket functionality. Most applications will use the
|
||||
/// dgram_socket typedef.
|
||||
template <typename Service>
|
||||
class basic_dgram_socket
|
||||
: private boost::noncopyable
|
||||
|
@ -27,8 +27,7 @@
|
||||
namespace asio {
|
||||
|
||||
/// The basic_socket_acceptor class template is used for accepting new socket
|
||||
/// connections. Most applications would simply use the socket_acceptor
|
||||
/// typedef.
|
||||
/// connections. Most applications would use the socket_acceptor typedef.
|
||||
template <typename Service>
|
||||
class basic_socket_acceptor
|
||||
: private boost::noncopyable
|
||||
|
@ -27,8 +27,7 @@
|
||||
namespace asio {
|
||||
|
||||
/// The basic_socket_connector class template is used to connect a socket to a
|
||||
/// remote endpoint. Most applications will simply use the socket_connector
|
||||
/// typedef.
|
||||
/// remote endpoint. Most applications will use the socket_connector typedef.
|
||||
template <typename Service>
|
||||
class basic_socket_connector
|
||||
: private boost::noncopyable
|
||||
|
@ -27,7 +27,7 @@
|
||||
namespace asio {
|
||||
|
||||
/// The basic_stream_socket class template provides asynchronous and blocking
|
||||
/// stream-oriented socket functionality. Most applications will simply use the
|
||||
/// stream-oriented socket functionality. Most applications will use the
|
||||
/// stream_socket typedef.
|
||||
template <typename Service>
|
||||
class basic_stream_socket
|
||||
|
@ -28,7 +28,7 @@
|
||||
namespace asio {
|
||||
|
||||
/// The basic_timer class template provides asynchronous timer functionality.
|
||||
/// Most applications will simply use the timer typedef.
|
||||
/// Most applications will use the timer typedef.
|
||||
template <typename Service>
|
||||
class basic_timer
|
||||
: public timer_base,
|
||||
|
@ -39,7 +39,7 @@ namespace detail
|
||||
/// The completion_context class is the abstract base class for all completion
|
||||
/// context implementations. A completion context is used to determine when
|
||||
/// an upcall can be made to the completion handler of an asynchronous
|
||||
/// operations.
|
||||
/// operation.
|
||||
class null_completion_context
|
||||
: private boost::noncopyable
|
||||
{
|
||||
@ -65,7 +65,7 @@ public:
|
||||
* to a completion handler. This function always returns a result
|
||||
* immediately.
|
||||
*
|
||||
* If the right to make an upcall was successfully acquired, then the a later
|
||||
* If the right to make an upcall was successfully acquired, then a later
|
||||
* call must be made to the release() function to relinquish that right.
|
||||
*
|
||||
* @return Returns true if the right to make an upcall was granted.
|
||||
@ -77,11 +77,8 @@ public:
|
||||
|
||||
/// Acquire the right to make an upcall.
|
||||
/**
|
||||
|
||||
* This function is called to obtain
|
||||
* the right to make an upcall to a completion handler. The
|
||||
* handler will be
|
||||
* called when the right is granted.
|
||||
* This function is called to obtain the right to make an upcall to a
|
||||
* completion handler. The handler will be called when the right is granted.
|
||||
*
|
||||
* @param handler The function object to be called when the right is granted.
|
||||
*/
|
||||
|
Loading…
Reference in New Issue
Block a user