Skip to content

Driver

class Driver

Driver for running commands

Variables

Name Description
title Title.
description Description.
output Output directory.
defines Defines.
files Lists of files from config.
global Global namespace.

Functions

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

Variable Details

defines

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

Defines.

description

std::string description

Description.

files

std::unordered_set<std::string> files

Lists of files from config.

global

Entity global

Global namespace.

output

std::string output

Output directory.

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.

cover

void cover()

Output line coverage information.

groups

void groups(YAMLNode& parentNode, Entity& parentEntity)

Recursively read groups from the configuration file.

init

void init()

Create a new configuration file.