[LLVMbugs] [Bug 17291] New: -Wdocumentation thinks gtk-doc is doxygen, generates false positives

[bugzilla-daemon at llvm.org]

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

            Bug ID: 17291
           Summary: -Wdocumentation thinks gtk-doc is doxygen, generates
                    false positives
           Product: new-bugs
           Version: trunk
          Hardware: Macintosh
                OS: MacOS X
            Status: NEW
          Severity: normal
          Priority: P
         Component: new bugs
          Assignee: unassignedbugs at nondot.org
          Reporter: sean at rogue-research.com
                CC: llvmbugs at cs.uiuc.edu
    Classification: Unclassified

gtk-doc is a kind of markup similar to doxygen:
http://www.gtk.org/gtk-doc/

When clang's -Wdocumentation encounters this, it (sometimes?) misinterprets it
as doxygen and thus gives false positive warnings.

In my case, I see this building VTK.  VTK mostly uses doxygen, but has some
third party code (libxml2) that uses gtk-doc, and I see warnings like below.

It would be nice if clang could distinguish, since I want -Wdocumentation
enabled since the project mostly uses doxygen.


----------------------------
In file included from
/Users/builder/external/VTK/IO/Infovis/vtkXMLTreeReader.cxx:34:
In file included from
/Users/builder/external/VTK-torture-clang-dbg-x86_64/ThirdParty/libxml2/vtklibxml2/libxml/parser.h:16:
/Users/builder/external/VTK-torture-clang-dbg-x86_64/ThirdParty/libxml2/vtklibxml2/libxml/tree.h:527:4:
warning: unknown command tag name [-Wdocumentation-unknown-command]
 * @ctxt:  a DOM wrapper context
   ^
/Users/builder/external/VTK-torture-clang-dbg-x86_64/ThirdParty/libxml2/vtklibxml2/libxml/tree.h:528:4:
warning: unknown command tag name 'node'; did you mean 'note'?
[-Wdocumentation]
 * @node:  the context node (element or attribute) 
   ^~~~~
    note
/Users/builder/external/VTK-torture-clang-dbg-x86_64/ThirdParty/libxml2/vtklibxml2/libxml/tree.h:529:4:
warning: unknown command tag name [-Wdocumentation-unknown-command]
 * @nsName:  the requested namespace name
   ^
/Users/builder/external/VTK-torture-clang-dbg-x86_64/ThirdParty/libxml2/vtklibxml2/libxml/tree.h:530:4:
warning: unknown command tag name [-Wdocumentation-unknown-command]
 * @nsPrefix:  the requested namespace prefix 
   ^
In file included from
/Users/builder/external/VTK/IO/Infovis/vtkXMLTreeReader.cxx:34:
In file included from
/Users/builder/external/VTK-torture-clang-dbg-x86_64/ThirdParty/libxml2/vtklibxml2/libxml/parser.h:18:
/Users/builder/external/VTK-torture-clang-dbg-x86_64/ThirdParty/libxml2/vtklibxml2/libxml/hash.h:64:4:
warning: unknown command tag name [-Wdocumentation-unknown-command]
 * @payload:  the data in the hash
   ^
/Users/builder/external/VTK-torture-clang-dbg-x86_64/ThirdParty/libxml2/vtklibxml2/libxml/hash.h:83:4:
warning: unknown command tag name 'data'; did you mean 'date'?
[-Wdocumentation]
 * @data:  extra scannner data
   ^~~~~
    date
/Users/builder/external/VTK-torture-clang-dbg-x86_64/ThirdParty/libxml2/vtklibxml2/libxml/hash.h:92:4:
warning: unknown command tag name 'data'; did you mean 'date'?
[-Wdocumentation]
 * @data:  extra scannner data
   ^~~~~
    date


----------------------------

-- 
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/20130919/dce0ac3e/attachment.html>