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

clang-tools 17.0.0git

#include <Representation.h>

Public Member Functions
	ClangDocContext ()=default

	ClangDocContext (tooling::ExecutionContext *ECtx, StringRef ProjectName, bool PublicOnly, StringRef OutDirectory, StringRef SourceRoot, StringRef RepositoryUrl, std::vector< std::string > UserStylesheets, std::vector< std::string > JsScripts)

Public Attributes
tooling::ExecutionContext *	ECtx

std::string	ProjectName

bool	PublicOnly

std::string	OutDirectory

std::string	SourceRoot

std::optional< std::string >	RepositoryUrl

std::vector< std::string >	UserStylesheets

std::vector< std::string >	JsScripts

std::vector< std::string >	FilesToCopy

Index	Idx

Detailed Description

Definition at line 480 of file Representation.h.

Constructor & Destructor Documentation

◆ ClangDocContext() [1/2]

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

default

◆ ClangDocContext() [2/2]

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

Definition at line 367 of file Representation.cpp.

References RepositoryUrl, and SourceRoot.

Member Data Documentation

◆ ECtx

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

Definition at line 487 of file Representation.h.

◆ FilesToCopy

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

Definition at line 502 of file Representation.h.

Referenced by clang::doc::HTMLGenerator::createResources().

◆ Idx

Index clang::doc::ClangDocContext::Idx

Definition at line 503 of file Representation.h.

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

◆ JsScripts

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

Definition at line 500 of file Representation.h.

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

◆ OutDirectory

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

Definition at line 490 of file Representation.h.

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

◆ ProjectName

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

Definition at line 488 of file Representation.h.

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

◆ PublicOnly

bool clang::doc::ClangDocContext::PublicOnly

Definition at line 489 of file Representation.h.

◆ RepositoryUrl

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

Definition at line 495 of file Representation.h.

Referenced by ClangDocContext(), clang::doc::genHTML(), and clang::doc::writeFileDefinition().

◆ SourceRoot

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

Definition at line 491 of file Representation.h.

Referenced by ClangDocContext().

◆ UserStylesheets

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

Definition at line 498 of file Representation.h.

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

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