[LLVMbugs] [Bug 13533] New: -Wdocumentation complains about @param on typedef

bugzilla-daemon at llvm.org bugzilla-daemon at llvm.org
Mon Aug 6 06:25:54 PDT 2012


http://llvm.org/bugs/show_bug.cgi?id=13533

             Bug #: 13533
           Summary: -Wdocumentation complains about @param on typedef
           Product: clang
           Version: trunk
          Platform: PC
        OS/Version: Linux
            Status: NEW
          Severity: normal
          Priority: P
         Component: Frontend
        AssignedTo: unassignedclangbugs at nondot.org
        ReportedBy: magnus.reftel at gmail.com
                CC: llvmbugs at cs.uiuc.edu
    Classification: Unclassified


-Wdocumentation complains about use of @param to document parameters on
function pointer typedefs, even though this is supported by Doxygen:

$ cat test.h
/** A callback.
 *@param i an argument
 */
typedef void (*callback)(int i);
$ /opt/llvm/r161319/bin/clang -Wdocumentation test.h
test.h:2:4: warning: '\param' command used in a comment that is not attached to
      a function declaration [-Wdocumentation]
 *@param i an argument
   ^~~~~
1 warning generated.

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