clang::doc::TypedefInfo Struct Reference

#include <Representation.h>

Inheritance diagram for clang::doc::TypedefInfo:

Public Member Functions
	TypedefInfo (SymbolID USR=SymbolID())
void	merge (TypedefInfo &&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
TypeInfo	Underlying
SmallString< 16 >	TypeDeclaration
std::vector< CommentInfo >	Description
	Comment description for the typedef.
bool	IsUsing = false
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 491 of file Representation.h.

Constructor & Destructor Documentation

TypedefInfo()

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

inline

Definition at line 492 of file Representation.h.

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

Referenced by merge().

Member Function Documentation

merge()

void clang::doc::TypedefInfo::merge

(

TypedefInfo &&

I

)

Definition at line 369 of file Representation.cpp.

References IsUsing, clang::doc::Info::mergeable(), TypedefInfo(), and Underlying.

Member Data Documentation

Description

std::vector<CommentInfo> clang::doc::TypedefInfo::Description

Comment description for the typedef.

Definition at line 503 of file Representation.h.

Referenced by clang::doc::getCommentInfo().

IsUsing

bool clang::doc::TypedefInfo::IsUsing = false

Definition at line 509 of file Representation.h.

Referenced by llvm::yaml::MappingTraits< TypedefInfo >::mapping(), merge(), clang::doc::parseRecord(), and clang::doc::serializeInfo().

TypeDeclaration

SmallString<16> clang::doc::TypedefInfo::TypeDeclaration

Definition at line 500 of file Representation.h.

Referenced by clang::doc::serializeInfo().

Underlying

TypeInfo clang::doc::TypedefInfo::Underlying

Definition at line 497 of file Representation.h.

Referenced by clang::doc::addTypeInfo(), llvm::yaml::MappingTraits< TypedefInfo >::mapping(), merge(), and clang::doc::serializeInfo().

---

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

• Representation.h
• Representation.cpp