MDGenerator.cpp File Reference

This file contains the implementation of the MDGenerator, which generates documentation in Markdown format using Mustache templates. More...

#include "Generators.h"

Go to the source code of this file.

Namespaces
namespace	clang
	===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
namespace	clang::doc

Functions
static GeneratorRegistry::Add< MDGenerator >	MD (MDGenerator::Format, "Generator for Markdown output.")

Variables
static std::unique_ptr< MustacheTemplateFile >	RecordTemplate = nullptr
static std::unique_ptr< MustacheTemplateFile >	NamespaceTemplate = nullptr
static std::unique_ptr< MustacheTemplateFile >	AllFilesTemplate = nullptr
static std::unique_ptr< MustacheTemplateFile >	IndexTemplate = nullptr

Detailed Description

This file contains the implementation of the MDGenerator, which generates documentation in Markdown format using Mustache templates.

It defines how the structured data in Info objects is mapped to template tags to produce readable markdown documents.

Definition in file MDGenerator.cpp.

Function Documentation

MD()

GeneratorRegistry::Add< MDGenerator > MD ( MDGenerator::Format , "Generator for Markdown output."  )

static

Referenced by clang::tidy::bugprone::ComparePointerToMemberVirtualFunctionCheck::check(), clang::tidy::misc::DefinitionsInHeadersCheck::check(), clang::tidy::misc::NewDeleteOverloadsCheck::check(), clang::clangd::CollectMainFileMacros::Defined(), clang::clangd::CollectMainFileMacros::Elifdef(), clang::tidy::modernize::MacroToEnumCallbacks::Elifdef(), clang::clangd::CollectMainFileMacros::Elifndef(), clang::tidy::modernize::MacroToEnumCallbacks::Elifndef(), clang::tidy::misc::hasCorrespondingOverloadInBaseClass(), clang::clangd::CollectMainFileMacros::Ifdef(), clang::find_all_symbols::FindAllMacros::Ifdef(), clang::tidy::modernize::MacroToEnumCallbacks::Ifdef(), clang::clangd::CollectMainFileMacros::Ifndef(), clang::find_all_symbols::FindAllMacros::Ifndef(), clang::tidy::modernize::MacroToEnumCallbacks::Ifndef(), clang::tidy::bugprone::isOverrideMethod(), clang::tidy::misc::isOverrideMethod(), clang::clangd::CollectMainFileMacros::MacroDefined(), clang::find_all_symbols::FindAllMacros::MacroDefined(), clang::tidy::modernize::MacroToEnumCallbacks::MacroDefined(), clang::clangd::CollectMainFileMacros::MacroExpands(), clang::find_all_symbols::FindAllMacros::MacroExpands(), clang::clangd::CollectMainFileMacros::MacroUndefined(), clang::tidy::modernize::MacroToEnumCallbacks::MacroUndefined(), clang::clangd::nameLocation(), clang::tidy::misc::NewDeleteOverloadsCheck::onEndOfTranslationUnit(), clang::tidy::utils::refersToEnclosingLambdaCaptureByRef(), clang::tidy::cppcoreguidelines::MacroUsageCheck::warnMacro(), clang::tidy::cppcoreguidelines::MacroUsageCheck::warnNaming(), and clang::tooling::ExpandModularHeadersPPCallbacks::~ExpandModularHeadersPPCallbacks().

Variable Documentation

AllFilesTemplate

std::unique_ptr<MustacheTemplateFile> AllFilesTemplate = nullptr

static

Definition at line 26 of file MDGenerator.cpp.

Referenced by getMdFiles().

IndexTemplate

std::unique_ptr<MustacheTemplateFile> IndexTemplate = nullptr

static

Definition at line 28 of file MDGenerator.cpp.

Referenced by getHtmlFiles(), and getMdFiles().

NamespaceTemplate

std::unique_ptr<MustacheTemplateFile> NamespaceTemplate = nullptr

static

Definition at line 24 of file MDGenerator.cpp.

Referenced by getHtmlFiles(), and getMdFiles().

RecordTemplate

std::unique_ptr<MustacheTemplateFile> RecordTemplate = nullptr

static

Definition at line 22 of file MDGenerator.cpp.