clang  6.0.0svn
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
clang::comments::VerbatimBlockComment Class Reference

A verbatim block command (e. More...

#include "clang/AST/Comment.h"

Inheritance diagram for clang::comments::VerbatimBlockComment:
Inheritance graph
[legend]
Collaboration diagram for clang::comments::VerbatimBlockComment:
Collaboration graph
[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)
 
ParagraphCommentgetParagraph () 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 (const ASTContext &Context) const
 
void dump (raw_ostream &OS, const CommandTraits *Traits, const SourceManager *SM) const
 
SourceRange getSourceRange () const LLVM_READONLY
 
SourceLocation getLocStart () const LLVM_READONLY
 
SourceLocation getLocEnd () 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< ArgumentArgs
 Word-like arguments. More...
 
ParagraphCommentParagraph
 Paragraph argument. More...
 
- Protected Attributes inherited from clang::comments::Comment
SourceLocation Loc
 Preferred location to show caret. More...
 
SourceRange Range
 Source range of this AST node. More...
 
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
enum  CommentKind { NoCommentKind = 0 }
 
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 897 of file Comment.h.

Constructor & Destructor Documentation

◆ VerbatimBlockComment()

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

Definition at line 904 of file Comment.h.

Member Function Documentation

◆ child_begin()

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

Definition at line 916 of file Comment.h.

◆ child_end()

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

Definition at line 920 of file Comment.h.

◆ classof()

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

Definition at line 912 of file Comment.h.

References clang::comments::Comment::getCommentKind().

◆ getCloseName()

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

Definition at line 933 of file Comment.h.

◆ getNumLines()

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

Definition at line 937 of file Comment.h.

◆ getText()

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

Definition at line 941 of file Comment.h.

◆ setCloseName()

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

Definition at line 924 of file Comment.h.

Referenced by clang::comments::Sema::actOnVerbatimBlockFinish().

◆ setLines()

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

Definition at line 929 of file Comment.h.

Referenced by clang::comments::Sema::actOnVerbatimBlockFinish().

Member Data Documentation

◆ CloseName

StringRef clang::comments::VerbatimBlockComment::CloseName
protected

Definition at line 899 of file Comment.h.

◆ CloseNameLocBegin

SourceLocation clang::comments::VerbatimBlockComment::CloseNameLocBegin
protected

Definition at line 900 of file Comment.h.

◆ Lines

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

Definition at line 901 of file Comment.h.


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