Driver

class Driver

Driver for running commands

Variables

Name	Description
title	Title.
description	Description.
coverage	Coverage file.
output	Output directory.
root	Root entity.
defines	Macro definitions.
filenames	Files.

Functions

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

Variable Details

title

std::string title

Title.

description

std::string description

Description.

coverage

std::filesystem::path coverage

Coverage file.

output

std::filesystem::path output

Output directory.

root

Entity root

Root entity.

defines

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

Macro definitions.

filenames

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

Files.

Function Details

Driver

Driver()

Constructor.

init

void init()

Create a new configuration file.

build

void build()

Build documentation.

cover

void cover()

Output line coverage information.

clean

void clean()

Clean documentation.

config

void config()

Read in the configuration file.

parse

void parse()

Parse files.

count

void count()

Count line coverage.

groups

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

Recursively read groups from the configuration file.