class ParamCommandComment

Declaration

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

Description

Doxygen \ param command.

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

Inherits from: BlockCommandComment

Member Variables

private unsigned int ParamIndex

Parameter index in the function declaration.

Inherited from BlockCommandComment:

protected Args

protected Paragraph

Inherited from Comment:

protected Loc

protected Range

protected

Method Overview

• public ParamCommandComment(clang::SourceLocation LocBegin, clang::SourceLocation LocEnd, unsigned int CommandID, clang::comments::CommandMarkerKind CommandMarker)
• public static bool classof(const clang::comments::Comment * C)
• public clang::comments::ParamCommandComment::PassDirection getDirection() const
• public static const char * getDirectionAsString(clang::comments::ParamCommandComment::PassDirection D)
• public unsigned int getParamIndex() 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 isDirectionExplicit() const
• public bool isParamIndexValid() const
• public bool isVarArgParam() const
• public void setDirection(clang::comments::ParamCommandComment::PassDirection Direction, bool Explicit)
• public void setIsVarArgParam()
• public void setParamIndex(unsigned int Index)

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

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

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

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:716

Parameters

const clang::comments::Comment* C

¶clang::comments::ParamCommandComment::
    PassDirection
    getDirection() const

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

¶static const char* getDirectionAsString(
    clang::comments::ParamCommandComment::
        PassDirection D)

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

Parameters

clang::comments::ParamCommandComment:: PassDirection D

¶unsigned int getParamIndex() const

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

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

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

Parameters

const clang::comments::FullComment* FC

¶llvm::StringRef getParamNameAsWritten() const

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

¶clang::SourceRange getParamNameRange() const

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

¶bool hasParamName() const

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

¶bool isDirectionExplicit() const

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

¶bool isParamIndexValid() const

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

¶bool isVarArgParam() const

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

¶void setDirection(
    clang::comments::ParamCommandComment::
        PassDirection Direction,
    bool Explicit)

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

Parameters

clang::comments::ParamCommandComment:: PassDirection Direction

bool Explicit

¶void setIsVarArgParam()

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

¶void setParamIndex(unsigned int Index)

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

Parameters

unsigned int Index