mrdocs::Config
Configuration used to generate the Corpus and Docs.
Synopsis
Declared in <mrdocs/Config.hpp>
class Config
: public ConfigSchemaDescription
Holds the public options (in their original data types) read from the command line and the YAML file, plus the DOM view of those options that templates consume. It is a plain value: copy or move it freely, and pass it by reference to the steps that need it.
The configuration is connected to the directory of the mrdocs.yml file, from which absolute paths are resolved from relative paths. Reference directories (working directory, mrdocs root) are not stored here; they flow through the workflow as a separate ReferenceDirectories.
Enums
Name |
Description |
Enum for "base‐member‐inheritance" options |
|
Enum for "log‐level" options |
|
Option Type |
|
Enum for "sort‐symbol‐by" options |
Member Functions
Name |
Description |
Full path to the config file directory. |
|
Call |
|
Forward a supplied deprecated option onto its replacement. |
|
Handle a supplied option that the schema marks deprecated. |
|
|
|
Warn about deprecated options that were supplied. |
|
Warn about configuration keys that match no known option. |
Static Member Functions
Name |
Description |
Every option with its command‐line help metadata. |
|
The deprecation note of a deprecated option. |
|
Whether an option is deprecated. |
|
Load the configuration options from a YAML string and command line. |
|
|
|
Data Members
Name |
Description |
Path to the Addons directory |
|
Additional addons layered on top of the base addons |
|
command is required. |
|
Automatically provide missing documentation for special functions and trivial metadata |
|
Automatically detect algorithm function objects |
|
Automatically find non‐member functions |
|
Base URL for links to source code |
|
Clang resource directory |
|
CMake arguments when generating the compilation database from CMakeLists.txt |
|
Directory for the CMake build that generates the compilation database |
|
Configuration or compilation database files |
|
Path to the compilation database |
|
Number of threads to use |
|
Mr.Docs configuration file |
|
Copy local stylesheets when linking |
|
Additional defines passed to the compiler |
|
Output an embeddable document |
|
Treat an empty corpus as an error |
|
Input directories to exclude |
|
Macro patterns to exclude |
|
File patterns to exclude |
|
Symbol patterns to exclude |
|
Extract all symbols |
|
Extract all macros |
|
Extraction policy for anonymous namespaces |
|
Extraction policy for empty namespaces |
|
Deprecated: friends are always extracted |
|
Implicit template specializations used as base classes are extracted as dependencies |
|
Implicit template specializations used as base classes are extracted as dependencies |
|
Extraction policy for records defined locally in source files |
|
Extraction policy for private class members |
|
Extraction policy for private base classes |
|
Extraction policy for private virtual methods of a class |
|
Extraction policy for static members of a file |
|
File patterns to include |
|
Generator(s) used to create the documentation |
|
Per‐generator settings keyed by generator id |
|
Use the global namespace page as an index for all symbols |
|
Whether AST visitation failures should not stop the program |
|
Continue if files are not mapped correctly |
|
Symbols rendered as "implementation‐defined" |
|
Macro patterns to include |
|
Symbol patterns to include |
|
Include paths |
|
Determine how derived classes inherit base members |
|
Determine how derived classes inherit hidden friends of base classes |
|
Input directories to extract symbols from |
|
Use legible names for anchors |
|
Standard Library include paths |
|
Link stylesheets instead of embedding them |
|
The minimum reporting level |
|
Stop after this many documentation errors |
|
Include path prefixes allowed to be missing |
|
Shims for forgiven missing include files |
|
Generate a multipage documentation |
|
Disable the bundled default stylesheet |
|
Include non‐standard attributes in the documentation |
|
Output directory for the generated documentation |
|
Detect and group function overloads |
|
Recursively include files from "input" paths |
|
The minimum reporting level |
|
Exposition only symbols rendered as "see‐below". |
|
Detect and reduce SFINAE expressions |
|
Show enum constant pages in the documentation |
|
Show namespace pages in the documentation |
|
Sort the members of a record |
|
Sort assignment operators first |
|
Determine how members of a record are sorted |
|
Sort conversion operators last |
|
Sort constructors first |
|
Sort destructors first |
|
Sort relational operators last |
|
Determine how members of a namespace are sorted |
|
Path to the root directory of the source code |
|
C++ Standard Library include paths |
|
Directory for linked stylesheets |
|
Ordered list of stylesheets to apply to HTML output |
|
System include paths |
|
Path for the tagfile |
|
Per‐transform parameters keyed by transform id |
|
Use the system C standard library |
|
Use the system C++ standard library |
|
Verbose output |
|
Treat warnings as errors |
|
Warn if a documentation reference is broken |
|
Warn if documentation has errors |
|
Warn if enum values are not documented |
|
Warn if symbols are not documented |
|
Warn if namespaces are not documented |
|
Warn if a documented symbol has no brief |
|
Warn if parameters are not documented |
|
Warn about unrecognized configuration keys |
|
Warn if documented functions have unnamed parameters |
|
Enable warning messages |
Non-Member Functions
Name |
Description |
Discover addon‐defined data‐driven generators and install them. |
Created with MrDocs