clang::api_notes::ParamInfo Class Reference

Describes a function or method parameter. More...

#include "clang/APINotes/Types.h"

Inheritance diagram for clang::api_notes::ParamInfo:

Public Member Functions
	ParamInfo ()
std::optional< bool >	isNoEscape () const
void	setNoEscape (std::optional< bool > Value)
std::optional< bool >	isLifetimebound () const
void	setLifetimebound (std::optional< bool > Value)
std::optional< RetainCountConventionKind >	getRetainCountConvention () const
void	setRetainCountConvention (std::optional< RetainCountConventionKind > Value)
ParamInfo &	operator|= (const ParamInfo &RHS)
LLVM_DUMP_METHOD void	dump (llvm::raw_ostream &OS) const
Public Member Functions inherited from clang::api_notes::VariableInfo
	VariableInfo ()
std::optional< NullabilityKind >	getNullability () const
void	setNullabilityAudited (NullabilityKind kind)
const std::string &	getType () const
void	setType (const std::string &type)
VariableInfo &	operator|= (const VariableInfo &RHS)
LLVM_DUMP_METHOD void	dump (llvm::raw_ostream &OS) const
Public Member Functions inherited from clang::api_notes::CommonEntityInfo
	CommonEntityInfo ()
std::optional< bool >	isSwiftPrivate () const
void	setSwiftPrivate (std::optional< bool > Private)
std::optional< SwiftSafetyKind >	getSwiftSafety () const
void	setSwiftSafety (SwiftSafetyKind Safety)
CommonEntityInfo &	operator|= (const CommonEntityInfo &RHS)
LLVM_DUMP_METHOD void	dump (llvm::raw_ostream &OS) const

Friends
bool	operator== (const ParamInfo &LHS, const ParamInfo &RHS)

Additional Inherited Members
Public Attributes inherited from clang::api_notes::CommonEntityInfo
std::string	UnavailableMsg
	Message to use when this entity is unavailable.
unsigned	Unavailable: 1
	Whether this entity is marked unavailable.
unsigned	UnavailableInSwift: 1
	Whether this entity is marked unavailable in Swift.
std::string	SwiftName
	Swift name of this entity.

Detailed Description

Describes a function or method parameter.

Definition at line 457 of file Types.h.

Constructor & Destructor Documentation

ParamInfo()

clang::api_notes::ParamInfo::ParamInfo ( )

inline

Definition at line 480 of file Types.h.

References false.

Referenced by operator==, and operator|=().

Member Function Documentation

dump()

LLVM_DUMP_METHOD void clang::api_notes::ParamInfo::dump

(

llvm::raw_ostream &

OS

)

const

Definition at line 79 of file APINotesTypes.cpp.

References clang::api_notes::VariableInfo::VariableInfo().

getRetainCountConvention()

std::optional< RetainCountConventionKind > clang::api_notes::ParamInfo::getRetainCountConvention ( ) const

inline

Definition at line 502 of file Types.h.

Referenced by ProcessAPINotes(), and setRetainCountConvention().

isLifetimebound()

std::optional< bool > clang::api_notes::ParamInfo::isLifetimebound ( ) const

inline

Definition at line 493 of file Types.h.

Referenced by ProcessAPINotes().

isNoEscape()

std::optional< bool > clang::api_notes::ParamInfo::isNoEscape ( ) const

inline

Definition at line 485 of file Types.h.

Referenced by ProcessAPINotes().

operator|=()

ParamInfo & clang::api_notes::ParamInfo::operator|= ( const ParamInfo & RHS )

inline

Definition at line 513 of file Types.h.

References ParamInfo(), and clang::api_notes::VariableInfo::VariableInfo().

setLifetimebound()

void clang::api_notes::ParamInfo::setLifetimebound ( std::optional< bool > Value )

inline

Definition at line 497 of file Types.h.

setNoEscape()

void clang::api_notes::ParamInfo::setNoEscape ( std::optional< bool > Value )

inline

Definition at line 488 of file Types.h.

setRetainCountConvention()

void clang::api_notes::ParamInfo::setRetainCountConvention ( std::optional< RetainCountConventionKind > Value )

inline

Definition at line 508 of file Types.h.

References getRetainCountConvention().

Friends And Related Symbol Documentation

operator==

bool operator== ( const ParamInfo & LHS, const ParamInfo & RHS )

friend

Definition at line 537 of file Types.h.

References ParamInfo(), and clang::api_notes::VariableInfo::VariableInfo().

---

The documentation for this class was generated from the following files:

• include/clang/APINotes/Types.h
• lib/APINotes/APINotesTypes.cpp