clang-tools  14.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
Collaboration diagram for clang::doc::Index:
Collaboration 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 ()=default
 Reference (llvm::StringRef Name)
 Reference (llvm::StringRef Name, StringRef Path)
 Reference (SymbolID USR, StringRef Name, InfoType IT)
 Reference (SymbolID USR, StringRef Name, InfoType IT, StringRef Path)
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. More...
llvm::SmallString< 16 > getFileBaseName () const
 Returns the basename that should be used for this Reference. More...

Public Attributes

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

Detailed Description

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

◆ Index() [3/4]

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

Definition at line 404 of file Representation.h.

◆ Index() [4/4]

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

Definition at line 406 of file Representation.h.

Member Function Documentation

◆ operator<()

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

Definition at line 297 of file Representation.cpp.

References ns1::ns2::D, and clang::doc::Reference::Name.

◆ operator==()

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

Definition at line 409 of file Representation.h.

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

◆ sort()

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

Definition at line 316 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

llvm::Optional<SmallString<16> > clang::doc::Index::JumpToSection

Definition at line 412 of file Representation.h.

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

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