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

clang-tools 23.0.0git

#include <Representation.h>

Inheritance diagram for clang::doc::FriendInfo:

Public Member Functions
	FriendInfo ()
	FriendInfo (SymbolID USR)
	FriendInfo (const InfoType IT, const SymbolID &USR, const StringRef Name=StringRef())
	FriendInfo (const FriendInfo &Other, llvm::BumpPtrAllocator &Arena)
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())
	SymbolInfo (const SymbolInfo &Other, llvm::BumpPtrAllocator &Arena)
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, llvm::BumpPtrAllocator &Arena)
	Info (const Info &Other)=delete
	Info (Info &&Other)=default
Info &	operator= (Info &&Other)=default
void	mergeBase (Info &&I)
bool	mergeable (const Info &Other)
StringRef	extractName () const
StringRef	getRelativeFilePath (const StringRef &CurrentPath) const
	Returns the file path for this Info relative to CurrentPath.
StringRef	getFileBaseName () const
	Returns the basename that should be used for this Info.

Static Public Member Functions
static bool	classof (const Info *I)
Static Public Member Functions inherited from clang::doc::SymbolInfo
static bool	classof (const Info *I)

Public Attributes
Reference	Ref
std::optional< TemplateInfo >	Template
std::optional< TypeInfo >	ReturnType
llvm::ArrayRef< FieldTypeInfo >	Params = {}
bool	IsClass = false
Public Attributes inherited from clang::doc::SymbolInfo
std::optional< Location >	DefLoc
DocList< Location >	Loc = {}
StringRef	MangledName = {}
bool	IsStatic = false
Public Attributes inherited from clang::doc::Info
StringRef	Path = {}
StringRef	Name = {}
StringRef	DocumentationFileName = {}
llvm::ArrayRef< Reference >	Namespace
SymbolID	USR = SymbolID()
SymbolID	ParentUSR = SymbolID()
InfoType	IT = InfoType::IT_default
DocList< CommentInfo >	Description = {}

Detailed Description

Definition at line 644 of file Representation.h.

Constructor & Destructor Documentation

◆ FriendInfo() [1/4]

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

inline

Definition at line 645 of file Representation.h.

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

Referenced by FriendInfo(), merge(), and mergeable().

◆ FriendInfo() [2/4]

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

inline

Definition at line 646 of file Representation.h.

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

◆ FriendInfo() [3/4]

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

inline

Definition at line 647 of file Representation.h.

References clang::doc::Info::IT, clang::doc::Info::Name, clang::doc::SymbolInfo::SymbolInfo(), and clang::doc::Info::USR.

◆ FriendInfo() [4/4]

clang::doc::FriendInfo::FriendInfo	(	const FriendInfo &	Other,
		llvm::BumpPtrAllocator &	Arena )

Definition at line 397 of file Representation.cpp.

References clang::doc::allocateArray(), FriendInfo(), IsClass, Params, Ref, ReturnType, clang::doc::SymbolInfo::SymbolInfo(), and Template.

Member Function Documentation

◆ classof()

bool clang::doc::FriendInfo::classof ( const Info * I )

inlinestatic

Definition at line 652 of file Representation.h.

References clang::doc::Info::IT, and clang::doc::IT_friend.

◆ merge()

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

Definition at line 391 of file Representation.cpp.

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

◆ mergeable()

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

Definition at line 387 of file Representation.cpp.

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

Referenced by merge().

Member Data Documentation

◆ IsClass

bool clang::doc::FriendInfo::IsClass = false

Definition at line 661 of file Representation.h.

Referenced by clang::doc::ClangDocBitcodeWriter::emitBlock(), FriendInfo(), and clang::doc::parseRecord().

◆ Params

llvm::ArrayRef<FieldTypeInfo> clang::doc::FriendInfo::Params = {}

Definition at line 660 of file Representation.h.

Referenced by clang::doc::ClangDocBitcodeWriter::emitBlock(), FriendInfo(), and clang::doc::ClangDocBitcodeReader::readBlock().

◆ Ref

Reference clang::doc::FriendInfo::Ref

Definition at line 657 of file Representation.h.

Referenced by clang::doc::addReference(), clang::doc::ClangDocBitcodeWriter::emitBlock(), FriendInfo(), merge(), and mergeable().

◆ ReturnType

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

Definition at line 659 of file Representation.h.

Referenced by clang::doc::addTypeInfo(), clang::doc::ClangDocBitcodeWriter::emitBlock(), and FriendInfo().

◆ Template

std::optional<TemplateInfo> clang::doc::FriendInfo::Template

Definition at line 658 of file Representation.h.

Referenced by clang::doc::addTemplate(), clang::doc::ClangDocBitcodeWriter::emitBlock(), and FriendInfo().

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