#include <Representation.h>

Inheritance diagram for clang::doc::FunctionInfo:

Public Member Functions
	FunctionInfo (SymbolID USR=SymbolID())
void	merge (FunctionInfo &&I)
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	Parent
TypeInfo	ReturnType
llvm::ArrayRef< FieldTypeInfo >	Params = {}
StringRef	Prototype = {}
std::optional< TemplateInfo >	Template
AccessSpecifier	Access = AccessSpecifier::AS_public
bool	IsMethod = 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 677 of file Representation.h.

Constructor & Destructor Documentation

◆ FunctionInfo()

clang::doc::FunctionInfo::FunctionInfo ( SymbolID USR = SymbolID() )

inline

Definition at line 678 of file Representation.h.

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

Referenced by merge().

Member Function Documentation

◆ classof()

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

inlinestatic

Definition at line 681 of file Representation.h.

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

◆ merge()

void clang::doc::FunctionInfo::merge ( FunctionInfo && I )

Definition at line 561 of file Representation.cpp.

References Access, clang::doc::allocateArray(), clang::doc::EmptySID, FunctionInfo(), clang::doc::getPersistentArena(), IsMethod, clang::doc::Info::mergeable(), Params, Parent, ReturnType, and Template.

Member Data Documentation

◆ Access

AccessSpecifier clang::doc::FunctionInfo::Access = AccessSpecifier::AS_public

Definition at line 697 of file Representation.h.

Referenced by clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::serialize::Serializer::emitInfo(), clang::doc::serialize::Serializer::emitInfo(), genMarkdown(), llvm::yaml::MappingTraits< FunctionInfo >::mapping(), merge(), and clang::doc::parseRecord().

◆ IsMethod

bool clang::doc::FunctionInfo::IsMethod = false

Definition at line 699 of file Representation.h.

Referenced by clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::serialize::Serializer::emitInfo(), llvm::yaml::MappingTraits< FunctionInfo >::mapping(), merge(), and clang::doc::parseRecord().

◆ Params

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

Definition at line 687 of file Representation.h.

Referenced by clang::doc::ClangDocBitcodeWriter::emitBlock(), genMarkdown(), llvm::yaml::MappingTraits< FunctionInfo >::mapping(), merge(), and clang::doc::ClangDocBitcodeReader::readBlock().

◆ Parent

Reference clang::doc::FunctionInfo::Parent

Definition at line 685 of file Representation.h.

Referenced by clang::doc::addReference(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::serialize::Serializer::emitInfo(), llvm::yaml::MappingTraits< FunctionInfo >::mapping(), and merge().

◆ Prototype

StringRef clang::doc::FunctionInfo::Prototype = {}

Definition at line 688 of file Representation.h.

◆ ReturnType

TypeInfo clang::doc::FunctionInfo::ReturnType

Definition at line 686 of file Representation.h.

Referenced by clang::doc::addTypeInfo(), clang::doc::ClangDocBitcodeWriter::emitBlock(), genMarkdown(), llvm::yaml::MappingTraits< FunctionInfo >::mapping(), and merge().

◆ Template

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

Definition at line 691 of file Representation.h.

Referenced by clang::doc::addTemplate(), clang::doc::ClangDocBitcodeWriter::emitBlock(), llvm::yaml::MappingTraits< FunctionInfo >::mapping(), and merge().

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

Public Member Functions

Static Public Member Functions

Public Attributes