From: Ted Kremenek <kremenek@apple.com>
Date: Wed, 23 Feb 2011 02:26:43 +0000 (+0000)
Subject: Add doxygen comments to Sema::DiagRuntimeBehavior().
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=79c42c88efa708d03caa109e3e2ec57a2e6abebe;p=clang

Add doxygen comments to Sema::DiagRuntimeBehavior().

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@126296 91177308-0d34-0410-b5e6-96231b3b80d8
---

diff --git a/include/clang/Sema/Sema.h b/include/clang/Sema/Sema.h
index 9e46c2c49a..6b74b863a8 100644
--- a/include/clang/Sema/Sema.h
+++ b/include/clang/Sema/Sema.h
@@ -1892,6 +1892,14 @@ public:
   void MarkDeclarationReferenced(SourceLocation Loc, Decl *D);
   void MarkDeclarationsReferencedInType(SourceLocation Loc, QualType T);
   void MarkDeclarationsReferencedInExpr(Expr *E);
+  
+  /// \brief Conditionally issue a diagnostic based on the current
+  /// evaluation context.
+  ///
+  /// \param stmt - If stmt is non-null, delay reporting the diagnostic until
+  ///  the function body is parsed, and then do a basic reachability analysis to
+  ///  determine if the statement is reachable.  If it is unreachable, the
+  ///  diagnostic will not be emitted.
   bool DiagRuntimeBehavior(SourceLocation Loc, const Stmt *stmt,
                            const PartialDiagnostic &PD);