clang 17.0.0git
Public Member Functions | Friends | List of all members
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:
Inheritance graph
[legend]
Collaboration diagram for clang::api_notes::ParamInfo:
Collaboration graph
[legend]

Public Member Functions

 ParamInfo ()
 
std::optional< boolisNoEscape () const
 
void setNoEscape (std::optional< bool > Value)
 
std::optional< RetainCountConventionKindgetRetainCountConvention () const
 
void setRetainCountConvention (std::optional< RetainCountConventionKind > Value)
 
ParamInfooperator|= (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< NullabilityKindgetNullability () const
 
void setNullabilityAudited (NullabilityKind kind)
 
const std::string & getType () const
 
void setType (const std::string &type)
 
VariableInfooperator|= (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< boolisSwiftPrivate () const
 
void setSwiftPrivate (std::optional< bool > Private)
 
CommonEntityInfooperator|= (const CommonEntityInfo &RHS)
 
LLVM_DUMP_METHOD void dump (llvm::raw_ostream &OS) const
 

Friends

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

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 415 of file Types.h.

Constructor & Destructor Documentation

◆ ParamInfo()

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

Definition at line 428 of file Types.h.

Member Function Documentation

◆ dump()

LLVM_DUMP_METHOD void clang::api_notes::ParamInfo::dump ( llvm::raw_ostream &  OS) const

Definition at line 64 of file APINotesTypes.cpp.

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

◆ getRetainCountConvention()

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

Definition at line 441 of file Types.h.

Referenced by setRetainCountConvention().

◆ isNoEscape()

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

Definition at line 431 of file Types.h.

◆ operator|=()

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

Definition at line 452 of file Types.h.

◆ setNoEscape()

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

Definition at line 436 of file Types.h.

◆ setRetainCountConvention()

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

Definition at line 447 of file Types.h.

References getRetainCountConvention().

Friends And Related Function Documentation

◆ operator==

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

Definition at line 471 of file Types.h.


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