boostorg/beast
1
0
Fork 1
mirror of https://github.com/boostorg/beast.git synced 2025-07-30 21:07:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

Tidy up test::stream javadocs

Browse Source
This commit is contained in:
Vinnie Falco
2018-05-29 15:31:42 -07:00
parent 5b8eb1d87d
commit f5def127d8
6 changed files with 22 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -3,6 +3,7 @@ Version 172:
* Tidy up websocket stream javadocs * Tidy up websocket stream javadocs
* Fix move-only arguments in bind_handler * Fix move-only arguments in bind_handler
* Fix http::parser constructor javadoc * Fix http::parser constructor javadoc
* Tidy up test::stream javadocs
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------

1
doc/qbk/quickref.xml
View File

@ -310,6 +310,7 @@
<entry valign="top"> <entry valign="top">
<bridgehead renderas="sect3">Functions</bridgehead> <bridgehead renderas="sect3">Functions</bridgehead>
<simplelist type="vert" columns="1"> <simplelist type="vert" columns="1">
<member><link linkend="beast.ref.boost__beast__test__connect">test::connect</link></member>
</simplelist> </simplelist>
</entry> </entry>
<entry valign="top"> <entry valign="top">

2
include/boost/beast/experimental/core/flat_stream.hpp
View File

@ -79,7 +79,7 @@ namespace beast {
*/ */
template<class NextLayer> template<class NextLayer>
class flat_stream class flat_stream
#ifndef BOOST_BEAST_DOXYGEN #if ! BOOST_BEAST_DOXYGEN
: private detail::flat_stream_base : private detail::flat_stream_base
#endif #endif
{ {

21
include/boost/beast/experimental/test/stream.hpp
View File

@ -472,7 +472,7 @@ public:
template<class ConstBufferSequence> template<class ConstBufferSequence>
std::size_t std::size_t
write_some( write_some(
ConstBufferSequence const& buffers, error_code&); ConstBufferSequence const& buffers, error_code& ec);
/** Start an asynchronous write. /** Start an asynchronous write.
@ -502,7 +502,7 @@ public:
async_write_some(ConstBufferSequence const& buffers, async_write_some(ConstBufferSequence const& buffers,
WriteHandler&& handler); WriteHandler&& handler);
#ifndef BOOST_BEAST_DOXYGEN #if ! BOOST_BEAST_DOXYGEN
friend friend
void void
teardown( teardown(
@ -520,14 +520,27 @@ public:
#endif #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<class... Args>
stream
connect(stream& to, Args&&... args);
#else
stream stream
connect(stream& to); connect(stream& to);
/// Create and return a connected stream
template<class Arg1, class... ArgN> template<class Arg1, class... ArgN>
stream stream
connect(stream& to, Arg1&& arg1, ArgN&&... argn); connect(stream& to, Arg1&& arg1, ArgN&&... argn);
#endif
} // test } // test
} // beast } // beast

2
include/boost/beast/http/fields.hpp
View File

@ -52,7 +52,7 @@ namespace http {
*/ */
template<class Allocator> template<class Allocator>
class basic_fields class basic_fields
#ifndef BOOST_BEAST_DOXYGEN #if ! BOOST_BEAST_DOXYGEN
: private beast::detail::empty_base_optimization<Allocator> : private beast::detail::empty_base_optimization<Allocator>
#endif #endif
{ {

2
include/boost/beast/websocket/stream.hpp
View File

@ -125,7 +125,7 @@ template<
class NextLayer, class NextLayer,
bool deflateSupported> bool deflateSupported>
class stream class stream
#ifndef BOOST_BEAST_DOXYGEN #if ! BOOST_BEAST_DOXYGEN
: private detail::stream_base<deflateSupported> : private detail::stream_base<deflateSupported>
#endif #endif
{ {