From: James Dennett <jdennett@google.com>
Date: Thu, 4 Jul 2013 22:15:44 +0000 (+0000)
Subject: Add some more documentation on how to navigate from a LambdaExpr::Capture
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=c65f03498f6c59b5ae5c14086f49ae6e7a173624;p=clang

Add some more documentation on how to navigate from a LambdaExpr::Capture
to the associated FieldDecl.


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

diff --git a/include/clang/AST/DeclCXX.h b/include/clang/AST/DeclCXX.h
index 2de99f0925..3108457492 100644
--- a/include/clang/AST/DeclCXX.h
+++ b/include/clang/AST/DeclCXX.h
@@ -984,16 +984,17 @@ public:
   bool isLambda() const { return hasDefinition() && data().IsLambda; }
 
   /// \brief For a closure type, retrieve the mapping from captured
-  /// variables and this to the non-static data members that store the
+  /// variables and \c this to the non-static data members that store the
   /// values or references of the captures.
   ///
   /// \param Captures Will be populated with the mapping from captured
   /// variables to the corresponding fields.
   ///
   /// \param ThisCapture Will be set to the field declaration for the
-  /// 'this' capture.
+  /// \c this capture.
   ///
-  /// \note No entries will be added for init-captures.
+  /// \note No entries will be added for init-captures, as they do not capture
+  /// variables.
   void getCaptureFields(llvm::DenseMap<const VarDecl *, FieldDecl *> &Captures,
                         FieldDecl *&ThisCapture) const;
 
diff --git a/include/clang/AST/ExprCXX.h b/include/clang/AST/ExprCXX.h
index a241d1eded..925b16697c 100644
--- a/include/clang/AST/ExprCXX.h
+++ b/include/clang/AST/ExprCXX.h
@@ -1401,6 +1401,10 @@ public:
     }
 
     /// \brief Retrieve the field for an init-capture.
+    ///
+    /// This works only for an init-capture.  To retrieve the FieldDecl for
+    /// a captured variable or for a capture of \c this, use
+    /// LambdaExpr::getLambdaClass and CXXRecordDecl::getCaptureFields.
     FieldDecl *getInitCaptureField() const {
       assert(getCaptureKind() == LCK_Init && "no field for non-init-capture");
       return cast<FieldDecl>(DeclAndBits.getPointer());
@@ -1410,8 +1414,8 @@ public:
     /// written between the square brackets introducing the lambda).
     bool isImplicit() const { return DeclAndBits.getInt() & Capture_Implicit; }
 
-    /// \brief Determine whether this was an explicit capture, written
-    /// between the square brackets introducing the lambda.
+    /// \brief Determine whether this was an explicit capture (written
+    /// between the square brackets introducing the lambda).
     bool isExplicit() const { return !isImplicit(); }
 
     /// \brief Retrieve the source location of the capture.