clang::doc::Index Struct Reference

#include <Representation.h>

Inheritance diagram for clang::doc::Index:

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())
	Reference (SymbolID USR, StringRef Name, InfoType IT, StringRef QualName, StringRef Path, SmallString< 16 > DocumentationFileName)
bool	operator== (const Reference &Other) const
bool	mergeable (const Reference &Other)
void	merge (Reference &&I)
bool	operator< (const Reference &Other) const
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< Index >	Children
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
SmallString< 16 >	DocumentationFileName

Detailed Description

Definition at line 577 of file Representation.h.

Constructor & Destructor Documentation

Index() [1/4]

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

default

Referenced by operator<().

Index() [2/4]

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

inline

Definition at line 579 of file Representation.h.

References clang::doc::Reference::Name, and clang::doc::Reference::Reference().

Index() [3/4]

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

inline

Definition at line 580 of file Representation.h.

References JumpToSection, clang::doc::Reference::Name, and clang::doc::Reference::Reference().

Index() [4/4]

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

inline

Definition at line 582 of file Representation.h.

References clang::doc::Reference::Name, clang::doc::Reference::Path, clang::doc::Reference::Reference(), and clang::doc::Reference::USR.

Member Function Documentation

operator<()

bool clang::doc::Index::operator<

(

const Index &

Other

)

const

Definition at line 453 of file Representation.cpp.

References Index(), and clang::doc::Reference::Name.

operator==()

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

inline

Definition at line 585 of file Representation.h.

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

sort()

void clang::doc::Index::sort

(

)

Definition at line 472 of file Representation.cpp.

References Children.

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

Member Data Documentation

Children

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

Definition at line 589 of file Representation.h.

Referenced by clang::doc::Generator::addInfoToIndex(), clang::doc::genHTML(), clang::doc::genHTML(), clang::doc::genHTML(), clang::doc::genIndex(), clang::doc::genInfoIndexItem(), clang::doc::serializeIndex(), and sort().

JumpToSection

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

Definition at line 588 of file Representation.h.

Referenced by clang::doc::genHTML(), and Index().

---

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

• Representation.h
• Representation.cpp