class BlockCommandComment

Declaration

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

Description

A command that has zero or more word-like arguments (number of word-like arguments depends on command name) and a paragraph as an argument (e. g., \ brief).

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

Inherits from: BlockContentComment

Member Variables

protected ArrayRef<clang::comments::Comment::Argument> Args

Word-like arguments.

protected clang::comments::ParagraphComment* Paragraph

Paragraph argument.

Inherited from Comment:

protected Loc

protected Range

protected

Method Overview

• public BlockCommandComment(clang::SourceLocation LocBegin, clang::SourceLocation LocEnd, unsigned int CommandID, clang::comments::CommandMarkerKind CommandMarker)
• protected BlockCommandComment(clang::comments::Comment::CommentKind K, clang::SourceLocation LocBegin, clang::SourceLocation LocEnd, unsigned int CommandID, clang::comments::CommandMarkerKind CommandMarker)
• 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 clang::SourceRange getArgRange(unsigned int Idx) const
• public llvm::StringRef getArgText(unsigned int Idx) const
• public unsigned int getCommandID() const
• public clang::comments::CommandMarkerKind getCommandMarker() const
• public llvm::StringRef getCommandName(const clang::comments::CommandTraits & Traits) const
• public clang::SourceLocation getCommandNameBeginLoc() const
• public clang::SourceRange getCommandNameRange(const clang::comments::CommandTraits & Traits) const
• public unsigned int getNumArgs() const
• public clang::comments::ParagraphComment * getParagraph() const
• public bool hasNonWhitespaceParagraph() const
• public void setArgs(ArrayRef<clang::comments::Comment::Argument> A)
• public void setParagraph(clang::comments::ParagraphComment * PC)

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

¶BlockCommandComment(
    clang::SourceLocation LocBegin,
    clang::SourceLocation LocEnd,
    unsigned int CommandID,
    clang::comments::CommandMarkerKind
        CommandMarker)

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

Parameters

clang::SourceLocation LocBegin

clang::SourceLocation LocEnd

unsigned int CommandID

clang::comments::CommandMarkerKind CommandMarker

¶BlockCommandComment(
    clang::comments::Comment::CommentKind K,
    clang::SourceLocation LocBegin,
    clang::SourceLocation LocEnd,
    unsigned int CommandID,
    clang::comments::CommandMarkerKind
        CommandMarker)

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

Parameters

clang::comments::Comment::CommentKind K

clang::SourceLocation LocBegin

clang::SourceLocation LocEnd

unsigned int CommandID

clang::comments::CommandMarkerKind CommandMarker

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

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

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

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

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

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

Parameters

const clang::comments::Comment* C

¶clang::SourceRange getArgRange(
    unsigned int Idx) const

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

Parameters

unsigned int Idx

¶llvm::StringRef getArgText(unsigned int Idx) const

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

Parameters

unsigned int Idx

¶unsigned int getCommandID() const

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

¶clang::comments::CommandMarkerKind
getCommandMarker() const

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

¶llvm::StringRef getCommandName(
    const clang::comments::CommandTraits& Traits)
    const

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

Parameters

const clang::comments::CommandTraits& Traits

¶clang::SourceLocation getCommandNameBeginLoc()
    const

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

¶clang::SourceRange getCommandNameRange(
    const clang::comments::CommandTraits& Traits)
    const

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

Parameters

const clang::comments::CommandTraits& Traits

¶unsigned int getNumArgs() const

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

¶clang::comments::ParagraphComment* getParagraph()
    const

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

¶bool hasNonWhitespaceParagraph() const

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

¶void setArgs(
    ArrayRef<clang::comments::Comment::Argument>
        A)

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

Parameters

ArrayRef<clang::comments::Comment::Argument> A

¶void setParagraph(
    clang::comments::ParagraphComment* PC)

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

Parameters

clang::comments::ParagraphComment* PC