clang-tools 19.0.0git
Public Member Functions | Public Attributes | List of all members
clang::doc::Reference Struct Reference

#include <Representation.h>

Inheritance diagram for clang::doc::Reference:
Inheritance graph

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())
bool operator== (const Reference &Other) const
bool mergeable (const Reference &Other)
void merge (Reference &&I)
llvm::SmallString< 64 > getRelativeFilePath (const StringRef &CurrentPath) const
 Returns the path for this Reference relative to CurrentPath.
llvm::SmallString< 16 > getFileBaseName () const
 Returns the basename that should be used for this Reference.

Public Attributes

SymbolID USR = SymbolID()
SmallString< 16 > Name
SmallString< 16 > QualName
InfoType RefType = InfoType::IT_default
llvm::SmallString< 128 > Path

Detailed Description

Definition at line 87 of file Representation.h.

Constructor & Destructor Documentation

◆ Reference() [1/2]

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

Definition at line 93 of file Representation.h.

◆ Reference() [2/2]

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

Definition at line 96 of file Representation.h.

Member Function Documentation

◆ getFileBaseName()

llvm::SmallString< 16 > clang::doc::Reference::getFileBaseName ( ) const

Returns the basename that should be used for this Reference.

Definition at line 158 of file Representation.cpp.

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

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

◆ getRelativeFilePath()

llvm::SmallString< 64 > clang::doc::Reference::getRelativeFilePath ( const StringRef &  CurrentPath) const

Returns the path for this Reference relative to CurrentPath.

Definition at line 154 of file Representation.cpp.

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

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

◆ merge()

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

Definition at line 181 of file Representation.cpp.

References mergeable(), Name, and Path.

◆ mergeable()

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

Definition at line 177 of file Representation.cpp.

References RefType, and USR.

Referenced by merge().

◆ operator==()

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

Definition at line 100 of file Representation.h.

References Name, QualName, RefType, and USR.

Member Data Documentation

◆ Name

SmallString<16> clang::doc::Reference::Name

◆ Path

llvm::SmallString<128> clang::doc::Reference::Path

◆ QualName

SmallString<16> clang::doc::Reference::QualName

◆ RefType

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


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

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