clang::doc::ClangDocContext Struct Reference

#include <Representation.h>

Public Member Functions
	ClangDocContext ()=default
	ClangDocContext (tooling::ExecutionContext *ECtx, StringRef ProjectName, bool PublicOnly, StringRef OutDirectory, StringRef SourceRoot, StringRef RepositoryUrl, StringRef RepositoryCodeLinePrefix, StringRef Base, std::vector< std::string > UserStylesheets, bool FTimeTrace=false)

Public Attributes
tooling::ExecutionContext *	ECtx
std::string	ProjectName
bool	PublicOnly
bool	FTimeTrace
int	Granularity
std::string	OutDirectory
std::string	SourceRoot
std::optional< std::string >	RepositoryUrl
std::optional< std::string >	RepositoryLinePrefix
std::vector< std::string >	UserStylesheets
std::vector< std::string >	JsScripts
StringRef	Base
llvm::StringMap< std::string >	MustacheTemplates
Index	Idx

Detailed Description

Definition at line 602 of file Representation.h.

Constructor & Destructor Documentation

ClangDocContext() [1/2]

clang::doc::ClangDocContext::ClangDocContext ( )

default

References Base, ECtx, FTimeTrace, OutDirectory, ProjectName, PublicOnly, RepositoryCodeLinePrefix(), RepositoryUrl, SourceRoot, and UserStylesheets.

ClangDocContext() [2/2]

clang::doc::ClangDocContext::ClangDocContext	(	tooling::ExecutionContext *	ECtx,
		StringRef	ProjectName,
		bool	PublicOnly,
		StringRef	OutDirectory,
		StringRef	SourceRoot,
		StringRef	RepositoryUrl,
		StringRef	RepositoryCodeLinePrefix,
		StringRef	Base,
		std::vector< std::string >	UserStylesheets,
		bool	FTimeTrace = false )

Definition at line 478 of file Representation.cpp.

References Base, ECtx, FTimeTrace, OutDirectory, ProjectName, PublicOnly, RepositoryLinePrefix, RepositoryUrl, SourceRoot, and UserStylesheets.

Member Data Documentation

Base

StringRef clang::doc::ClangDocContext::Base

Definition at line 628 of file Representation.h.

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

ECtx

tooling::ExecutionContext* clang::doc::ClangDocContext::ECtx

Definition at line 609 of file Representation.h.

Referenced by ClangDocContext(), and ClangDocContext().

FTimeTrace

bool clang::doc::ClangDocContext::FTimeTrace

Definition at line 612 of file Representation.h.

Referenced by ClangDocContext(), and ClangDocContext().

Granularity

int clang::doc::ClangDocContext::Granularity

Definition at line 613 of file Representation.h.

Idx

Index clang::doc::ClangDocContext::Idx

Definition at line 632 of file Representation.h.

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

JsScripts

std::vector<std::string> clang::doc::ClangDocContext::JsScripts

Definition at line 626 of file Representation.h.

Referenced by clang::doc::HTMLGenerator::createResources(), clang::doc::MustacheHTMLGenerator::createResources(), clang::doc::genJsScriptsHTML(), getMustacheHtmlFiles(), and clang::doc::setupTemplateValue().

MustacheTemplates

llvm::StringMap<std::string> clang::doc::ClangDocContext::MustacheTemplates

Definition at line 631 of file Representation.h.

Referenced by getMustacheHtmlFiles(), and clang::doc::setupTemplateFiles().

OutDirectory

std::string clang::doc::ClangDocContext::OutDirectory

Definition at line 614 of file Representation.h.

Referenced by ClangDocContext(), ClangDocContext(), clang::doc::HTMLGenerator::createResources(), clang::doc::MustacheHTMLGenerator::createResources(), clang::doc::genIndex(), clang::doc::genIndex(), and clang::doc::serializeIndex().

ProjectName

std::string clang::doc::ClangDocContext::ProjectName

Definition at line 610 of file Representation.h.

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

PublicOnly

bool clang::doc::ClangDocContext::PublicOnly

Definition at line 611 of file Representation.h.

Referenced by ClangDocContext(), and ClangDocContext().

RepositoryLinePrefix

std::optional<std::string> clang::doc::ClangDocContext::RepositoryLinePrefix

Definition at line 621 of file Representation.h.

Referenced by ClangDocContext(), clang::doc::writeSourceFileRef(), and clang::doc::writeSourceFileRef().

RepositoryUrl

std::optional<std::string> clang::doc::ClangDocContext::RepositoryUrl

Definition at line 619 of file Representation.h.

Referenced by ClangDocContext(), ClangDocContext(), clang::doc::JSONGenerator::generateDocForInfo(), clang::doc::writeSourceFileRef(), and clang::doc::writeSourceFileRef().

SourceRoot

std::string clang::doc::ClangDocContext::SourceRoot

Definition at line 615 of file Representation.h.

Referenced by ClangDocContext(), and ClangDocContext().

UserStylesheets

std::vector<std::string> clang::doc::ClangDocContext::UserStylesheets

Definition at line 624 of file Representation.h.

Referenced by ClangDocContext(), ClangDocContext(), clang::doc::HTMLGenerator::createResources(), clang::doc::MustacheHTMLGenerator::createResources(), clang::doc::genStylesheetsHTML(), getMustacheHtmlFiles(), and clang::doc::setupTemplateValue().

---

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

• Representation.h
• Representation.cpp