| Issue |
92023
|
| Summary |
Wdocumentation false postive warning for a
|
| Labels |
new issue
|
| Assignees |
|
| Reporter |
andrei-sandor
|
Here is a bug regarding a Doxygen annotation for a struct.
Given the file structDoxygenFinal.cxx:
```c++
/**
* \struct BooleanDispatch
* \brief A comment here
*/
template <bool>
struct BooleanDispatch
{};
int main ()
{
return 0;
}
```
Run this command:
```
clang++ -Wdocumentation -std=c++14 -fsyntax-only structDoxygenFinal.cxx
```
The following warning will be generated
```
structDoxygenFinal.cxx:3:5: warning: '@struct' command should not be used in a comment attached to a non-struct declaration [-Wdocumentation]
* \struct BooleanDispatch
~^~~~~~~~~~~~~~~~~~~~~~
1 warning generated.
```
To fix this warning, the comment could be placed between Template<bool> and
struct BooleanDispatch in structDoxygenFinal.cxx
Is it fine, if in general, a Doxygen comment with \struct is placed between a template
statement and a struct statement?
![]()
_______________________________________________
llvm-bugs mailing list
llvm-bugs@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-bugs
