clang::comments::FullComment Class Reference

A full comment attached to a declaration, contains block content. More...

#include "clang/AST/Comment.h"

Inheritance diagram for clang::comments::FullComment:

Public Member Functions
	FullComment (ArrayRef< BlockContentComment * > Blocks, DeclInfo *D)
child_iterator	child_begin () const
child_iterator	child_end () const
const Decl *	getDecl () const LLVM_READONLY
const DeclInfo *	getDeclInfo () const LLVM_READONLY
ArrayRef< BlockContentComment * >	getBlocks () const
Public Member Functions inherited from clang::comments::Comment
	Comment (CommentKind K, SourceLocation LocBegin, SourceLocation LocEnd)
CommentKind	getCommentKind () const
const char *	getCommentKindName () const
void	dump () const
void	dumpColor () const
void	dump (raw_ostream &OS, const ASTContext &Context) const
SourceRange	getSourceRange () const LLVM_READONLY
SourceLocation	getBeginLoc () const LLVM_READONLY
SourceLocation	getEndLoc () const LLVM_READONLY
SourceLocation	getLocation () const LLVM_READONLY
child_iterator	child_begin () const
child_iterator	child_end () const
unsigned	child_count () const

Static Public Member Functions
static bool	classof (const Comment *C)

Additional Inherited Members
Public Types inherited from clang::comments::Comment
typedef Comment *const *	child_iterator
Protected Types inherited from clang::comments::Comment
enum	{ NumCommentBits = 8 }
enum	{ NumInlineContentCommentBits = NumCommentBits + 1 }
enum	{ NumTextCommentBits = NumInlineContentCommentBits + 2 }
enum	{ NumInlineCommandCommentBits }
enum	{ NumHTMLTagCommentBits = NumInlineContentCommentBits + 1 }
enum	{ NumHTMLStartTagCommentBits = NumHTMLTagCommentBits + 1 }
enum	{ NumParagraphCommentBits = NumCommentBits + 2 }
enum	{ NumBlockCommandCommentBits }
enum	{ NumParamCommandCommentBits = NumBlockCommandCommentBits + 3 }
Protected Member Functions inherited from clang::comments::Comment
void	setSourceRange (SourceRange SR)
void	setLocation (SourceLocation L)
Protected Attributes inherited from clang::comments::Comment
SourceLocation	Loc
	Preferred location to show caret.
SourceRange	Range
	Source range of this AST node.
union {
CommentBitfields   CommentBits
InlineContentCommentBitfields   InlineContentCommentBits
TextCommentBitfields   TextCommentBits
InlineCommandCommentBitfields   InlineCommandCommentBits
HTMLTagCommentBitfields   HTMLTagCommentBits
HTMLStartTagCommentBitfields   HTMLStartTagCommentBits
ParagraphCommentBitfields   ParagraphCommentBits
BlockCommandCommentBitfields   BlockCommandCommentBits
ParamCommandCommentBitfields   ParamCommandCommentBits
};

Detailed Description

A full comment attached to a declaration, contains block content.

Definition at line 1083 of file Comment.h.

Constructor & Destructor Documentation

FullComment()

clang::comments::FullComment::FullComment ( ArrayRef< BlockContentComment * >  Blocks, DeclInfo *  D  )

inline

Definition at line 1088 of file Comment.h.

References clang::comments::Comment::setLocation(), and clang::comments::Comment::setSourceRange().

Member Function Documentation

child_begin()

child_iterator clang::comments::FullComment::child_begin ( ) const

inline

Definition at line 1103 of file Comment.h.

child_end()

child_iterator clang::comments::FullComment::child_end ( ) const

inline

Definition at line 1107 of file Comment.h.

classof()

static bool clang::comments::FullComment::classof ( const Comment *  C )

inlinestatic

Definition at line 1099 of file Comment.h.

References clang::C.

getBlocks()

ArrayRef< BlockContentComment * > clang::comments::FullComment::getBlocks ( ) const

inline

Definition at line 1121 of file Comment.h.

Referenced by clang::ASTContext::cloneFullComment().

getDecl()

const Decl * clang::comments::FullComment::getDecl ( ) const

inline

Definition at line 1111 of file Comment.h.

References clang::comments::DeclInfo::CommentDecl.

Referenced by clang::ASTContext::cloneFullComment().

getDeclInfo()

const DeclInfo * clang::comments::FullComment::getDeclInfo ( ) const

inline

Definition at line 1115 of file Comment.h.

References clang::comments::DeclInfo::fill(), and clang::comments::DeclInfo::IsFilled.

Referenced by clang::ASTContext::cloneFullComment(), clang::comments::ParamCommandComment::getParamName(), and clang::comments::TParamCommandComment::getParamName().

---

The documentation for this class was generated from the following file:

• include/clang/AST/Comment.h