clang  14.0.0git
Public Member Functions | Public Attributes | Friends | List of all members
clang::api_notes::CommonEntityInfo Class Reference

Describes API notes data for any entity. More...

#include "clang/APINotes/Types.h"

Inheritance diagram for clang::api_notes::CommonEntityInfo:
Inheritance graph
[legend]
Collaboration diagram for clang::api_notes::CommonEntityInfo:
Collaboration graph
[legend]

Public Member Functions

 CommonEntityInfo ()
 
llvm::Optional< boolisSwiftPrivate () const
 
void setSwiftPrivate (llvm::Optional< bool > Private)
 
CommonEntityInfooperator|= (const CommonEntityInfo &RHS)
 
LLVM_DUMP_METHOD void dump (llvm::raw_ostream &OS) const
 

Public Attributes

std::string UnavailableMsg
 Message to use when this entity is unavailable. More...
 
unsigned Unavailable: 1
 Whether this entity is marked unavailable. More...
 
unsigned UnavailableInSwift: 1
 Whether this entity is marked unavailable in Swift. More...
 
std::string SwiftName
 Swift name of this entity. More...
 

Friends

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

Detailed Description

Describes API notes data for any entity.

This is used as the base of all API notes.

Definition at line 47 of file Types.h.

Constructor & Destructor Documentation

◆ CommonEntityInfo()

clang::api_notes::CommonEntityInfo::CommonEntityInfo ( )
inline

Definition at line 69 of file Types.h.

Member Function Documentation

◆ dump()

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

◆ isSwiftPrivate()

llvm::Optional<bool> clang::api_notes::CommonEntityInfo::isSwiftPrivate ( ) const
inline

Definition at line 73 of file Types.h.

Referenced by operator|=().

◆ operator|=()

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

◆ setSwiftPrivate()

void clang::api_notes::CommonEntityInfo::setSwiftPrivate ( llvm::Optional< bool Private)
inline

Definition at line 78 of file Types.h.

Referenced by operator|=().

Friends And Related Function Documentation

◆ operator==

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

Definition at line 111 of file Types.h.

Member Data Documentation

◆ SwiftName

std::string clang::api_notes::CommonEntityInfo::SwiftName

Swift name of this entity.

Definition at line 67 of file Types.h.

Referenced by dump(), clang::api_notes::operator==(), and operator|=().

◆ Unavailable

unsigned clang::api_notes::CommonEntityInfo::Unavailable

Whether this entity is marked unavailable.

Definition at line 53 of file Types.h.

Referenced by dump(), clang::api_notes::operator==(), and operator|=().

◆ UnavailableInSwift

unsigned clang::api_notes::CommonEntityInfo::UnavailableInSwift

Whether this entity is marked unavailable in Swift.

Definition at line 56 of file Types.h.

Referenced by dump(), clang::api_notes::operator==(), and operator|=().

◆ UnavailableMsg

std::string clang::api_notes::CommonEntityInfo::UnavailableMsg

Message to use when this entity is unavailable.

Definition at line 50 of file Types.h.

Referenced by dump(), clang::api_notes::operator==(), and operator|=().


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