<html>
<head>
<base href="https://llvm.org/bugs/" />
</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 --- - clang -Wdocumentation should warn upon mismatch between command and declaration kind"
href="https://llvm.org/bugs/show_bug.cgi?id=31037">31037</a>
</td>
</tr>
<tr>
<th>Summary</th>
<td>clang -Wdocumentation should warn upon mismatch between command and declaration kind
</td>
</tr>
<tr>
<th>Product</th>
<td>new-bugs
</td>
</tr>
<tr>
<th>Version</th>
<td>trunk
</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>unassignedbugs@nondot.org
</td>
</tr>
<tr>
<th>Reporter</th>
<td>sean@rogue-research.com
</td>
</tr>
<tr>
<th>CC</th>
<td>llvm-bugs@lists.llvm.org
</td>
</tr>
<tr>
<th>Classification</th>
<td>Unclassified
</td>
</tr></table>
<p>
<div>
<pre>This is further to <a class="bz_bug_link
bz_status_NEW "
title="NEW --- - Confusing/incorrect -Wdocumentation warning message with \def used on a function"
href="show_bug.cgi?id=16713">bug #16713</a>.
Consider:
------test.c----------------------
/** \def somefunction
* \param x the host-endian value to convert
* \returns the value in little-endian byte order
*/
static int somefunction(int x)
{
return 0;
}
----------------------------------
doxygen docs say \def "Indicates that a comment block contains documentation
for a #define macro."
It would be nice if clang could warn that this should be \fn, since "some
function" is a function (not a #define).</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>