Fix API reference

doc/Jamfile

@@ -42,6 +42,7 @@ docca.reference reference.qbk
             \"BOOST_BEAST_ASYNC_TPARAM1=class\" \\
             \"BOOST_BEAST_ASYNC_TPARAM2=class\" \\
             \"BOOST_ASIO_INITFN_RESULT_TYPE(t,a)=__deduced__\" \\
+            \"BOOST_ASIO_DEFAULT_COMPLETION_TOKEN(e)= =__deduced__\" \\
             \"BOOST_ASIO_COMPLETION_TOKEN_FOR(sig)=class\" \\
             GENERATING_DOCUMENTATION \\
             BOOST_BEAST_DECL"

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

@@ -234,7 +234,7 @@ public:
 
         The stream will be created in a disconnected state.
 
-        @param ioc The `io_context` object that the stream will use to
+        @param context The `io_context` object that the stream will use to
         dispatch handlers for any asynchronous operations.
     */
     template <typename ExecutionContext>

include/boost/beast/core/async_base.hpp

@@ -191,7 +191,7 @@ class async_base
 public:
     /** The type of executor associated with this object.
 
-    If a class derived from @ref async_base is a completion
+    If a class derived from @ref boost::beast::async_base is a completion
     handler, then the associated executor of the derived class will
     be this type.
 */
@@ -275,7 +275,7 @@ public:
 
     /** The type of allocator associated with this object.
 
-        If a class derived from @ref async_base is a completion
+        If a class derived from @ref boost::beast::async_base is a completion
         handler, then the associated allocator of the derived class will
         be this type.
     */
@@ -284,7 +284,7 @@ public:
 
     /** Returns the allocator associated with this object.
 
-        If a class derived from @ref async_base is a completion
+        If a class derived from @ref boost::beast::async_base is a completion
         handler, then the object returned from this function will be used
         as the associated allocator of the derived class.
     */
@@ -297,7 +297,7 @@ public:
 
     /** Returns the executor associated with this object.
 
-        If a class derived from @ref async_base is a completion
+        If a class derived from @ref boost::beast::async_base is a completion
         handler, then the object returned from this function will be used
         as the associated executor of the derived class.
     */
@@ -332,16 +332,17 @@ public:
 
         This invokes the final completion handler with the specified
         arguments forwarded. It is undefined to call either of
-        @ref complete or @ref complete_now more than once.
+        @ref boost::beast::async_base::complete or
+        @ref boost::beast::async_base::complete_now more than once.
 
-        Any temporary objects allocated with @ref beast::allocate_stable will
+        Any temporary objects allocated with @ref boost::beast::allocate_stable will
         be automatically destroyed before the final completion handler
         is invoked.
 
         @param is_continuation If this value is `false`, then the
         handler will be submitted to the executor using `net::post`.
         Otherwise the handler will be invoked as if by calling
-        @ref complete_now.
+        @ref boost::beast::async_base::complete_now.
 
         @param args A list of optional parameters to invoke the handler
         with. The completion handler must be invocable with the parameter
@@ -373,9 +374,9 @@ public:
 
         This invokes the final completion handler with the specified
         arguments forwarded. It is undefined to call either of
-        @ref complete or @ref complete_now more than once.
+        @ref boost::beast::async_base::complete or @ref boost::beast::async_base::complete_now more than once.
 
-        Any temporary objects allocated with @ref beast::allocate_stable will
+        Any temporary objects allocated with @ref boost::beast::allocate_stable will
         be automatically destroyed before the final completion handler
         is invoked.
 

include/boost/beast/core/buffers_generator.hpp

@@ -136,7 +136,7 @@ write(
     stream.
 
     This function is used to write all of the buffers generated
-    by a caller-provided @ref BuffersGenerator to a stream. The
+    by a caller-provided `BuffersGenerator` to a stream. The
     function call always returns immediately. The asynchronous
     operation will continue until one of the following
     conditions is true:
@@ -156,7 +156,7 @@ write(
 
     @param generator The generator to use.
 
-    @param handler The completion handler to invoke when the
+    @param token The completion handler to invoke when the
     operation completes. The implementation takes ownership of
     the handler by performing a decay-copy. The equivalent
     function signature of the handler must be:

include/boost/beast/core/buffers_range.hpp

@@ -120,7 +120,6 @@ buffers_range_ref(BufferSequence const& buffers)
     return detail::buffers_range_adaptor<
         BufferSequence const&>(buffers);
 }
-/** @} */
 
 } // beast
 } // boost

include/boost/beast/core/span.hpp

@@ -16,7 +16,8 @@
 namespace boost {
 namespace beast {
 
-using boost::span;
+template<class T, std::size_t E = boost::dynamic_extent>
+using span = boost::span<T, E>;
 
 } // beast
 } // boost

include/boost/beast/http/fields.hpp

@@ -99,7 +99,7 @@ public:
         /// Assignment (deleted)
         value_type& operator=(value_type const&) = delete;
 
-        /// Returns the field enum, which can be @ref field::unknown
+        /// Returns the field enum, which can be @ref boost::beast::http::field::unknown
         field
         name() const;
 
@@ -424,7 +424,7 @@ public:
 
         @param name The field name.
 
-        @param value The value of the field, as a @ref string_view
+        @param value The value of the field, as a @ref boost::beast::string_view
     */
     void
     insert(field name, string_view const& value);
@@ -442,7 +442,7 @@ public:
 
         @param name The field name.
 
-        @param value The value of the field, as a @ref string_view
+        @param value The value of the field, as a @ref boost::beast::string_view
     */
     void
     insert(string_view name, string_view const& value);
@@ -465,7 +465,7 @@ public:
         must be equal to `to_string(name)` using a case-insensitive
         comparison, otherwise the behavior is undefined.
 
-        @param value The value of the field, as a @ref string_view
+        @param value The value of the field, as a @ref boost::beast::string_view
     */
     void
     insert(field name, string_view name_string,
@@ -481,7 +481,7 @@ public:
 
         @param name The field name.
 
-        @param value The value of the field, as a @ref string_view
+        @param value The value of the field, as a @ref boost::beast::string_view
 
         @return The field value.
     */
@@ -498,7 +498,7 @@ public:
 
         @param name The field name.
 
-        @param value The value of the field, as a @ref string_view
+        @param value The value of the field, as a @ref boost::beast::string_view
     */
     void
     set(string_view name, string_view const& value);
@@ -635,7 +635,7 @@ public:
     std::pair<const_iterator, const_iterator>
     equal_range(field name) const;
 
-    /// @copydoc equal_range(field) const
+    /// @copydoc boost::beast::http::basic_fields::equal_range(boost::beast::http::field) const
     std::pair<const_iterator, const_iterator>
     equal_range(string_view name) const;
 

include/boost/beast/http/message_generator.hpp

@@ -48,19 +48,19 @@ public:
     template <bool isRequest, class Body, class Fields>
     message_generator(http::message<isRequest, Body, Fields>&&);
 
-    /// @ref BuffersGenerator
+    /// `BuffersGenerator`
     bool is_done() const {
         return impl_->is_done();
     }
 
-    /// @ref BuffersGenerator
+    /// `BuffersGenerator`
     const_buffers_type
     prepare(error_code& ec)
     {
         return impl_->prepare(ec);
     }
 
-    /// @ref BuffersGenerator
+    /// `BuffersGenerator`
     void
     consume(std::size_t n)
     {

include/boost/beast/websocket/error.hpp

@@ -17,7 +17,7 @@ namespace boost {
 namespace beast {
 namespace websocket {
 
-/// Error codes returned from @ref beast::websocket::stream operations.
+/// Error codes returned from @ref boost::beast::websocket::stream operations.
 enum class error
 {
     /** The WebSocket stream was gracefully closed at both endpoints