[cfe-commits] r137901 - /cfe/trunk/include/clang/StaticAnalyzer/Core/BugReporter/BugReporter.h

[Anna Zaks]

Author: zaks
Date: Wed Aug 17 18:36:16 2011
New Revision: 137901

URL: http://llvm.org/viewvc/llvm-project?rev=137901&view=rev
Log:
Add more comments for BugReport.

Modified:
    cfe/trunk/include/clang/StaticAnalyzer/Core/BugReporter/BugReporter.h

Modified: cfe/trunk/include/clang/StaticAnalyzer/Core/BugReporter/BugReporter.h
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/StaticAnalyzer/Core/BugReporter/BugReporter.h?rev=137901&r1=137900&r2=137901&view=diff
==============================================================================
--- cfe/trunk/include/clang/StaticAnalyzer/Core/BugReporter/BugReporter.h (original)
+++ cfe/trunk/include/clang/StaticAnalyzer/Core/BugReporter/BugReporter.h Wed Aug 17 18:36:16 2011
@@ -58,6 +58,8 @@
   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 @@
   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;