[PATCH] D85105: [doxygen] Fix bad doxygen results for BugReporterVisitors.h

Ella Ma via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Sun Aug 2 22:05:46 PDT 2020


OikawaKirie created this revision.
OikawaKirie added reviewers: NoQ, vsavchenko.
OikawaKirie added a project: clang.
Herald added subscribers: cfe-commits, Charusso.
OikawaKirie requested review of this revision.

Because of `{@code xxxxx}` will trigger a Doxygen bug. And as far as I am thinking, the bug may be matching the close brace with the open brace of the namespace declaration (`namespace clang {` or `namespace ento {`). With this patch, we can bypass the problem and successfully generate documents for the classes in BugReporterVisitors.h.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D85105

Files:
  clang/include/clang/StaticAnalyzer/Core/BugReporter/BugReporterVisitors.h


Index: clang/include/clang/StaticAnalyzer/Core/BugReporter/BugReporterVisitors.h
===================================================================
--- clang/include/clang/StaticAnalyzer/Core/BugReporter/BugReporterVisitors.h
+++ clang/include/clang/StaticAnalyzer/Core/BugReporter/BugReporterVisitors.h
@@ -53,7 +53,7 @@
   /// Note that this function does *not* get run on the very last node
   /// of the report, as the PathDiagnosticPiece associated with the
   /// last node should be unique.
-  /// Use {@code getEndPath} to customize the note associated with the report
+  /// Use `getEndPath` to customize the note associated with the report
   /// end instead.
   ///
   /// The last parameter can be used to register a new visitor with the given


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D85105.282500.patch
Type: text/x-patch
Size: 757 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20200803/1d1c9b31/attachment.bin>


More information about the cfe-commits mailing list