class TParamCommandComment

Declaration

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

Description

Doxygen \ tparam command, describes a template parameter.

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

Inherits from: BlockCommandComment

Member Variables

private ArrayRef<unsigned int> Position

For C: Position = { 0 } For TT: Position = { 1 } For T: Position = { 1, 0 }

Inherited from BlockCommandComment:

protected Args

protected Paragraph

Inherited from Comment:

protected Loc

protected Range

protected

Method Overview

• public TParamCommandComment(clang::SourceLocation LocBegin, clang::SourceLocation LocEnd, unsigned int CommandID, clang::comments::CommandMarkerKind CommandMarker)
• public static bool classof(const clang::comments::Comment * C)
• public unsigned int getDepth() const
• public unsigned int getIndex(unsigned int Depth) const
• public llvm::StringRef getParamName(const clang::comments::FullComment * FC) const
• public llvm::StringRef getParamNameAsWritten() const
• public clang::SourceRange getParamNameRange() const
• public bool hasParamName() const
• public bool isPositionValid() const
• public void setPosition(ArrayRef<unsigned int> NewPosition)

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

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

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

Parameters

clang::SourceLocation LocBegin

clang::SourceLocation LocEnd

unsigned int CommandID

clang::comments::CommandMarkerKind CommandMarker

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

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

Parameters

const clang::comments::Comment* C

¶unsigned int getDepth() const

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

¶unsigned int getIndex(unsigned int Depth) const

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

Parameters

unsigned int Depth

¶llvm::StringRef getParamName(
    const clang::comments::FullComment* FC) const

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

Parameters

const clang::comments::FullComment* FC

¶llvm::StringRef getParamNameAsWritten() const

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

¶clang::SourceRange getParamNameRange() const

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

¶bool hasParamName() const

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

¶bool isPositionValid() const

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

¶void setPosition(
    ArrayRef<unsigned int> NewPosition)

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

Parameters

ArrayRef<unsigned int> NewPosition