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())
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
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 367 of file Representation.h.

Constructor & Destructor Documentation

SymbolInfo()

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

inline

Definition at line 368 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::FunctionInfo::FunctionInfo(), merge(), operator<(), clang::doc::RecordInfo::RecordInfo(), clang::doc::TypedefInfo::TypedefInfo(), clang::doc::VarInfo::VarInfo(), and clang::doc::VarInfo::VarInfo().

Member Function Documentation

merge()

void clang::doc::SymbolInfo::merge

(

SymbolInfo &&

I

)

Definition at line 285 of file Representation.cpp.

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

operator<()

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

inline

Definition at line 374 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 388 of file Representation.h.

Referenced by clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::genHTML(), clang::doc::genHTML(), clang::doc::genHTML(), 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::serialize::populateSymbolInfo(), and llvm::yaml::symbolInfoMapping().

IsStatic

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

Definition at line 391 of file Representation.h.

Referenced by clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::serialize::emitInfo(), clang::doc::serialize::emitInfo(), clang::doc::genHTML(), clang::doc::genMarkdown(), clang::doc::VarInfo::merge(), clang::doc::serialize::parseBases(), clang::doc::parseRecord(), clang::doc::parseRecord(), clang::doc::serialize::populateFunctionInfo(), clang::doc::serializeInfo(), and clang::doc::serializeInfo().

Loc

llvm::SmallVector<Location, 2> clang::doc::SymbolInfo::Loc

Definition at line 389 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(), clang::doc::serialize::populateSymbolInfo(), and llvm::yaml::symbolInfoMapping().

MangledName

SmallString<16> clang::doc::SymbolInfo::MangledName

Definition at line 390 of file Representation.h.

Referenced by clang::doc::determineFileName(), clang::doc::ClangDocBitcodeWriter::emitBlock(), merge(), clang::doc::parseRecord(), clang::doc::serialize::populateSymbolInfo(), and clang::doc::serializeInfo().

---

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

• Representation.h
• Representation.cpp