Skip to content

[clang-doc] Certain comment types should be single paragraphs #169006

@evelez7

Description

@evelez7

Certain Doxygen special commands are concatenated regardless of the order they're written. For example:

/// \return Foo
/// \brief Brief!
/// \return Bar

will look like:

*Return*
Foo
Bar

See the return special command. Currently, the JSON backend treats these as separate comment paragraphs, and the JSON looks like the following:

"ReturnComments": [
  [
    "TextComment": "Foo"
  ],
  [
    "TextComment": "Bar
  ]
]

This JSON should be emitted as a single array.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions