[LLVMbugs] [Bug 13372] New: False positive -Wdocumentation warning when using \param on template method

bugzilla-daemon at llvm.org bugzilla-daemon at llvm.org
Mon Jul 16 01:42:06 PDT 2012


             Bug #: 13372
           Summary: False positive -Wdocumentation warning when using
                    \param on template method
           Product: clang
           Version: trunk
          Platform: Macintosh
        OS/Version: MacOS X
            Status: NEW
          Severity: normal
          Priority: P
         Component: -New Bugs
        AssignedTo: unassignedclangbugs at nondot.org
        ReportedBy: jonathan.sauer at gmx.de
                CC: llvmbugs at cs.uiuc.edu
    Classification: Unclassified

The following code results in a documentation warning when compiled with clang

struct Documented {
     * \param foo   The foo to bar.
    template <typename T>
    void bar(const T& foo);

This results in:

$ ~/LLVM/build/Release+Asserts/bin/clang++ -Wdocumentation -c -v clang.cpp 
clang version 3.2 (trunk 160248)
Target: x86_64-apple-darwin10.8.0
Thread model: posix
clang.cpp:3:9: warning: '\param' command used in a comment that is not attached
to a function
      declaration [-Wdocumentation]
     * \param foo   The foo to bar.
1 warning generated.

Clang should treat template methods as methods that can be documented using

P.S: The checking of Doxygen comments is a great addition to clang! Thank you
for implementing it!

Configure bugmail: http://llvm.org/bugs/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are on the CC list for the bug.

More information about the llvm-bugs mailing list