https://bugs.llvm.org/show_bug.cgi?id=47263
Bug ID: 47263
Summary: -Wdocumentation should ignore period after \param.
Product: clang
Version: unspecified
Hardware: All
OS: All
Status: NEW
Severity: normal
Priority: P
Component: -New Bugs
Assignee: [email protected]
Reporter: [email protected]
CC: [email protected], [email protected],
[email protected], [email protected]
Consider the following example:
```
/// Sentence that ends with \param bar.
int foo(int bar) { }
```
When compiled with -Wdocumentation this results in warning:
```
$ clang -c -Wdocumentation /tmp/repro.c
/tmp/repro.c:1:39: warning: empty paragraph passed to '\param' command
[-Wdocumentation]
/// Sentence that ends with \param bar.
~~~~~~~~~~^
/tmp/repro.c:1:36: warning: parameter 'bar.' not found in the function
declaration [-Wdocumentation]
/// Sentence that ends with \param bar.
^~~~
/tmp/repro.c:1:36: note: did you mean 'bar'?
/// Sentence that ends with \param bar.
^~~~
bar
```
This is silly and particularly annoying for projects such as LLVM that require
comments to be sentences terminated with a period.
--
You are receiving this mail because:
You are on the CC list for the bug._______________________________________________
llvm-bugs mailing list
[email protected]
https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-bugs