clang::doc::SymbolInfo Struct Reference

#include <Representation.h>

Inheritance diagram for clang::doc::SymbolInfo:

Public Member Functions
	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.

Public Attributes
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 593 of file Representation.h.

Constructor & Destructor Documentation

SymbolInfo() [1/2]

clang::doc::SymbolInfo::SymbolInfo ( InfoType IT, SymbolID USR = SymbolID(), StringRef Name = StringRef(), StringRef Path = StringRef() )

inline

Definition at line 594 of file Representation.h.

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

Referenced by clang::doc::ConceptInfo::ConceptInfo(), clang::doc::ConceptInfo::ConceptInfo(), clang::doc::EnumInfo::EnumInfo(), clang::doc::EnumInfo::EnumInfo(), clang::doc::FriendInfo::FriendInfo(), clang::doc::FriendInfo::FriendInfo(), clang::doc::FriendInfo::FriendInfo(), clang::doc::FriendInfo::FriendInfo(), clang::doc::FunctionInfo::FunctionInfo(), merge(), operator<(), clang::doc::RecordInfo::RecordInfo(), clang::doc::RecordInfo::RecordInfo(), SymbolInfo(), clang::doc::TypedefInfo::TypedefInfo(), clang::doc::VarInfo::VarInfo(), and clang::doc::VarInfo::VarInfo().

SymbolInfo() [2/2]

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

Definition at line 477 of file Representation.cpp.

References DefLoc, clang::doc::Info::Info(), IsStatic, Loc, MangledName, and SymbolInfo().

Member Function Documentation

merge()

void clang::doc::SymbolInfo::merge

(

SymbolInfo &&

I

)

Definition at line 488 of file Representation.cpp.

References DefLoc, IsStatic, Loc, MangledName, clang::doc::Info::mergeable(), clang::doc::Info::mergeBase(), clang::doc::mergeUnkeyed(), and SymbolInfo().

operator<()

bool clang::doc::SymbolInfo::operator< ( const SymbolInfo & Other ) const

inline

Definition at line 602 of file Representation.h.

References DefLoc, clang::doc::Info::extractName(), Loc, and SymbolInfo().

Member Data Documentation

DefLoc

std::optional<Location> clang::doc::SymbolInfo::DefLoc

Definition at line 616 of file Representation.h.

Referenced by clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::genMarkdown(), clang::doc::genMarkdown(), clang::doc::genMarkdown(), merge(), operator<(), clang::doc::parseRecord(), clang::doc::parseRecord(), clang::doc::parseRecord(), clang::doc::parseRecord(), clang::doc::parseRecord(), clang::doc::parseRecord(), SymbolInfo(), and llvm::yaml::symbolInfoMapping().

IsStatic

bool clang::doc::SymbolInfo::IsStatic = false

Definition at line 619 of file Representation.h.

Referenced by clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::serialize::Serializer::emitInfo(), clang::doc::serialize::Serializer::emitInfo(), clang::doc::genMarkdown(), merge(), clang::doc::VarInfo::merge(), clang::doc::parseRecord(), clang::doc::parseRecord(), and SymbolInfo().

Loc

DocList<Location> clang::doc::SymbolInfo::Loc = {}

Definition at line 617 of file Representation.h.

Referenced by clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), merge(), operator<(), clang::doc::parseRecord(), clang::doc::parseRecord(), clang::doc::parseRecord(), SymbolInfo(), and llvm::yaml::symbolInfoMapping().

MangledName

StringRef clang::doc::SymbolInfo::MangledName = {}

Definition at line 618 of file Representation.h.

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

---

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

• Representation.h
• Representation.cpp