clang-tools 22.0.0git
clang::doc::FriendInfo Struct Reference

#include <Representation.h>

Inheritance diagram for clang::doc::FriendInfo:
[legend]

Public Member Functions

 FriendInfo ()
 FriendInfo (SymbolID USR)
 FriendInfo (const InfoType IT, const SymbolID &USR, const StringRef Name=StringRef())
bool mergeable (const FriendInfo &Other)
void merge (FriendInfo &&Other)
Public Member Functions inherited from clang::doc::SymbolInfo
 SymbolInfo (InfoType IT, SymbolID USR=SymbolID(), StringRef Name=StringRef(), StringRef Path=StringRef())
void merge (SymbolInfo &&I)
bool operator< (const SymbolInfo &Other) const
Public Member Functions inherited from clang::doc::Info
 Info (InfoType IT=InfoType::IT_default, SymbolID USR=SymbolID(), StringRef Name=StringRef(), StringRef Path=StringRef())
 Info (const Info &Other)=delete
 Info (Info &&Other)=default
virtual ~Info ()=default
Infooperator= (Info &&Other)=default
void mergeBase (Info &&I)
bool mergeable (const Info &Other)
llvm::SmallString< 16 > extractName () const
llvm::SmallString< 64 > getRelativeFilePath (const StringRef &CurrentPath) const
 Returns the file path for this Info relative to CurrentPath.
llvm::SmallString< 16 > getFileBaseName () const
 Returns the basename that should be used for this Info.

Public Attributes

Reference Ref
std::optional< TemplateInfoTemplate
std::optional< TypeInfoReturnType
std::optional< SmallVector< FieldTypeInfo, 4 > > Params
bool IsClass = false
Public Attributes inherited from clang::doc::SymbolInfo
std::optional< LocationDefLoc
llvm::SmallVector< Location, 2 > Loc
SmallString< 16 > MangledName
bool IsStatic = false
Public Attributes inherited from clang::doc::Info
SymbolID USR
InfoType IT = InfoType::IT_default
SmallString< 16 > Name
llvm::SmallVector< Reference, 4 > Namespace
std::vector< CommentInfoDescription
llvm::SmallString< 128 > Path
SmallString< 16 > DocumentationFileName

Detailed Description

Definition at line 394 of file Representation.h.

Constructor & Destructor Documentation

◆ FriendInfo() [1/3]

clang::doc::FriendInfo::FriendInfo ( )
inline

Definition at line 395 of file Representation.h.

References clang::doc::IT_friend, and clang::doc::SymbolInfo::SymbolInfo().

Referenced by merge(), and mergeable().

◆ FriendInfo() [2/3]

clang::doc::FriendInfo::FriendInfo ( SymbolID USR)
inline

◆ FriendInfo() [3/3]

clang::doc::FriendInfo::FriendInfo ( const InfoType IT,
const SymbolID & USR,
const StringRef Name = StringRef() )
inline

Member Function Documentation

◆ merge()

void clang::doc::FriendInfo::merge ( FriendInfo && Other)

Definition at line 258 of file Representation.cpp.

References FriendInfo(), mergeable(), and Ref.

◆ mergeable()

bool clang::doc::FriendInfo::mergeable ( const FriendInfo & Other)

Definition at line 254 of file Representation.cpp.

References FriendInfo(), clang::doc::Reference::Name, Ref, and clang::doc::Reference::USR.

Referenced by merge().

Member Data Documentation

◆ IsClass

◆ Params

std::optional<SmallVector<FieldTypeInfo, 4> > clang::doc::FriendInfo::Params

◆ Ref

◆ ReturnType

std::optional<TypeInfo> clang::doc::FriendInfo::ReturnType

◆ Template


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