<html>
<head>
<base href="https://bugs.llvm.org/">
</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 - Doxygen bug breaks static analyzer CallEvent docs"
href="https://bugs.llvm.org/show_bug.cgi?id=44753">44753</a>
</td>
</tr>
<tr>
<th>Summary</th>
<td>Doxygen bug breaks static analyzer CallEvent docs
</td>
</tr>
<tr>
<th>Product</th>
<td>Documentation
</td>
</tr>
<tr>
<th>Version</th>
<td>trunk
</td>
</tr>
<tr>
<th>Hardware</th>
<td>PC
</td>
</tr>
<tr>
<th>OS</th>
<td>All
</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>Doxygen
</td>
</tr>
<tr>
<th>Assignee</th>
<td>unassignedbugs@nondot.org
</td>
</tr>
<tr>
<th>Reporter</th>
<td>nicolas.alvarez@gmail.com
</td>
</tr>
<tr>
<th>CC</th>
<td>llvm-bugs@lists.llvm.org
</td>
</tr></table>
<p>
<div>
<pre>In include/clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h:561 there is
this doc comment:
/// Represents a call to a block.
///
/// Example: <tt>^{ /* ... */ }()</tt>
class BlockCall : public CallEvent {
This unfortunately triggers a bug in Doxygen where it thinks the */ is closing
the documentation comment, and the } is closing the ento namespace. This breaks
a lot of things in the generated documentation:
- BlockCall and *all the classes that follow* appear in the clang namespace
rather than clang::ento
- clang::CXXInstanceCall, clang::CXXAllocatorCall, etc (in the wrong namespace)
inherit from some unknown AnyFunctionCall that Doxygen can't find, so it also
doesn't know the inheritance chain continues up to clang::ento::CallEvent.
See <a href="https://clang.llvm.org/doxygen/classAnyFunctionCall.html">https://clang.llvm.org/doxygen/classAnyFunctionCall.html</a>
I found that this bug is already fixed in Doxygen 1.8.16:
<a href="https://github.com/doxygen/doxygen/commit/8e96d9c994e18626cd6f00ea875c7cab1d7502c4">https://github.com/doxygen/doxygen/commit/8e96d9c994e18626cd6f00ea875c7cab1d7502c4</a>
There's two possible fixes. Either switch to Doxygen >= 1.8.16 on the server
that generates the online documentation, or change that example line to not use
comments:
/// Example: <tt>^{ code; }()</tt></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>