Skip to content

code block inside the parameters description incorrectly appears in the function description #1074

@ashtum

Description

@ashtum

In the following doc comment, there is a code block inside the description of @param token which is expected to appear in the Parameters section of the page, but it is incorrectly added to the rest of the function description.

Declaration:

/** Read a complete header from the stream.

    This function is used to ...

    @param stream The stream from which the data is to be
    read. The type must meet the <em>AsyncReadStream</em>
    requirements.

    @param parser The parser to use. The object must remain
    valid at least until the handler is called; ownership is
    not transferred.

    @param token The completion token that will be used to
    produce a completion handler, which will be called when
    the read completes. The function signature of the
    completion handler must be:
    @code
    void handler(
        error_code const& error,        // result of operation
        std::size_t bytes_transferred   // the number of bytes consumed by the parser
    );
    @endcode
    Regardless of whether the asynchronous operation
    completes immediately or not, the completion handler
    will not be invoked from within this function. On
    immediate completion, invocation of the handler will be
    performed in a manner equivalent to using
    `asio::async_immediate`.
*/
template<
    class AsyncReadStream,
    BOOST_ASIO_COMPLETION_TOKEN_FOR(
        void(system::error_code, std::size_t)) CompletionToken
            BOOST_ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(
                typename AsyncReadStream::executor_type)>
BOOST_ASIO_INITFN_AUTO_RESULT_TYPE(CompletionToken,
    void (system::error_code, std::size_t))
async_read_header(
    AsyncReadStream& s,
    http_proto::parser& pr,
    CompletionToken&& token
        BOOST_ASIO_DEFAULT_COMPLETION_TOKEN(
            typename AsyncReadStream::executor_type));

A screenshot of the page:

Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions