clang::comments::TextComment Class Reference

Plain text. More...

#include "clang/AST/Comment.h"

Inheritance diagram for clang::comments::TextComment:

Public Member Functions
	TextComment (SourceLocation LocBegin, SourceLocation LocEnd, StringRef Text)
child_iterator	child_begin () const
child_iterator	child_end () const
StringRef	getText () const LLVM_READONLY
bool	isWhitespace () const
Public Member Functions inherited from clang::comments::InlineContentComment
void	addTrailingNewline ()
bool	hasTrailingNewline () 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)
Static Public Member Functions inherited from clang::comments::InlineContentComment
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::InlineContentComment
	InlineContentComment (CommentKind K, SourceLocation LocBegin, SourceLocation LocEnd)
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

Plain text.

Definition at line 291 of file Comment.h.

Constructor & Destructor Documentation

TextComment()

clang::comments::TextComment::TextComment ( SourceLocation  LocBegin, SourceLocation  LocEnd, StringRef  Text  )

inline

Definition at line 295 of file Comment.h.

References Text, and clang::comments::Comment::TextCommentBits.

Member Function Documentation

child_begin()

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

inline

Definition at line 305 of file Comment.h.

child_end()

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

inline

Definition at line 307 of file Comment.h.

classof()

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

inlinestatic

Definition at line 301 of file Comment.h.

References clang::C.

getText()

StringRef clang::comments::TextComment::getText ( ) const

inline

Definition at line 309 of file Comment.h.

References Text.

isWhitespace()

bool clang::comments::TextComment::isWhitespace ( ) const

inline

Definition at line 311 of file Comment.h.

References clang::comments::Comment::TextCommentBits.

---

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

• include/clang/AST/Comment.h
• lib/AST/Comment.cpp