]> granicus.if.org Git - clang/commitdiff
Improve comment in couple of fields of DeclInfo.
authorFariborz Jahanian <fjahanian@apple.com>
Thu, 18 Oct 2012 17:32:05 +0000 (17:32 +0000)
committerFariborz Jahanian <fjahanian@apple.com>
Thu, 18 Oct 2012 17:32:05 +0000 (17:32 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@166192 91177308-0d34-0410-b5e6-96231b3b80d8

include/clang/AST/Comment.h

index c3eb22e85634ba1fdf6a31217293d54021a84cf1..c7cdb780988d2d9483f96cff238b986635fd3857 100644 (file)
@@ -902,11 +902,12 @@ public:
 
 /// Information about the declaration, useful to clients of FullComment.
 struct DeclInfo {
-  /// Declaration the comment is attached to.  Should not be NULL.
+  /// Declaration the comment is actually attached to (in the source).
+  /// Should not be NULL.
   const Decl *CommentDecl;
   
-  /// CurrentDecl is the declaration for which comment is being put into an XML comment.
-  /// Not necessarily same as CommentDecl.
+  /// CurrentDecl is the declaration with which the FullComment is associated.
+  /// The information in the DeclInfo corresponds to CurrentDecl.
   const Decl *CurrentDecl;
   
   /// Parameters that can be referenced by \\param if \c CommentDecl is something