From db2acbc5ddf269076489f6c985c78346cf76d2be Mon Sep 17 00:00:00 2001 From: Anna Zaks Date: Wed, 17 Aug 2011 23:36:16 +0000 Subject: Add more comments for BugReport. llvm-svn: 137901 --- clang/include/clang/StaticAnalyzer/Core/BugReporter/BugReporter.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/clang/include/clang/StaticAnalyzer/Core/BugReporter/BugReporter.h b/clang/include/clang/StaticAnalyzer/Core/BugReporter/BugReporter.h index d2f92b230cc..4e8a750e0e1 100644 --- a/clang/include/clang/StaticAnalyzer/Core/BugReporter/BugReporter.h +++ b/clang/include/clang/StaticAnalyzer/Core/BugReporter/BugReporter.h @@ -58,6 +58,8 @@ public: virtual void Profile(llvm::FoldingSetNodeID &ID) const = 0; }; +/// This class provides an interface through which checkers can create +/// individual bug reports. class BugReport : public BugReporterVisitor { public: class NodeResolver { @@ -85,6 +87,8 @@ protected: Creators creators; /// Profile to identify equivalent bug reports for error report coalescing. + /// Reports are uniqued to ensure that we do not emit multiple diagnostics + /// for each bug. virtual void Profile(llvm::FoldingSetNodeID& hash) const; const Stmt *getStmt() const; -- cgit v1.2.3