class VerbatimBlockComment

Declaration

class VerbatimBlockComment : public BlockCommandComment { /* full declaration omitted */ };

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).

Declared at: clang/include/clang/AST/Comment.h:874

Inherits from: BlockCommandComment

Member Variables

protected llvm::StringRef CloseName

protected clang::SourceLocation CloseNameLocBegin

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

Inherited from BlockCommandComment:

protected Args

protected Paragraph

Inherited from Comment:

protected Loc

protected Range

protected

Method Overview

• public VerbatimBlockComment(clang::SourceLocation LocBegin, clang::SourceLocation LocEnd, unsigned int CommandID)
• public clang::comments::Comment::child_iterator child_begin() const
• public clang::comments::Comment::child_iterator child_end() const
• public static bool classof(const clang::comments::Comment * C)
• public llvm::StringRef getCloseName() const
• public unsigned int getNumLines() const
• public llvm::StringRef getText(unsigned int LineIdx) const
• public void setCloseName(llvm::StringRef Name, clang::SourceLocation LocBegin)
• public void setLines(ArrayRef<clang::comments::VerbatimBlockLineComment *> L)

Inherited from BlockCommandComment:

• public child_begin
• public child_end
• public classof
• public getArgRange
• public getArgText
• public getCommandID
• public getCommandMarker
• public getCommandName
• public getCommandNameBeginLoc
• public getCommandNameRange
• public getNumArgs
• public getParagraph
• public hasNonWhitespaceParagraph
• public setArgs
• public setParagraph

Inherited from BlockContentComment:

• public classof

Inherited from Comment:

• public child_begin
• public child_count
• public child_end
• public dump
• public dump
• public dumpColor
• public getBeginLoc
• public getCommentKind
• public getCommentKindName
• public getEndLoc
• public getLocation
• public getSourceRange
• protected setLocation
• protected setSourceRange

Methods

¶VerbatimBlockComment(
    clang::SourceLocation LocBegin,
    clang::SourceLocation LocEnd,
    unsigned int CommandID)

Declared at: clang/include/clang/AST/Comment.h:881

Parameters

clang::SourceLocation LocBegin

clang::SourceLocation LocEnd

unsigned int CommandID

¶clang::comments::Comment::child_iterator
child_begin() const

Declared at: clang/include/clang/AST/Comment.h:893

¶clang::comments::Comment::child_iterator
child_end() const

Declared at: clang/include/clang/AST/Comment.h:897

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

Declared at: clang/include/clang/AST/Comment.h:889

Parameters

const clang::comments::Comment* C

¶llvm::StringRef getCloseName() const

Declared at: clang/include/clang/AST/Comment.h:910

¶unsigned int getNumLines() const

Declared at: clang/include/clang/AST/Comment.h:914

¶llvm::StringRef getText(
    unsigned int LineIdx) const

Declared at: clang/include/clang/AST/Comment.h:918

Parameters

unsigned int LineIdx

¶void setCloseName(llvm::StringRef Name,
                  clang::SourceLocation LocBegin)

Declared at: clang/include/clang/AST/Comment.h:901

Parameters

llvm::StringRef Name

clang::SourceLocation LocBegin

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

Declared at: clang/include/clang/AST/Comment.h:906

Parameters

ArrayRef< clang::comments::VerbatimBlockLineComment*> L