clang::comments::VerbatimLineComment Class Reference

A verbatim line command. More...

#include "clang/AST/Comment.h"

Inheritance diagram for clang::comments::VerbatimLineComment:

Public Member Functions
	VerbatimLineComment (SourceLocation LocBegin, SourceLocation LocEnd, unsigned CommandID, SourceLocation TextBegin, StringRef Text)
child_iterator	child_begin () const
child_iterator	child_end () const
StringRef	getText () const
SourceRange	getTextRange () const
Public Member Functions inherited from clang::comments::BlockCommandComment
	BlockCommandComment (SourceLocation LocBegin, SourceLocation LocEnd, unsigned CommandID, CommandMarkerKind CommandMarker)
child_iterator	child_begin () const
child_iterator	child_end () const
unsigned	getCommandID () const
StringRef	getCommandName (const CommandTraits &Traits) const
SourceLocation	getCommandNameBeginLoc () const
SourceRange	getCommandNameRange (const CommandTraits &Traits) const
unsigned	getNumArgs () const
StringRef	getArgText (unsigned Idx) const
SourceRange	getArgRange (unsigned Idx) const
void	setArgs (ArrayRef< Argument > A)
ParagraphComment *	getParagraph () const LLVM_READONLY
bool	hasNonWhitespaceParagraph () const
void	setParagraph (ParagraphComment *PC)
CommandMarkerKind	getCommandMarker () const LLVM_READONLY
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::BlockCommandComment
static bool	classof (const Comment *C)
Static Public Member Functions inherited from clang::comments::BlockContentComment
static bool	classof (const Comment *C)

Protected Attributes
StringRef	Text
SourceLocation	TextBegin
Protected Attributes inherited from clang::comments::BlockCommandComment
ArrayRef< Argument >	Args
	Word-like arguments.
ParagraphComment *	Paragraph
	Paragraph argument.
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
};

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::BlockCommandComment
	BlockCommandComment (CommentKind K, SourceLocation LocBegin, SourceLocation LocEnd, unsigned CommandID, CommandMarkerKind CommandMarker)
Protected Member Functions inherited from clang::comments::BlockContentComment
	BlockContentComment (CommentKind K, SourceLocation LocBegin, SourceLocation LocEnd)
Protected Member Functions inherited from clang::comments::Comment
void	setSourceRange (SourceRange SR)
void	setLocation (SourceLocation L)

Detailed Description

A verbatim line command.

Verbatim line has an opening command, a single line of text (up to the newline after the opening command) and has no closing command.

Definition at line 951 of file Comment.h.

Constructor & Destructor Documentation

VerbatimLineComment()

clang::comments::VerbatimLineComment::VerbatimLineComment ( SourceLocation LocBegin, SourceLocation LocEnd, unsigned CommandID, SourceLocation TextBegin, StringRef Text )

inline

Definition at line 957 of file Comment.h.

References clang::comments::BlockCommandComment::BlockCommandComment(), clang::comments::CMK_At, Text, TextBegin, and VerbatimLineComment().

Referenced by VerbatimLineComment().

Member Function Documentation

child_begin()

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

inline

Definition at line 969 of file Comment.h.

child_end()

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

inline

Definition at line 971 of file Comment.h.

classof()

bool clang::comments::VerbatimLineComment::classof ( const Comment * C )

inlinestatic

Definition at line 965 of file Comment.h.

References clang::C.

getText()

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

inline

Definition at line 973 of file Comment.h.

References Text.

getTextRange()

SourceRange clang::comments::VerbatimLineComment::getTextRange ( ) const

inline

Definition at line 977 of file Comment.h.

References clang::comments::Comment::getEndLoc(), and TextBegin.

Member Data Documentation

Text

StringRef clang::comments::VerbatimLineComment::Text

protected

Definition at line 953 of file Comment.h.

Referenced by getText(), and VerbatimLineComment().

TextBegin

SourceLocation clang::comments::VerbatimLineComment::TextBegin

protected

Definition at line 954 of file Comment.h.

Referenced by getTextRange(), and VerbatimLineComment().

---

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

• include/clang/AST/Comment.h