Skip to content

Wdocumentation-pedantic fails to handle \n newline in a description #55319

Closed
@RKSimon

Description

@RKSimon

https://clang.godbolt.org/z/fqncE8MT6

We can use <br> to start a newline in a description, but \n gives a warning:

/// Test function
/// \returns Value<br>
///          second line
int foo();

/// Another test function
/// \returns Value\n
///          second line
int bar();
 warning: unknown command tag name [-Wdocumentation-unknown-command]
/// \returns Value\n

CC'ing @aaronpuchert as this will hopefully just be a minor extension to https://reviews.llvm.org/D111190

Metadata

Metadata

Assignees

Labels

clang:diagnosticsNew/improved warning or error message in Clang, but not in clang-tidy or static analyzer

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions