Doc tidying

This commit is contained in:
Vinnie Falco
2019-02-20 19:09:21 -08:00
parent c681241d70
commit 2b92189b65
19 changed files with 360 additions and 229 deletions
+6 -4
View File
@@ -211,9 +211,11 @@ detect_ssl(
@param buffer The dynamic buffer to use. This type must meet the
requirements of @b DynamicBuffer.
@param handler Invoked when the operation completes.
The handler may be moved or copied as needed.
The equivalent function signature of the handler must be:
@param handler The completion handler to invoke when the operation
completes. The implementation takes ownership of the handler by
performing a decay-copy. The equivalent function signature of
the handler must be:
@code
void handler(
error_code const& error, // Set to the error, if any
@@ -223,7 +225,7 @@ detect_ssl(
Regardless of whether the asynchronous operation completes
immediately or not, the handler will not be invoked from within
this function. Invocation of the handler will be performed in a
manner equivalent to using `boost::asio::io_context::post`.
manner equivalent to using `net::post`.
*/
template<
class AsyncReadStream,
+2 -2
View File
@@ -69,8 +69,8 @@ async_echo (AsyncStream& stream, DynamicBuffer& buffer, CompletionToken&& token)
extended least until the completion handler is invoked.
@param token The handler to be called when the operation completes.
The implementation will take ownership of the handler by move
construction. The handler must be invocable with this signature:
The implementation takes ownership of the handler by performing a decay-copy.
The handler must be invocable with this signature:
@code
void handler(
beast::error_code error // Result of operation.