Skip to content

Tag @li is not rendered under @return #1204

@akrzemi1

Description

@akrzemi1

This was found while building docs for Boost.Capy.

Consider the annotations in https://github.com/cppalliance/capy/blob/develop/include/boost/capy/write.hpp#L25

It has two lists (two sets of @li tags):

  1. One in the general prose section,
  2. The other under @return sections.

Now observe the outcome: https://master.capy.cpp.al/capy/reference/boost/capy/write.html

The first list is rendered correctly. The other appears under section "Cancellation" rather than under section "Returns".

It looks like @li elements are always identified as part of general prose (apparently @par belongs in there also), and never as part of @return.

I can imagine a reply "works as designed", but in that case I would request a way to put lists inside known section elements, like @return.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions