A verbatim block command (e. More...

#include "clang/AST/Comment.h"

Inheritance diagram for clang::comments::VerbatimBlockComment:

[legend]

Public Member Functions
	VerbatimBlockComment (SourceLocation LocBegin, SourceLocation LocEnd, unsigned CommandID)

child_iterator	child_begin () const

child_iterator	child_end () const

void	setCloseName (StringRef Name, SourceLocation LocBegin)

void	setLines (ArrayRef< VerbatimBlockLineComment * > L)

StringRef	getCloseName () const

unsigned	getNumLines () const

StringRef	getText (unsigned LineIdx) 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	CloseName

SourceLocation	CloseNameLocBegin

ArrayRef< VerbatimBlockLineComment * >	Lines

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 block command (e.

g., preformatted code). Verbatim block has an opening and a closing command and contains multiple lines of text (VerbatimBlockLineComment nodes).

Definition at line 879 of file Comment.h.

Constructor & Destructor Documentation

◆ VerbatimBlockComment()

clang::comments::VerbatimBlockComment::VerbatimBlockComment	(	SourceLocation	LocBegin,
		SourceLocation	LocEnd,
		unsigned	CommandID
	)

inline

Definition at line 886 of file Comment.h.

Member Function Documentation

◆ child_begin()

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

inline

Definition at line 897 of file Comment.h.

References Lines.

◆ child_end()

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

inline

Definition at line 901 of file Comment.h.

References Lines.

◆ classof()

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

inlinestatic

Definition at line 893 of file Comment.h.

References clang::C.

◆ getCloseName()

StringRef clang::comments::VerbatimBlockComment::getCloseName ( ) const

inline

Definition at line 914 of file Comment.h.

References CloseName.

◆ getNumLines()

unsigned clang::comments::VerbatimBlockComment::getNumLines ( ) const

inline

Definition at line 918 of file Comment.h.

References Lines.

◆ getText()

StringRef clang::comments::VerbatimBlockComment::getText ( unsigned LineIdx ) const

inline

Definition at line 922 of file Comment.h.

References Lines.

◆ setCloseName()

void clang::comments::VerbatimBlockComment::setCloseName	(	StringRef	Name,
		SourceLocation	LocBegin
	)

inline

Definition at line 905 of file Comment.h.

References CloseName, and CloseNameLocBegin.

◆ setLines()

void clang::comments::VerbatimBlockComment::setLines ( ArrayRef< VerbatimBlockLineComment * > L )

inline

Definition at line 910 of file Comment.h.

References Lines.

Member Data Documentation

◆ CloseName

StringRef clang::comments::VerbatimBlockComment::CloseName

protected

Definition at line 881 of file Comment.h.

Referenced by getCloseName(), and setCloseName().

◆ CloseNameLocBegin

SourceLocation clang::comments::VerbatimBlockComment::CloseNameLocBegin

protected

Definition at line 882 of file Comment.h.

Referenced by setCloseName().

◆ Lines

ArrayRef<VerbatimBlockLineComment *> clang::comments::VerbatimBlockComment::Lines

protected

Definition at line 883 of file Comment.h.

Referenced by child_begin(), child_end(), getNumLines(), getText(), and setLines().

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

include/clang/AST/Comment.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VerbatimBlockComment()

Member Function Documentation

◆ child_begin()

◆ child_end()

◆ classof()

◆ getCloseName()

◆ getNumLines()

◆ getText()

◆ setCloseName()

◆ setLines()

Member Data Documentation

◆ CloseName

◆ CloseNameLocBegin

◆ Lines