Expand the comment for DeclInfo::CurrentDecl.

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

diff --git a/include/clang/AST/Comment.h b/include/clang/AST/Comment.h
index c7cdb780988d2d9483f96cff238b986635fd3857..facfcf9a964f2c14d1ba2eac8aa201169faeaae6 100644 (file)
--- a/include/clang/AST/Comment.h
+++ b/include/clang/AST/Comment.h
@@ -907,6 +907,12 @@ struct DeclInfo {
   const Decl *CommentDecl;
   
   /// CurrentDecl is the declaration with which the FullComment is associated.
+  ///
+  /// It can be different from \c CommentDecl.  It happens when we we decide
+  /// that the comment originally attached to \c CommentDecl is fine for
+  /// \c CurrentDecl too (for example, for a redeclaration or an overrider of
+  /// \c CommentDecl).
+  ///
   /// The information in the DeclInfo corresponds to CurrentDecl.
   const Decl *CurrentDecl;