clang-tools: clang::doc::ClangDocContext Struct Reference

clang-tools 23.0.0git

#include <Representation.h>

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

Public Attributes
tooling::ExecutionContext *	ECtx
std::string	ProjectName
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
clang::DiagnosticsEngine &	Diags
Index	Idx
OutputFormatTy	Format
int	Granularity
bool	PublicOnly
bool	FTimeTrace

Detailed Description

Definition at line 661 of file Representation.h.

Constructor & Destructor Documentation

◆ ClangDocContext()

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,
		clang::DiagnosticsEngine &	Diags,
		OutputFormatTy	Format,
		bool	FTimeTrace = false )

Definition at line 488 of file Representation.cpp.

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

Member Data Documentation

◆ Base

StringRef clang::doc::ClangDocContext::Base

Definition at line 684 of file Representation.h.

Referenced by ClangDocContext().

◆ Diags

clang::DiagnosticsEngine& clang::doc::ClangDocContext::Diags

Definition at line 689 of file Representation.h.

Referenced by ClangDocContext(), and clang::doc::MustacheGenerator::generateDocumentation().

◆ ECtx

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

Definition at line 668 of file Representation.h.

Referenced by ClangDocContext().

◆ Format

OutputFormatTy clang::doc::ClangDocContext::Format

Definition at line 691 of file Representation.h.

Referenced by ClangDocContext().

◆ FTimeTrace

bool clang::doc::ClangDocContext::FTimeTrace

Definition at line 694 of file Representation.h.

Referenced by ClangDocContext().

◆ Granularity

int clang::doc::ClangDocContext::Granularity

Definition at line 692 of file Representation.h.

◆ Idx

Index clang::doc::ClangDocContext::Idx

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

Referenced by clang::doc::HTMLGenerator::createResources(), getHtmlFiles(), and clang::doc::HTMLGenerator::setupTemplateResources().

◆ MustacheTemplates

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

Definition at line 687 of file Representation.h.

Referenced by getHtmlFiles(), getMdFiles(), clang::doc::HTMLGenerator::setupTemplateFiles(), and clang::doc::MDMustacheGenerator::setupTemplateFiles().

◆ OutDirectory

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

Definition at line 670 of file Representation.h.

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

◆ ProjectName

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

Definition at line 669 of file Representation.h.

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

◆ PublicOnly

bool clang::doc::ClangDocContext::PublicOnly

Definition at line 693 of file Representation.h.

Referenced by ClangDocContext().

◆ RepositoryLinePrefix

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

Definition at line 677 of file Representation.h.

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

◆ RepositoryUrl

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

Definition at line 675 of file Representation.h.

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

◆ SourceRoot

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

Definition at line 671 of file Representation.h.

Referenced by ClangDocContext().

◆ UserStylesheets

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

Definition at line 680 of file Representation.h.

Referenced by ClangDocContext(), clang::doc::HTMLGenerator::createResources(), getHtmlFiles(), and clang::doc::HTMLGenerator::setupTemplateResources().

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