[cfe-commits] r166192 - /cfe/trunk/include/clang/AST/Comment.h
Fariborz Jahanian
fjahanian at apple.com
Thu Oct 18 10:32:05 PDT 2012
Author: fjahanian
Date: Thu Oct 18 12:32:05 2012
New Revision: 166192
URL: http://llvm.org/viewvc/llvm-project?rev=166192&view=rev
Log:
Improve comment in couple of fields of DeclInfo.
Modified:
cfe/trunk/include/clang/AST/Comment.h
Modified: cfe/trunk/include/clang/AST/Comment.h
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/AST/Comment.h?rev=166192&r1=166191&r2=166192&view=diff
==============================================================================
--- cfe/trunk/include/clang/AST/Comment.h (original)
+++ cfe/trunk/include/clang/AST/Comment.h Thu Oct 18 12:32:05 2012
@@ -902,11 +902,12 @@
/// 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
More information about the cfe-commits
mailing list