Add more comments for BugReport.

llvm-svn: 137901

1 files changed, 4 insertions, 0 deletions

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;