mrdocs::Config::compilationDatabase

Path to the compilation database

Synopsis

Declared in <mrdocs/Config.hpp>

std::string compilationDatabase;

Description

The path to a compilation database, or to a build script that generates one.

A compilation database is a JSON file of the compiler commands that build the source; MrDocs reads the compiler flags and source files from it to extract symbols.

You can also pass a build script such as CMakeLists.txt: MrDocs then looks for CMake on PATH or in CMAKE_ROOT, runs the script, and uses the database it produces.

Created with MrDocs