Doc tidying

This commit is contained in:
Vinnie Falco
2019-03-08 09:33:47 -08:00
parent b9aad3d06c
commit d2041c0322
3 changed files with 17 additions and 9 deletions

View File

@@ -474,7 +474,7 @@ in future versions.
* ([issue 1109]) Use a shared string for example HTTP server doc roots
* ([issue 1079]) Add [link beast.ref.boost__beast__handler_ptr.has_value `handler_ptr::has_value`]
* ([issue 1079]) Add `handler_ptr::has_value`
[*Fixes]
@@ -639,15 +639,15 @@ to update to the latest Boost release.
[*API Changes]
* Remove unintended public members of
[link beast.ref.boost__beast__handler_ptr `handler_ptr`].
`handler_ptr`.
Actions required: don't call non-public members.
* [link beast.ref.boost__beast__handler_ptr `handler_ptr`]
* `handler_ptr`
is a move-only type, with `unique_ptr` semantics.
Actions required: user-defined composed operations using `handler_ptr`
to manage state can only be moved, not copied.
* [link beast.ref.boost__beast__handler_ptr `handler_ptr`]
* `handler_ptr`
gives the strong exception guarantee. The constructor signature
for managed objects constructed by `handler_ptr` now receives a
`const` reference to the handler. Actions required: Change the

View File

@@ -47,9 +47,9 @@ PREDEFINED = \
BOOST_BEAST_USE_POSIX_FILE=1 \
BOOST_BEAST_USE_WIN32_FILE=1 \
BOOST_BEAST_SPLIT_COMPILATION=1 \
BOOST_BEAST_ASYNC_RESULT1(t)=__deduced__ \
BOOST_BEAST_ASYNC_RESULT1(t)=__deduced__ \
BOOST_ASIO_INITFN_RESULT_TYPE(t,a)=__deduced__ \
"BOOST_BEAST_ASYNC_RESULT1(t)=__deduced__" \
"BOOST_BEAST_ASYNC_RESULT1(t)=__deduced__" \
"BOOST_ASIO_INITFN_RESULT_TYPE(t,a)=__deduced__" \
GENERATING_DOCUMENTATION \
BOOST_BEAST_DECL
EXPAND_AS_DEFINED =

View File

@@ -317,12 +317,16 @@ template<
class AsyncReadStream,
class DynamicBuffer,
class CompletionToken>
#if BOOST_BEAST_DOXYGEN
BOOST_ASIO_INITFN_RESULT_TYPE(CompletionToken, void(error_code, bool))
#else
auto
#endif
async_detect_ssl(
AsyncReadStream& stream,
DynamicBuffer& buffer,
CompletionToken&& token)
-> typename net::async_result<
CompletionToken&& token) ->
typename net::async_result<
typename std::decay<CompletionToken>::type, /*< `async_result` customizes the return value based on the completion token >*/
void(error_code, bool)>::return_type; /*< This is the signature for the completion handler >*/
//]
@@ -388,7 +392,11 @@ template<
class AsyncReadStream,
class DynamicBuffer,
class CompletionToken>
#if BOOST_BEAST_DOXYGEN
BOOST_ASIO_INITFN_RESULT_TYPE(CompletionToken, void(error_code, bool))
#else
auto
#endif
async_detect_ssl(
AsyncReadStream& stream,
DynamicBuffer& buffer,