class InlineCommandComment

Declaration

class InlineCommandComment : public InlineContentComment { /* full declaration omitted */ };

Description

A command with word-like arguments that is considered inline content.

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

Inherits from: InlineContentComment

Member Variables

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

Command arguments.

Inherited from Comment:

protected Loc

protected Range

protected

Method Overview

• public InlineCommandComment(clang::SourceLocation LocBegin, clang::SourceLocation LocEnd, unsigned int CommandID, clang::comments::InlineCommandComment::RenderKind RK, ArrayRef<clang::comments::Comment::Argument> Args)
• 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 llvm::StringRef getCommandName(const clang::comments::CommandTraits & Traits) const
• public clang::SourceRange getCommandNameRange() const
• public unsigned int getNumArgs() const
• public clang::comments::InlineCommandComment::RenderKind getRenderKind() const

Inherited from InlineContentComment:

• public addTrailingNewline
• public classof
• public hasTrailingNewline

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

¶InlineCommandComment(
    clang::SourceLocation LocBegin,
    clang::SourceLocation LocEnd,
    unsigned int CommandID,
    clang::comments::InlineCommandComment::
        RenderKind RK,
    ArrayRef<clang::comments::Comment::Argument>
        Args)

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

Parameters

clang::SourceLocation LocBegin

clang::SourceLocation LocEnd

unsigned int CommandID

clang::comments::InlineCommandComment::RenderKind RK

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

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

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

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

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

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

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

Parameters

const clang::comments::Comment* C

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

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

Parameters

unsigned int Idx

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

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

Parameters

unsigned int Idx

¶unsigned int getCommandID() const

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

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

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

Parameters

const clang::comments::CommandTraits& Traits

¶clang::SourceRange getCommandNameRange() const

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

¶unsigned int getNumArgs() const

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

¶clang::comments::InlineCommandComment::RenderKind
getRenderKind() const

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