From: Argyrios Kyrtzidis <akyrtzi@gmail.com>
Date: Mon, 6 Jul 2009 21:35:09 +0000 (+0000)
Subject: Add some comments to the ASTLocation class.
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=8fb3333d45ab3b327766e26310581cacf43fb374;p=clang

Add some comments to the ASTLocation class.

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

diff --git a/include/clang/Index/ASTLocation.h b/include/clang/Index/ASTLocation.h
index 4404644e56..ba401da26a 100644
--- a/include/clang/Index/ASTLocation.h
+++ b/include/clang/Index/ASTLocation.h
@@ -28,6 +28,12 @@ namespace idx {
 
 /// \brief Represents a Decl or a Stmt and its immediate Decl parent. It's
 /// immutable.
+///
+/// ASTLocation is intended to be used as a "pointer" into the AST. It is either
+/// just a Decl, or a Stmt and its Decl parent. Since a single Stmt is devoid
+/// of context, its parent Decl provides all the additional missing information
+/// like the declaration context, ASTContext, etc.
+///
 class ASTLocation {
   Decl *D;
   Stmt *Stm;