The Hitchhiker Guide to ReqTrace

This file gives a guided tour through the code, as suggested here

Version

Last updated for v0.1.1

controller::Controller::run(): This function executes each job that was requested by the command line or configured as default job
Parsers turn one or more files into a list of requirements
common::artefact: Holds one element in the tracing graph, like a document, a group of source files. Parses those files on demand using a parser of the right format. After parsing, holds all the requirements of the artefact
graph::Graph: Holds all the artefacts, and knows which covers which
trace::Tracing: Walks a Graph, collecting all the successful and failed traces from one artefact to another
Formatters turn requirements, errors and tracings into (machine-) readable output