clang::doc::Context Struct Reference

#include <Representation.h>

Inheritance diagram for clang::doc::Context:

Public Member Functions
	Context (SymbolID USR, StringRef Name, InfoType IT, StringRef QualName, StringRef Path, StringRef DocumentationFileName)
	Context (const Info &I)
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, 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
StringRef	RelativePath = {}
Public Attributes inherited from clang::doc::Reference
SymbolID	USR = SymbolID()
InfoType	RefType = InfoType::IT_default
StringRef	Name = {}
StringRef	QualName = {}
StringRef	Path = {}
StringRef	DocumentationFileName = {}

Detailed Description

Definition at line 358 of file Representation.h.

Constructor & Destructor Documentation

Context() [1/2]

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

inline

Definition at line 359 of file Representation.h.

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

Context() [2/2]

clang::doc::Context::Context ( const Info & I )

inlineexplicit

Definition at line 579 of file Representation.h.

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

Member Data Documentation

RelativePath

StringRef clang::doc::Context::RelativePath = {}

Definition at line 363 of file Representation.h.

---

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

• Representation.h