clang-tools 23.0.0git
MDMustacheGenerator.cpp File Reference

This file contains the implementation of the MDMustacheGenerator, 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< MDMustacheGenerator > MDMustache (MDMustacheGenerator::Format, "Generator for mustache Markdown output.")

Variables

static std::unique_ptr< MustacheTemplateFileRecordTemplate = nullptr
static std::unique_ptr< MustacheTemplateFileNamespaceTemplate = nullptr
static std::unique_ptr< MustacheTemplateFileAllFilesTemplate = nullptr
static std::unique_ptr< MustacheTemplateFileIndexTemplate = nullptr

Detailed Description

This file contains the implementation of the MDMustacheGenerator, 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 MDMustacheGenerator.cpp.

Function Documentation

◆ MDMustache()

GeneratorRegistry::Add< MDMustacheGenerator > MDMustache ( MDMustacheGenerator::Format ,
"Generator for mustache Markdown output."  )
static

Variable Documentation

◆ AllFilesTemplate

std::unique_ptr<MustacheTemplateFile> AllFilesTemplate = nullptr
static

Definition at line 26 of file MDMustacheGenerator.cpp.

Referenced by getMdFiles().

◆ IndexTemplate

std::unique_ptr<MustacheTemplateFile> IndexTemplate = nullptr
static

Definition at line 28 of file MDMustacheGenerator.cpp.

Referenced by getHtmlFiles(), and getMdFiles().

◆ NamespaceTemplate

std::unique_ptr<MustacheTemplateFile> NamespaceTemplate = nullptr
static

Definition at line 24 of file MDMustacheGenerator.cpp.

Referenced by getHtmlFiles(), and getMdFiles().

◆ RecordTemplate

std::unique_ptr<MustacheTemplateFile> RecordTemplate = nullptr
static

Definition at line 22 of file MDMustacheGenerator.cpp.