clang-tools: clang::doc::Reference Struct Reference

clang-tools 23.0.0git

#include <Representation.h>

Inheritance diagram for clang::doc::Reference:

Public Member Functions
	Reference (SymbolID USR=SymbolID(), StringRef Name=StringRef(), InfoType IT=InfoType::IT_default)
	Reference (SymbolID USR, StringRef Name, InfoType IT, StringRef QualName, StringRef Path=StringRef())
	Reference (SymbolID USR, StringRef Name, InfoType IT, StringRef QualName, StringRef Path, StringRef DocumentationFileName)
bool	operator== (const Reference &Other) const
bool	mergeable (const Reference &Other)
void	merge (Reference &&I)
bool	operator< (const Reference &Other) const
StringRef	getRelativeFilePath (const StringRef &CurrentPath) const
	Returns the path for this Reference relative to CurrentPath.
StringRef	getFileBaseName () const
	Returns the basename that should be used for this Reference.

Public Attributes
SymbolID	USR = SymbolID()
InfoType	RefType = InfoType::IT_default
StringRef	Name = {}
StringRef	QualName = {}
StringRef	Path = {}
StringRef	DocumentationFileName = {}

Detailed Description

Definition at line 244 of file Representation.h.

Constructor & Destructor Documentation

◆ Reference() [1/3]

clang::doc::Reference::Reference	(	SymbolID	USR = SymbolID(),
		StringRef	Name = StringRef(),
		InfoType	IT = InfoType::IT_default )

inline

Definition at line 250 of file Representation.h.

References clang::doc::internString(), clang::doc::IT_default, Name, QualName, RefType, and USR.

Referenced by clang::doc::Context::Context(), clang::doc::Context::Context(), clang::doc::Index::Index(), clang::doc::Index::Index(), clang::doc::Index::Index(), merge(), mergeable(), operator<(), and operator==().

◆ Reference() [2/3]

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

inline

Definition at line 254 of file Representation.h.

References clang::doc::internString(), Name, Path, QualName, RefType, and USR.

◆ Reference() [3/3]

clang::doc::Reference::Reference	(	SymbolID	USR,
		StringRef	Name,
		InfoType	IT,
		StringRef	QualName,
		StringRef	Path,
		StringRef	DocumentationFileName )

inline

Definition at line 258 of file Representation.h.

References DocumentationFileName, clang::doc::internString(), Name, Path, QualName, RefType, and USR.

Member Function Documentation

◆ getFileBaseName()

StringRef clang::doc::Reference::getFileBaseName ( ) const

Returns the basename that should be used for this Reference.

Definition at line 385 of file Representation.cpp.

References clang::doc::IT_namespace, Name, and RefType.

Referenced by clang::doc::preprocessCDCtxIndex(), and clang::doc::writeNameLink().

◆ getRelativeFilePath()

StringRef clang::doc::Reference::getRelativeFilePath ( const StringRef & CurrentPath ) const

Returns the path for this Reference relative to CurrentPath.

Definition at line 380 of file Representation.cpp.

References clang::doc::calculateRelativeFilePath(), clang::doc::internString(), Name, Path, and RefType.

Referenced by clang::doc::preprocessCDCtxIndex(), and clang::doc::writeNameLink().

◆ merge()

void clang::doc::Reference::merge ( Reference && I )

Definition at line 408 of file Representation.cpp.

References DocumentationFileName, mergeable(), Name, Path, QualName, and Reference().

Referenced by clang::doc::reduceChildren< Reference >().

◆ mergeable()

bool clang::doc::Reference::mergeable ( const Reference & Other )

Definition at line 404 of file Representation.cpp.

References Reference(), RefType, and USR.

Referenced by merge().

◆ operator<()

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

inline

Definition at line 271 of file Representation.h.

References Name, and Reference().

◆ operator==()

bool clang::doc::Reference::operator== ( const Reference & Other ) const

inline

Definition at line 264 of file Representation.h.

References Name, QualName, Reference(), RefType, and USR.

Member Data Documentation

◆ DocumentationFileName

StringRef clang::doc::Reference::DocumentationFileName = {}

Definition at line 298 of file Representation.h.

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

◆ Name

StringRef clang::doc::Reference::Name = {}

◆ Path

StringRef clang::doc::Reference::Path = {}

Definition at line 297 of file Representation.h.

Referenced by clang::doc::Context::Context(), clang::doc::Context::Context(), clang::doc::ClangDocBitcodeWriter::emitBlock(), getRelativeFilePath(), clang::doc::Index::Index(), merge(), clang::doc::parseRecord(), clang::doc::preprocessCDCtxIndex(), Reference(), and Reference().

◆ QualName

StringRef clang::doc::Reference::QualName = {}

Definition at line 293 of file Representation.h.

Referenced by clang::doc::Context::Context(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::genMarkdown(), merge(), operator==(), clang::doc::parseRecord(), Reference(), Reference(), and Reference().

◆ RefType

InfoType clang::doc::Reference::RefType = InfoType::IT_default

Definition at line 281 of file Representation.h.

Referenced by clang::doc::ClangDocBitcodeWriter::emitBlock(), getFileBaseName(), getRelativeFilePath(), mergeable(), operator==(), clang::doc::parseRecord(), clang::doc::reduceChildren< Reference >(), Reference(), Reference(), and Reference().

◆ USR

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

Definition at line 279 of file Representation.h.

Referenced by clang::doc::Context::Context(), clang::doc::Context::Context(), clang::doc::ClangDocBitcodeWriter::emitBlock(), clang::doc::Index::Index(), clang::doc::FriendInfo::mergeable(), mergeable(), clang::doc::Index::operator==(), operator==(), clang::doc::parseRecord(), clang::doc::reduceChildren< Reference >(), Reference(), Reference(), and Reference().

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