<html>
<head>
<base href="http://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 --- - -Wdocumentation thinks gtk-doc is doxygen, generates false positives"
href="http://llvm.org/bugs/show_bug.cgi?id=17291">17291</a>
</td>
</tr>
<tr>
<th>Summary</th>
<td>-Wdocumentation thinks gtk-doc is doxygen, generates false positives
</td>
</tr>
<tr>
<th>Product</th>
<td>new-bugs
</td>
</tr>
<tr>
<th>Version</th>
<td>trunk
</td>
</tr>
<tr>
<th>Hardware</th>
<td>Macintosh
</td>
</tr>
<tr>
<th>OS</th>
<td>MacOS X
</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>llvmbugs@cs.uiuc.edu
</td>
</tr>
<tr>
<th>Classification</th>
<td>Unclassified
</td>
</tr></table>
<p>
<div>
<pre>gtk-doc is a kind of markup similar to doxygen:
<a href="http://www.gtk.org/gtk-doc/">http://www.gtk.org/gtk-doc/</a>
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
----------------------------</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>