[llvm-bugs] [Bug 47263] New: -Wdocumentation should ignore period after \param.

[via llvm-bugs]

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: unassignedclangbugs at nondot.org
          Reporter: jdevlieghere at apple.com
                CC: htmldeveloper at gmail.com, llvm-bugs at lists.llvm.org,
                    neeilans at live.com, richard-llvm at metafoo.co.uk

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.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/llvm-bugs/attachments/20200821/c0b0c840/attachment.html>