r228002 - Add documentation to ApplyDebugLocation.

[Adrian Prantl]

Author: adrian
Date: Tue Feb  3 12:40:38 2015
New Revision: 228002

URL: http://llvm.org/viewvc/llvm-project?rev=228002&view=rev
Log:
Add documentation to ApplyDebugLocation.

Modified:
    cfe/trunk/lib/CodeGen/CGDebugInfo.h

Modified: cfe/trunk/lib/CodeGen/CGDebugInfo.h
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/lib/CodeGen/CGDebugInfo.h?rev=228002&r1=228001&r2=228002&view=diff
==============================================================================
--- cfe/trunk/lib/CodeGen/CGDebugInfo.h (original)
+++ cfe/trunk/lib/CodeGen/CGDebugInfo.h Tue Feb  3 12:40:38 2015
@@ -443,8 +443,8 @@ private:
   }
 };
 
-/// A scoped helper to set the current debug location to the specified location
-/// or preferred location of the specified Expr.
+/// \brief A scoped helper to set the current debug location to the specified
+/// location or preferred location of the specified Expr.
 class ApplyDebugLocation {
 private:
   void init(SourceLocation TemporaryLocation);
@@ -454,6 +454,8 @@ protected:
   CodeGenFunction &CGF;
 
 public:
+  /// If TemporaryLocation is invalid, the IRBuilder will be set to not attach
+  /// debug locations, thus marking the instructions as prologue.
   ApplyDebugLocation(CodeGenFunction &CGF,
                      SourceLocation TemporaryLocation = SourceLocation());
   ApplyDebugLocation(CodeGenFunction &CGF, const Expr *E);