Doxygen \param command. More...

#include "clang/AST/Comment.h"

Inheritance diagram for clang::comments::ParamCommandComment:

[legend]

Collaboration diagram for clang::comments::ParamCommandComment:

[legend]

Public Types
enum	: unsigned { InvalidParamIndex = ~0U , VarArgParamIndex = ~0U - 1U }

enum	PassDirection { In , Out , InOut }

Public Types inherited from clang::comments::Comment
enum	CommentKind { NoCommentKind = 0 }

typedef Comment const	child_iterator

Public Member Functions
	ParamCommandComment (SourceLocation LocBegin, SourceLocation LocEnd, unsigned CommandID, CommandMarkerKind CommandMarker)

PassDirection	getDirection () const LLVM_READONLY

bool	isDirectionExplicit () const LLVM_READONLY

void	setDirection (PassDirection Direction, bool Explicit)

bool	hasParamName () const

StringRef	getParamName (const FullComment *FC) const

StringRef	getParamNameAsWritten () const

SourceRange	getParamNameRange () const

bool	isParamIndexValid () const LLVM_READONLY

bool	isVarArgParam () const LLVM_READONLY

void	setIsVarArgParam ()

unsigned	getParamIndex () const LLVM_READONLY

void	setParamIndex (unsigned Index)

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)

ParagraphComment *	getParagraph () 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 (raw_ostream &OS, const ASTContext &Context) const

SourceRange	getSourceRange () const LLVM_READONLY

SourceLocation	getBeginLoc () const LLVM_READONLY

SourceLocation	getEndLoc () 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 const char *	getDirectionAsString (PassDirection D)

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)

Additional Inherited Members
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)

Protected Attributes inherited from clang::comments::BlockCommandComment
ArrayRef< Argument >	Args
	Word-like arguments.

ParagraphComment *	Paragraph
	Paragraph argument.

Protected Attributes inherited from clang::comments::Comment
SourceLocation	Loc
	Preferred location to show caret.

SourceRange	Range
	Source range of this AST node.

union {
CommentBitfields CommentBits

InlineContentCommentBitfields InlineContentCommentBits

TextCommentBitfields TextCommentBits

InlineCommandCommentBitfields InlineCommandCommentBits

HTMLTagCommentBitfields HTMLTagCommentBits

HTMLStartTagCommentBitfields HTMLStartTagCommentBits

ParagraphCommentBitfields ParagraphCommentBits

BlockCommandCommentBitfields BlockCommandCommentBits

ParamCommandCommentBitfields ParamCommandCommentBits

};

Detailed Description

Doxygen \param command.

Definition at line 694 of file Comment.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : unsigned

Enumerator
InvalidParamIndex
VarArgParamIndex

Definition at line 700 of file Comment.h.

◆ PassDirection

enum clang::comments::ParamCommandComment::PassDirection

Enumerator
In
Out
InOut

Definition at line 720 of file Comment.h.

Constructor & Destructor Documentation

◆ ParamCommandComment()

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