<html>
<head>
<base href="https://bugs.llvm.org/">
</head>
<body><table border="1" cellspacing="0" cellpadding="8">
<tr>
<th>Bug ID</th>
<td><a class="bz_bug_link
bz_status_NEW "
title="NEW - -Wdocumentation should ignore period after \param."
href="https://bugs.llvm.org/show_bug.cgi?id=47263">47263</a>
</td>
</tr>
<tr>
<th>Summary</th>
<td>-Wdocumentation should ignore period after \param.
</td>
</tr>
<tr>
<th>Product</th>
<td>clang
</td>
</tr>
<tr>
<th>Version</th>
<td>unspecified
</td>
</tr>
<tr>
<th>Hardware</th>
<td>All
</td>
</tr>
<tr>
<th>OS</th>
<td>All
</td>
</tr>
<tr>
<th>Status</th>
<td>NEW
</td>
</tr>
<tr>
<th>Severity</th>
<td>normal
</td>
</tr>
<tr>
<th>Priority</th>
<td>P
</td>
</tr>
<tr>
<th>Component</th>
<td>-New Bugs
</td>
</tr>
<tr>
<th>Assignee</th>
<td>unassignedclangbugs@nondot.org
</td>
</tr>
<tr>
<th>Reporter</th>
<td>jdevlieghere@apple.com
</td>
</tr>
<tr>
<th>CC</th>
<td>htmldeveloper@gmail.com, llvm-bugs@lists.llvm.org, neeilans@live.com, richard-llvm@metafoo.co.uk
</td>
</tr></table>
<p>
<div>
<pre>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.</pre>
</div>
</p>
<hr>
<span>You are receiving this mail because:</span>
<ul>
<li>You are on the CC list for the bug.</li>
</ul>
</body>
</html>