clang::doc::EnumInfo Struct Reference

#include <Representation.h>

Inheritance diagram for clang::doc::EnumInfo:

Public Member Functions
	EnumInfo ()
	EnumInfo (SymbolID USR)
void	merge (EnumInfo &&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)
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.

Public Attributes
bool	Scoped = false
std::optional< TypeInfo >	BaseType
llvm::SmallVector< EnumValueInfo, 4 >	Members
Public Attributes inherited from clang::doc::SymbolInfo
std::optional< Location >	DefLoc
llvm::SmallVector< Location, 2 >	Loc
StringRef	MangledName
bool	IsStatic = false
Public Attributes inherited from clang::doc::Info
StringRef	Path
StringRef	Name
StringRef	DocumentationFileName
llvm::SmallVector< Reference, 4 >	Namespace
SymbolID	USR = SymbolID()
SymbolID	ParentUSR = SymbolID()
InfoType	IT = InfoType::IT_default
OwningVec< CommentInfo >	Description
SmallVector< Context, 4 >	Contexts

Detailed Description

Definition at line 684 of file Representation.h.

Constructor & Destructor Documentation

EnumInfo() [1/2]

clang::doc::EnumInfo::EnumInfo ( )

inline

Definition at line 685 of file Representation.h.

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

Referenced by merge().

EnumInfo() [2/2]

clang::doc::EnumInfo::EnumInfo ( SymbolID USR )

inline

Definition at line 686 of file Representation.h.

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

Member Function Documentation

merge()

void clang::doc::EnumInfo::merge

(

EnumInfo &&

I

)

Definition at line 369 of file Representation.cpp.

References EnumInfo(), Members, clang::doc::Info::mergeable(), and Scoped.

Member Data Documentation

BaseType

std::optional<TypeInfo> clang::doc::EnumInfo::BaseType

Definition at line 696 of file Representation.h.

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

Members

llvm::SmallVector<EnumValueInfo, 4> clang::doc::EnumInfo::Members

Definition at line 698 of file Representation.h.

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

Scoped

bool clang::doc::EnumInfo::Scoped = false

Definition at line 691 of file Representation.h.

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

---

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

• Representation.h
• Representation.cpp