[doxygen] Fix bad doxygen results for BugReporterVisitors.h

[OikawaKirie]

Summary

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.

[vsavchenko]

Hey, thanks again for cleaning up the analyzer's docs 😄

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

56

Maybe it is better to create a reference to this function using the \ref command?

[OikawaKirie]

Now it has a link to the getEndPath.

[vsavchenko]

Awesome, thanks! Buuuut, maybe we can use \ref form, it looks like it's a preferred form in the codebase.

[OikawaKirie]

Ok, I got it. I will pay attention to this in the future submits.

[OikawaKirie]

@vsavchenko @NoQ
The patch has been updated as required. Is there anything I need to do with the patch?

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

56

Yes, using \ref looks better. I will submit it again. To be similar to the original code, I will use @ref getEndPath instead.

[vsavchenko]

Awesome! I will submit the patch!

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

public:
   BugReporterVisitor(BugReporterVisitor &&) {}
   virtual ~BugReporterVisitor();
 
   /// Return a diagnostic piece which should be associated with the
   /// given node.
   /// 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 \ref 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
   /// BugReport while processing a node.
   virtual PathDiagnosticPieceRef VisitNode(const ExplodedNode *Succ,
                                            BugReporterContext &BRC,
                                            PathSensitiveBugReport &BR) = 0;