[llvm-bugs] [Bug 31037] New: clang -Wdocumentation should warn upon mismatch between command and declaration kind

[via llvm-bugs]

https://llvm.org/bugs/show_bug.cgi?id=31037

            Bug ID: 31037
           Summary: clang -Wdocumentation should warn upon mismatch
                    between command and declaration kind
           Product: new-bugs
           Version: trunk
          Hardware: All
                OS: All
            Status: NEW
          Severity: normal
          Priority: P
         Component: new bugs
          Assignee: unassignedbugs at nondot.org
          Reporter: sean at rogue-research.com
                CC: llvm-bugs at lists.llvm.org
    Classification: Unclassified

This is further to bug #16713.

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).

-- 
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/20161116/777612c0/attachment.html>