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

#include <Representation.h>

Inheritance diagram for clang::doc::Index:
Inheritance graph

Public Member Functions

 Index ()=default
 Index (StringRef Name)
 Index (StringRef Name, StringRef JumpToSection)
 Index (SymbolID USR, StringRef Name, InfoType IT, StringRef Path)
bool operator== (const SymbolID &Other) const
bool operator< (const Index &Other) const
void sort ()
- Public Member Functions inherited from clang::doc::Reference
 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

std::optional< SmallString< 16 > > JumpToSection
std::vector< IndexChildren
- Public Attributes inherited from clang::doc::Reference
SymbolID USR = SymbolID()
SmallString< 16 > Name
SmallString< 16 > QualName
InfoType RefType = InfoType::IT_default
llvm::SmallString< 128 > Path

Detailed Description

Definition at line 455 of file Representation.h.

Constructor & Destructor Documentation

◆ Index() [1/4]

clang::doc::Index::Index ( )

◆ Index() [2/4]

clang::doc::Index::Index ( StringRef  Name)

Definition at line 457 of file Representation.h.

◆ Index() [3/4]

clang::doc::Index::Index ( StringRef  Name,
StringRef  JumpToSection 

Definition at line 458 of file Representation.h.

◆ Index() [4/4]

clang::doc::Index::Index ( SymbolID  USR,
StringRef  Name,
InfoType  IT,
StringRef  Path 

Definition at line 460 of file Representation.h.

Member Function Documentation

◆ operator<()

bool clang::doc::Index::operator< ( const Index Other) const

Definition at line 342 of file Representation.cpp.

References clang::doc::Reference::Name.

◆ operator==()

bool clang::doc::Index::operator== ( const SymbolID Other) const

Definition at line 463 of file Representation.h.

References clang::doc::Reference::USR.

◆ sort()

void clang::doc::Index::sort ( )

Definition at line 361 of file Representation.cpp.

References C, and Children.

Referenced by clang::doc::genIndex(), clang::doc::SerializeIndex(), and clang::doc::serializeIndex().

Member Data Documentation

◆ Children

std::vector<Index> clang::doc::Index::Children

◆ JumpToSection

std::optional<SmallString<16> > clang::doc::Index::JumpToSection

Definition at line 466 of file Representation.h.

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

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