Tidy up docs

example/echo-op/echo_op.cpp

@@ -76,6 +76,7 @@ async_echo (AsyncStream& stream, DynamicBuffer& buffer, CompletionToken&& token)
         beast::error_code error      // Result of operation.
     );
     @endcode
+    
     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

include/boost/beast/_experimental/http/icy_stream.hpp

@@ -295,10 +295,13 @@ public:
         performing a decay-copy. The equivalent function signature of
         the handler must be:
 
-        @code void handler(
+        @code
-          const boost::system::error_code& error, // Result of operation.
+        void handler(
-          std::size_t bytes_transferred           // Number of bytes written.
+          error_code const& error,          // Result of operation.
-        ); @endcode
+          std::size_t bytes_transferred     // Number of bytes written.
+        );
+        @endcode
+
         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

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

@@ -394,6 +394,7 @@ public:
             std::size_t bytes_transferred   // Number of bytes read.
         );
         @endcode
+        
         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
@@ -469,9 +470,10 @@ public:
         @code
         void handler(
             error_code const& ec,           // Result of operation.
-          std::size_t bytes_transferred     // Number of bytes written.
+            std::size_t bytes_transferred   // Number of bytes written.
         );
         @endcode
+        
         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

include/boost/beast/core/basic_stream.hpp

@@ -893,6 +893,7 @@ public:
             error_code ec         // Result of operation
         );
         @endcode
+        
         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
@@ -944,6 +945,7 @@ public:
             typename Protocol::endpoint const& endpoint
         );
         @endcode
+        
         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
@@ -1014,6 +1016,7 @@ public:
             typename Protocol::endpoint const& endpoint
         );
         @endcode
+        
         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
@@ -1092,6 +1095,7 @@ public:
             Iterator iterator
         );
         @endcode
+        
         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
@@ -1148,6 +1152,7 @@ public:
             Iterator iterator
         );
         @endcode
+        
         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
@@ -1266,6 +1271,7 @@ public:
             std::size_t bytes_transferred   // Number of bytes read.
         );
         @endcode
+        
         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
@@ -1385,6 +1391,7 @@ public:
             std::size_t bytes_transferred   // Number of bytes written.
         );
         @endcode
+        
         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

include/boost/beast/core/buffered_read_stream.hpp

@@ -257,6 +257,7 @@ public:
             std::size_t bytes_transferred // number of bytes transferred
         );
         @endcode
+        
         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
@@ -333,6 +334,7 @@ public:
             std::size_t bytes_transferred // number of bytes transferred
         );
         @endcode
+        
         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

include/boost/beast/core/detail/read.hpp

@@ -211,6 +211,7 @@ read(
                                             // prior to the error.
     );
     @endcode
+
     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

include/boost/beast/core/flat_stream.hpp

@@ -239,9 +239,10 @@ public:
         @code
         void handler(
             error_code const& error,        // Result of operation.
-          std::size_t bytes_transferred     // Number of bytes read.
+            std::size_t bytes_transferred   // Number of bytes read.
         );
         @endcode
+        
         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
@@ -320,10 +321,11 @@ public:
 
         @code
         void handler(
-          error_code const& ec,             // Result of operation.
+            error_code const& ec,           // Result of operation.
-          std::size_t bytes_transferred     // Number of bytes written.
+            std::size_t bytes_transferred   // Number of bytes written.
         );
         @endcode
+        
         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

include/boost/beast/http/read.hpp

@@ -192,6 +192,7 @@ read_some(
         std::size_t bytes_transferred   // the total number of bytes transferred from the stream
     );
     @endcode
+    
     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
@@ -385,6 +386,7 @@ read_header(
         std::size_t bytes_transferred   // the total number of bytes transferred from the stream
     );
     @endcode
+    
     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
@@ -580,6 +582,7 @@ read(
         std::size_t bytes_transferred   // the total number of bytes transferred from the stream
     );
     @endcode
+    
     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
@@ -784,6 +787,7 @@ read(
         std::size_t bytes_transferred   // the total number of bytes transferred from the stream
     );
     @endcode
+    
     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

include/boost/beast/http/write.hpp

@@ -160,6 +160,7 @@ write_some(
         std::size_t bytes_transferred   // the number of bytes written to the stream
     );
     @endcode
+    
     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
@@ -285,6 +286,7 @@ write_header(
         std::size_t bytes_transferred   // the number of bytes written to the stream
     );
     @endcode
+    
     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
@@ -407,6 +409,7 @@ write(
         std::size_t bytes_transferred   // the number of bytes written to the stream
     );
     @endcode
+    
     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
@@ -630,6 +633,7 @@ write(
         std::size_t bytes_transferred   // the number of bytes written to the stream
     );
     @endcode
+    
     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
@@ -692,6 +696,7 @@ async_write(
         std::size_t bytes_transferred   // the number of bytes written to the stream
     );
     @endcode
+    
     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

include/boost/beast/websocket/ssl.hpp

@@ -65,6 +65,7 @@ teardown(
         error_code const& error // result of operation
     );
     @endcode
+    
     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

include/boost/beast/websocket/stream.hpp

@@ -861,6 +861,7 @@ public:
             error_code const& ec    // Result of operation
         );
         @endcode
+        
         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
@@ -940,6 +941,7 @@ public:
             error_code const& ec    // Result of operation
         );
         @endcode
+        
         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
@@ -1278,6 +1280,7 @@ public:
             error_code const& ec    // Result of operation
         );
         @endcode
+        
         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
@@ -1341,6 +1344,7 @@ public:
             error_code const& ec    // Result of operation
         );
         @endcode
+        
         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
@@ -1404,6 +1408,7 @@ public:
             error_code const& ec    // Result of operation
         );
         @endcode
+        
         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
@@ -1538,6 +1543,7 @@ public:
             error_code const& ec     // Result of operation
         );
         @endcode
+        
         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
@@ -1638,6 +1644,7 @@ public:
             error_code const& ec     // Result of operation
         );
         @endcode
+        
         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
@@ -1741,6 +1748,7 @@ public:
             error_code const& ec     // Result of operation
         );
         @endcode
+        
         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
@@ -1897,6 +1905,7 @@ public:
             std::size_t bytes_written   // Number of bytes appended to buffer
         );
         @endcode
+        
         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
@@ -2072,6 +2081,7 @@ public:
             std::size_t bytes_written   // Number of bytes appended to buffer
         );
         @endcode
+        
         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
@@ -2243,6 +2253,7 @@ public:
             std::size_t bytes_written   // Number of bytes written to the buffers
         );
         @endcode
+        
         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
@@ -2362,6 +2373,7 @@ public:
                                             // this will be less than the buffer_size.
         );
         @endcode
+        
         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
@@ -2483,6 +2495,7 @@ public:
                                             // this will be less than the buffer_size.
         );
         @endcode
+        
         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

include/boost/beast/websocket/teardown.hpp

@@ -79,6 +79,7 @@ teardown(
         error_code const& error // result of operation
     );
     @endcode
+    
     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
@@ -160,6 +161,7 @@ teardown(
         error_code const& error // result of operation
     );
     @endcode
+    
     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