Skip to content

Commit 52ff89c

Browse files
committed
Fix documentation typos.
1 parent 992db3c commit 52ff89c

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

include/asio/inline_executor.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ class basic_inline_executor
139139
public:
140140
/// Compare two executors for equality.
141141
/**
142-
* Two executors are equal if they refer to the same underlying io_context.
142+
* Two inline executors are always considered equal.
143143
*/
144144
friend bool operator==(const basic_inline_executor&,
145145
const basic_inline_executor&) noexcept
@@ -149,7 +149,7 @@ class basic_inline_executor
149149

150150
/// Compare two executors for inequality.
151151
/**
152-
* Two executors are equal if they refer to the same underlying io_context.
152+
* Two inline executors are never considered unequal.
153153
*/
154154
friend bool operator!=(const basic_inline_executor&,
155155
const basic_inline_executor&) noexcept

include/asio/recycling_allocator.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ namespace asio {
2424

2525
/// An allocator that caches memory blocks in thread-local storage for reuse.
2626
/**
27-
* The @recycling_allocator uses a simple strategy where a limited number of
27+
* The @c recycling_allocator uses a simple strategy where a limited number of
2828
* small memory blocks are cached in thread-local storage, if the current
2929
* thread is running an @c io_context or is part of a @c thread_pool.
3030
*/
@@ -85,7 +85,7 @@ class recycling_allocator
8585
/// A proto-allocator that caches memory blocks in thread-local storage for
8686
/// reuse.
8787
/**
88-
* The @recycling_allocator uses a simple strategy where a limited number of
88+
* The @c recycling_allocator uses a simple strategy where a limited number of
8989
* small memory blocks are cached in thread-local storage, if the current
9090
* thread is running an @c io_context or is part of a @c thread_pool.
9191
*/

src/doc/overview/cpp20_coroutines.qbk

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ passed back to the coroutine as a `system_error` exception.
9090
To perform explicit error handling, rather than the default exception-throwing
9191
behaviour, use the [link asio.reference.as_tuple `as_tuple`],
9292
[link asio.reference.redirect_disposition `redirect_disposition`] or
93-
[link asio.reference.redirect_error `redirect_error`] or completion token
93+
[link asio.reference.redirect_error `redirect_error`] completion token
9494
adapters.
9595

9696
The `as_tuple` completion token adapter packages the completion

src/doc/overview/token_adapters.qbk

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ expression will no longer throw an exception on resumption.
123123
asio::awaitable<void> my_coroutine()
124124
{
125125
// ...
126-
std::exception my_exception;
126+
std::exception_ptr my_exception;
127127
std::size_t bytes_transferred =
128128
co_await my_socket.async_read_some(my_buffer,
129129
asio::redirect_disposition(asio::use_awaitable, my_exception));

0 commit comments

Comments
 (0)