summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFariborz Jahanian <fjahanian@apple.com>2012-10-18 17:32:05 +0000
committerFariborz Jahanian <fjahanian@apple.com>2012-10-18 17:32:05 +0000
commita52fd9783f5af962e383f833d9e01e681b6696dc (patch)
tree1ad787a0e5ac1b959f1616dd1a432eca5013186b
parenta031c5741760e0b25bde48e83936a925d323c4d7 (diff)
downloadbcm5719-llvm-a52fd9783f5af962e383f833d9e01e681b6696dc.tar.gz
bcm5719-llvm-a52fd9783f5af962e383f833d9e01e681b6696dc.zip
Improve comment in couple of fields of DeclInfo.
llvm-svn: 166192
-rw-r--r--clang/include/clang/AST/Comment.h7
1 files changed, 4 insertions, 3 deletions
diff --git a/clang/include/clang/AST/Comment.h b/clang/include/clang/AST/Comment.h
index c3eb22e8563..c7cdb780988 100644
--- a/clang/include/clang/AST/Comment.h
+++ b/clang/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
OpenPOWER on IntegriCloud