Driver

class Driver

Driver for running commands

Variables

Name	Description
style	Markdown style.
title	Title.
description	Description.
coverage	Coverage file.
output	Output directory.
root	Root entity.
config_file	Configuration file path.
files_patterns	Files patterns.
defines	Macro definitions.
filenames	Files.

Functions

Name	Description
Driver	Constructor.
config	Read in the configuration file.
init	Create a new configuration file.
build	Build documentation.
watch	Watch and build documentation on changes.
cover	Output line coverage information.
clean	Clean documentation.
parse	Parse files.
count	Count line coverage.
groups	Recursively read groups from the configuration file.

Variable Details

config_file

std::filesystem::path config_file

Configuration file path.

coverage

std::filesystem::path coverage

Coverage file.

defines

std::unordered_map<std::string,std::string> defines

Macro definitions.

description

std::string description

Description.

filenames

std::unordered_set<std::filesystem::path> filenames

Files.

files_patterns

std::list<std::string> files_patterns

Files patterns.

output

std::filesystem::path output

Output directory.

root

Entity root

Root entity.

style

std::string style

Markdown style.

title

std::string title

Title.

Function Details

Driver

Driver()

Constructor.

build

void build()

Build documentation.

clean

void clean()

Clean documentation.

config

void config()

Read in the configuration file.

count

void count()

Count line coverage.

cover

void cover()

Output line coverage information.

groups

static void groups(YAMLNode& parentNode, Entity& parentEntity)

Recursively read groups from the configuration file.

init

void init()

Create a new configuration file.

parse

void parse()

Parse files.

watch

void watch()

Watch and build documentation on changes.