diff options
| author | Fariborz Jahanian <fjahanian@apple.com> | 2012-10-18 17:32:05 +0000 |
|---|---|---|
| committer | Fariborz Jahanian <fjahanian@apple.com> | 2012-10-18 17:32:05 +0000 |
| commit | 4a7c6eb2bbc9f7c00604d8d93ec66fd98cf4e404 (patch) | |
| tree | 9091c2c00aa34148bde9c06e6002d64ae0883ba5 | |
| parent | 7ba2b457f0c684c11a1de18cf8b8479ecb6fb9b3 (diff) | |
Improve comment in couple of fields of DeclInfo.
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@166192 91177308-0d34-0410-b5e6-96231b3b80d8
| -rw-r--r-- | include/clang/AST/Comment.h | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/include/clang/AST/Comment.h b/include/clang/AST/Comment.h index c3eb22e856..c7cdb78098 100644 --- a/include/clang/AST/Comment.h +++ b/include/clang/AST/Comment.h @@ -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 |