Skip to content

Commit

Permalink
Add completion token cross-references.
Browse files Browse the repository at this point in the history
  • Loading branch information
chriskohlhoff committed Apr 5, 2022
1 parent d2fe233 commit 419fd52
Show file tree
Hide file tree
Showing 11 changed files with 47 additions and 43 deletions.
36 changes: 18 additions & 18 deletions doc/reference.qbk
Original file line number Diff line number Diff line change
Expand Up @@ -67468,7 +67468,7 @@ The [link boost_asio.reference.basic_writable_pipe `basic_writable_pipe`] class
[indexterm1 boost_asio.indexterm.basic_yield_context..basic_yield_context]


A completion token that represents the currently executing coroutine.
A [link boost_asio.overview.model.completion_tokens completion token] that represents the currently executing coroutine.


template<
Expand Down Expand Up @@ -78857,7 +78857,7 @@ Submits a completion token or function object for execution.

[indexterm1 boost_asio.indexterm.detached..detached]

A special value, similar to std::nothrow.
A [link boost_asio.overview.model.completion_tokens completion token] object used to specify that an asynchronous operation is detached.


constexpr detached_t detached;
Expand All @@ -78880,7 +78880,7 @@ See the documentation for [link boost_asio.reference.detached_t `detached_t`] fo
[indexterm1 boost_asio.indexterm.detached_t..detached_t]


Class used to specify that an asynchronous operation is detached.
A [link boost_asio.overview.model.completion_tokens completion token] type used to specify that an asynchronous operation is detached.


class detached_t
Expand Down Expand Up @@ -91805,7 +91805,7 @@ Constructor.

[indexterm1 boost_asio.indexterm.experimental__as_single..experimental::as_single]

Create a completion token to specify that the completion handler arguments should be combined into a single argument.
Adapt a [link boost_asio.overview.model.completion_tokens completion token] to specify that the completion handler arguments should be combined into a single argument.


template<
Expand All @@ -91829,7 +91829,7 @@ Create a completion token to specify that the completion handler arguments shoul
[indexterm1 boost_asio.indexterm.experimental__as_single_t..experimental::as_single_t]


Completion token type used to specify that the completion handler arguments should be combined into a single argument.
A [link boost_asio.overview.model.completion_tokens completion token] adapter used to specify that the completion handler arguments should be combined into a single argument.


template<
Expand Down Expand Up @@ -92185,7 +92185,7 @@ Convert the specified executor to the inner executor type, then use that to cons

[indexterm1 boost_asio.indexterm.experimental__as_tuple..experimental::as_tuple]

Create a completion token to specify that the completion handler arguments should be combined into a single tuple argument.
Adapt a [link boost_asio.overview.model.completion_tokens completion token] to specify that the completion handler arguments should be combined into a single tuple argument.


template<
Expand All @@ -92209,7 +92209,7 @@ Create a completion token to specify that the completion handler arguments shoul
[indexterm1 boost_asio.indexterm.experimental__as_tuple_t..experimental::as_tuple_t]


Completion token type used to specify that the completion handler arguments should be combined into a single tuple argument.
A [link boost_asio.overview.model.completion_tokens completion token] adapter used to specify that the completion handler arguments should be combined into a single tuple argument.


template<
Expand Down Expand Up @@ -95885,7 +95885,7 @@ Whether or not the coroutine is noexcept.

[indexterm1 boost_asio.indexterm.experimental__deferred..experimental::deferred]

A special value, similar to std::nothrow.
A [link boost_asio.overview.model.completion_tokens completion token] object used to specify that an asynchronous operation should return a function object to lazily launch the operation.


constexpr deferred_t deferred;
Expand Down Expand Up @@ -97097,7 +97097,7 @@ Launches the group and asynchronously waits for completion.

[[cancellation_condition][A function object, called on completion of an operation within the group, that is used to determine whether to cancel the remaining operations. The function object is passed the arguments of the completed operation's handler. To trigger cancellation of the remaining operations, it must return a [link boost_asio.reference.cancellation_type `cancellation_type`] value other than `boost::asio::cancellation_type::none`.]]

[[token][A completion token whose signature is comprised of a `std::array<std::size_t, N>` indicating the completion order of the operations, followed by all operations' completion handler arguments.]]
[[token][A [link boost_asio.overview.model.completion_tokens completion token] whose signature is comprised of a `std::array<std::size_t, N>` indicating the completion order of the operations, followed by all operations' completion handler arguments.]]

]

Expand Down Expand Up @@ -97745,7 +97745,7 @@ The primary template is not defined.

[indexterm1 boost_asio.indexterm.experimental__use_coro..experimental::use_coro]

A completion token object that represents the currently executing resumable coroutine.
A [link boost_asio.overview.model.completion_tokens completion token] object that represents the currently executing resumable coroutine.


constexpr use_coro_t use_coro;
Expand All @@ -97768,7 +97768,7 @@ See the documentation for boost::asio::use\_coro\_t for a usage example.
[indexterm1 boost_asio.indexterm.experimental__use_coro_t..experimental::use_coro_t]


A completion token that represents the currently executing resumable coroutine.
A [link boost_asio.overview.model.completion_tokens completion token] that represents the currently executing resumable coroutine.


template<
Expand Down Expand Up @@ -140626,7 +140626,7 @@ The uses a simple strategy where a limited number of small memory blocks are ca

[indexterm1 boost_asio.indexterm.redirect_error..redirect_error]

Create a completion token to capture error\_code values to a variable.
Adapt a [link boost_asio.overview.model.completion_tokens completion token] to capture error\_code values to a variable.


template<
Expand All @@ -140651,7 +140651,7 @@ Create a completion token to capture error\_code values to a variable.
[indexterm1 boost_asio.indexterm.redirect_error_t..redirect_error_t]


Completion token type used to specify that an error produced by an asynchronous operation is captured to an error\_code variable.
A [link boost_asio.overview.model.completion_tokens completion token] adapter used to specify that an error produced by an asynchronous operation is captured to an error\_code variable.


template<
Expand Down Expand Up @@ -155888,7 +155888,7 @@ Reading until a buffer is full or contains exactly 64 bytes:

[indexterm1 boost_asio.indexterm.use_awaitable..use_awaitable]

A completion token object that represents the currently executing coroutine.
A [link boost_asio.overview.model.completion_tokens completion token] object that represents the currently executing coroutine.


constexpr use_awaitable_t use_awaitable;
Expand All @@ -155911,7 +155911,7 @@ See the documentation for [link boost_asio.reference.use_awaitable_t `use_awaita
[indexterm1 boost_asio.indexterm.use_awaitable_t..use_awaitable_t]


A completion token that represents the currently executing coroutine.
A [link boost_asio.overview.model.completion_tokens completion token] that represents the currently executing coroutine.


template<
Expand Down Expand Up @@ -156179,7 +156179,7 @@ Construct the adapted executor from the inner executor type.

[indexterm1 boost_asio.indexterm.use_future..use_future]

A completion token object that causes an asynchronous operation to return a future.
A [link boost_asio.overview.model.completion_tokens completion token] object that causes an asynchronous operation to return a future.


constexpr use_future_t use_future;
Expand All @@ -156202,7 +156202,7 @@ See the documentation for [link boost_asio.reference.use_future_t `use_future_t`
[indexterm1 boost_asio.indexterm.use_future_t..use_future_t]


A completion token type that causes an asynchronous operation to return a future.
A [link boost_asio.overview.model.completion_tokens completion token] type that causes an asynchronous operation to return a future.


template<
Expand Down Expand Up @@ -164868,7 +164868,7 @@ The number of bytes written. If an error occurs, returns the total number of byt

[indexterm1 boost_asio.indexterm.yield_context..yield_context]

Context object that represents the currently executing coroutine.
A [link boost_asio.overview.model.completion_tokens completion token] object that represents the currently executing coroutine.


typedef basic_yield_context< unspecified > yield_context;
Expand Down
9 changes: 5 additions & 4 deletions include/boost/asio/detached.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@
namespace boost {
namespace asio {

/// Class used to specify that an asynchronous operation is detached.
/// A @ref completion_token type used to specify that an asynchronous operation
/// is detached.
/**
* The detached_t class is used to indicate that an asynchronous operation is
* detached. That is, there is no completion handler waiting for the
* operation's result. A detached_t object may be passed as a handler to an
* asynchronous operation, typically using the special value
* @c boost::asio::detached. For example:
*
* @code my_socket.async_send(my_buffer, boost::asio::detached);
* @endcode
*/
Expand Down Expand Up @@ -94,7 +94,8 @@ class detached_t
}
};

/// A special value, similar to std::nothrow.
/// A @ref completion_token object used to specify that an asynchronous
/// operation is detached.
/**
* See the documentation for boost::asio::detached_t for a usage example.
*/
Expand Down
6 changes: 3 additions & 3 deletions include/boost/asio/experimental/as_single.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ namespace boost {
namespace asio {
namespace experimental {

/// Completion token type used to specify that the completion handler
/// A @ref completion_token adapter used to specify that the completion handler
/// arguments should be combined into a single argument.
/**
* The as_single_t class is used to indicate that any arguments to the
Expand Down Expand Up @@ -116,8 +116,8 @@ class as_single_t
CompletionToken token_;
};

/// Create a completion token to specify that the completion handler arguments
/// should be combined into a single argument.
/// Adapt a @ref completion_token to specify that the completion handler
/// arguments should be combined into a single argument.
template <typename CompletionToken>
BOOST_ASIO_NODISCARD inline
BOOST_ASIO_CONSTEXPR as_single_t<typename decay<CompletionToken>::type>
Expand Down
6 changes: 3 additions & 3 deletions include/boost/asio/experimental/as_tuple.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ namespace boost {
namespace asio {
namespace experimental {

/// Completion token type used to specify that the completion handler
/// A @ref completion_token adapter used to specify that the completion handler
/// arguments should be combined into a single tuple argument.
/**
* The as_tuple_t class is used to indicate that any arguments to the
Expand Down Expand Up @@ -112,8 +112,8 @@ class as_tuple_t
CompletionToken token_;
};

/// Create a completion token to specify that the completion handler arguments
/// should be combined into a single tuple argument.
/// Adapt a @ref completion_token to specify that the completion handler
/// arguments should be combined into a single tuple argument.
template <typename CompletionToken>
BOOST_ASIO_NODISCARD inline
BOOST_ASIO_CONSTEXPR as_tuple_t<typename decay<CompletionToken>::type>
Expand Down
3 changes: 2 additions & 1 deletion include/boost/asio/experimental/deferred.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -585,7 +585,8 @@ inline auto operator|(Head head, BOOST_ASIO_MOVE_ARG(Tail) tail)
BOOST_ASIO_MOVE_CAST(Tail)(tail));
}

/// A special value, similar to std::nothrow.
/// A @ref completion_token object used to specify that an asynchronous
/// operation should return a function object to lazily launch the operation.
/**
* See the documentation for boost::asio::experimental::deferred_t for a usage
* example.
Expand Down
2 changes: 1 addition & 1 deletion include/boost/asio/experimental/parallel_group.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ class parallel_group
* operations, it must return a boost::asio::cancellation_type value other
* than <tt>boost::asio::cancellation_type::none</tt>.
*
* @param token A completion token whose signature is comprised of
* @param token A @ref completion_token whose signature is comprised of
* a @c std::array<std::size_t, N> indicating the completion order of the
* operations, followed by all operations' completion handler arguments.
*
Expand Down
6 changes: 3 additions & 3 deletions include/boost/asio/experimental/use_coro.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ class any_io_executor;

namespace experimental {

/// A completion token that represents the currently executing resumable
/// A @ref completion_token that represents the currently executing resumable
/// coroutine.
/**
* The @c use_coro_t class, with its value @c use_coro, is used to represent an
Expand Down Expand Up @@ -146,8 +146,8 @@ struct use_coro_t
#endif // defined(BOOST_ASIO_ENABLE_HANDLER_TRACKING)
};

/// A completion token object that represents the currently executing resumable
/// coroutine.
/// A @ref completion_token object that represents the currently executing
/// resumable coroutine.
/**
* See the documentation for boost::asio::use_coro_t for a usage example.
*/
Expand Down
4 changes: 2 additions & 2 deletions include/boost/asio/redirect_error.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
namespace boost {
namespace asio {

/// Completion token type used to specify that an error produced by an
/// A @ref completion_token adapter used to specify that an error produced by an
/// asynchronous operation is captured to an error_code variable.
/**
* The redirect_error_t class is used to indicate that any error_code produced
Expand All @@ -48,7 +48,7 @@ class redirect_error_t
boost::system::error_code& ec_;
};

/// Create a completion token to capture error_code values to a variable.
/// Adapt a @ref completion_token to capture error_code values to a variable.
template <typename CompletionToken>
inline redirect_error_t<typename decay<CompletionToken>::type> redirect_error(
BOOST_ASIO_MOVE_ARG(CompletionToken) completion_token,
Expand Down
5 changes: 3 additions & 2 deletions include/boost/asio/spawn.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
namespace boost {
namespace asio {

/// A completion token that represents the currently executing coroutine.
/// A @ref completion_token that represents the currently executing coroutine.
/**
* The basic_yield_context class is a completion token type that is used to
* represent the currently executing stackful coroutine. A basic_yield_context
Expand Down Expand Up @@ -149,7 +149,8 @@ class basic_yield_context
};

#if defined(GENERATING_DOCUMENTATION)
/// Context object that represents the currently executing coroutine.
/// A @ref completion_token object that represents the currently executing
/// coroutine.
typedef basic_yield_context<unspecified> yield_context;
#else // defined(GENERATING_DOCUMENTATION)
typedef basic_yield_context<
Expand Down
5 changes: 3 additions & 2 deletions include/boost/asio/use_awaitable.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
namespace boost {
namespace asio {

/// A completion token that represents the currently executing coroutine.
/// A @ref completion_token that represents the currently executing coroutine.
/**
* The @c use_awaitable_t class, with its value @c use_awaitable, is used to
* represent the currently executing coroutine. This completion token may be
Expand Down Expand Up @@ -144,7 +144,8 @@ struct use_awaitable_t
#endif // defined(BOOST_ASIO_ENABLE_HANDLER_TRACKING)
};

/// A completion token object that represents the currently executing coroutine.
/// A @ref completion_token object that represents the currently executing
/// coroutine.
/**
* See the documentation for boost::asio::use_awaitable_t for a usage example.
*/
Expand Down
8 changes: 4 additions & 4 deletions include/boost/asio/use_future.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ class packaged_handler;

} // namespace detail

/// A completion token type that causes an asynchronous operation to return a
/// future.
/// A @ref completion_token type that causes an asynchronous operation to return
/// a future.
/**
* The use_future_t class is a completion token type that is used to indicate
* that an asynchronous operation should return a std::future object. A
Expand Down Expand Up @@ -141,8 +141,8 @@ class use_future_t
std_allocator_void, Allocator>::type allocator_;
};

/// A completion token object that causes an asynchronous operation to return a
/// future.
/// A @ref completion_token object that causes an asynchronous operation to
/// return a future.
/**
* See the documentation for boost::asio::use_future_t for a usage example.
*/
Expand Down

0 comments on commit 419fd52

Please sign in to comment.