From f5def127d8adf8112062eb23cf9d7c71d7a35aba Mon Sep 17 00:00:00 2001 From: Vinnie Falco Date: Tue, 29 May 2018 15:31:42 -0700 Subject: [PATCH] Tidy up test::stream javadocs --- CHANGELOG.md | 1 + doc/qbk/quickref.xml | 1 + .../beast/experimental/core/flat_stream.hpp | 2 +- .../boost/beast/experimental/test/stream.hpp | 21 +++++++++++++++---- include/boost/beast/http/fields.hpp | 2 +- include/boost/beast/websocket/stream.hpp | 2 +- 6 files changed, 22 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0bc680b9..5ac6714c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ Version 172: * Tidy up websocket stream javadocs * Fix move-only arguments in bind_handler * Fix http::parser constructor javadoc +* Tidy up test::stream javadocs -------------------------------------------------------------------------------- diff --git a/doc/qbk/quickref.xml b/doc/qbk/quickref.xml index bd686346..6559e2f1 100644 --- a/doc/qbk/quickref.xml +++ b/doc/qbk/quickref.xml @@ -310,6 +310,7 @@ Functions + test::connect diff --git a/include/boost/beast/experimental/core/flat_stream.hpp b/include/boost/beast/experimental/core/flat_stream.hpp index f45275f8..329a4ae6 100644 --- a/include/boost/beast/experimental/core/flat_stream.hpp +++ b/include/boost/beast/experimental/core/flat_stream.hpp @@ -79,7 +79,7 @@ namespace beast { */ template class flat_stream -#ifndef BOOST_BEAST_DOXYGEN +#if ! BOOST_BEAST_DOXYGEN : private detail::flat_stream_base #endif { diff --git a/include/boost/beast/experimental/test/stream.hpp b/include/boost/beast/experimental/test/stream.hpp index 005f8116..d583e796 100644 --- a/include/boost/beast/experimental/test/stream.hpp +++ b/include/boost/beast/experimental/test/stream.hpp @@ -472,7 +472,7 @@ public: template std::size_t write_some( - ConstBufferSequence const& buffers, error_code&); + ConstBufferSequence const& buffers, error_code& ec); /** Start an asynchronous write. @@ -502,7 +502,7 @@ public: async_write_some(ConstBufferSequence const& buffers, WriteHandler&& handler); -#ifndef BOOST_BEAST_DOXYGEN +#if ! BOOST_BEAST_DOXYGEN friend void teardown( @@ -520,14 +520,27 @@ public: #endif }; -/// Create and return a connected stream +#if BOOST_BEAST_DOXYGEN +/** Return a new stream connected to the given stream + + @param to The stream to connect to. + + @param args Optional arguments forwarded to the new stream's constructor. + + @return The new, connected stream. +*/ +template +stream +connect(stream& to, Args&&... args); + +#else stream connect(stream& to); -/// Create and return a connected stream template stream connect(stream& to, Arg1&& arg1, ArgN&&... argn); +#endif } // test } // beast diff --git a/include/boost/beast/http/fields.hpp b/include/boost/beast/http/fields.hpp index 59cb338b..bde3b7a6 100644 --- a/include/boost/beast/http/fields.hpp +++ b/include/boost/beast/http/fields.hpp @@ -52,7 +52,7 @@ namespace http { */ template class basic_fields -#ifndef BOOST_BEAST_DOXYGEN +#if ! BOOST_BEAST_DOXYGEN : private beast::detail::empty_base_optimization #endif { diff --git a/include/boost/beast/websocket/stream.hpp b/include/boost/beast/websocket/stream.hpp index a8537dd1..79c80ef9 100644 --- a/include/boost/beast/websocket/stream.hpp +++ b/include/boost/beast/websocket/stream.hpp @@ -125,7 +125,7 @@ template< class NextLayer, bool deflateSupported> class stream -#ifndef BOOST_BEAST_DOXYGEN +#if ! BOOST_BEAST_DOXYGEN : private detail::stream_base #endif {