clang::doc::FunctionInfo Struct Reference

#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())
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
Info &	operator= (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
bool	IsMethod = false
Reference	Parent
TypeInfo	ReturnType
llvm::SmallVector< FieldTypeInfo, 4 >	Params
AccessSpecifier	Access = AccessSpecifier::AS_public
SmallString< 256 >	Prototype
std::optional< TemplateInfo >	Template
Public Attributes inherited from clang::doc::SymbolInfo
std::optional< Location >	DefLoc
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< CommentInfo >	Description
llvm::SmallString< 128 >	Path
SmallString< 16 >	DocumentationFileName

Detailed Description

Definition at line 424 of file Representation.h.

Constructor & Destructor Documentation

FunctionInfo()

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

inline

Definition at line 425 of file Representation.h.

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

Referenced by merge().

Member Function Documentation

merge()

void clang::doc::FunctionInfo::merge

(

FunctionInfo &&

I

)

Definition at line 352 of file Representation.cpp.

References Access, clang::doc::EmptySID, FunctionInfo(), 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 438 of file Representation.h.

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

IsMethod

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

Definition at line 430 of file Representation.h.

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

Params

llvm::SmallVector<FieldTypeInfo, 4> clang::doc::FunctionInfo::Params

Definition at line 433 of file Representation.h.

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

Parent

Reference clang::doc::FunctionInfo::Parent

Definition at line 431 of file Representation.h.

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

Prototype

SmallString<256> clang::doc::FunctionInfo::Prototype

Definition at line 441 of file Representation.h.

Referenced by clang::doc::serialize::populateFunctionInfo().

ReturnType

TypeInfo clang::doc::FunctionInfo::ReturnType

Definition at line 432 of file Representation.h.

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

Template

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

Definition at line 444 of file Representation.h.

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

---

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

• Representation.h
• Representation.cpp