Tidy up test::stream javadocs

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
 
 --------------------------------------------------------------------------------
 

doc/qbk/quickref.xml

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

include/boost/beast/experimental/core/flat_stream.hpp

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

include/boost/beast/experimental/test/stream.hpp

@@ -472,7 +472,7 @@ public:
     template<class ConstBufferSequence>
     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<class... Args>
+stream
+connect(stream& to, Args&&... args);
+
+#else
 stream
 connect(stream& to);
 
-/// Create and return a connected stream
 template<class Arg1, class... ArgN>
 stream
 connect(stream& to, Arg1&& arg1, ArgN&&... argn);
+#endif
 
 } // test
 } // beast

include/boost/beast/http/fields.hpp

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

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<deflateSupported>
 #endif
 {