mrdocs::Config::includeMacros

Macro patterns to include

Synopsis

Declared in <mrdocs/Config.hpp>

std::vector<SymbolGlobPattern> includeMacros;

Description

If any patterns are defined here, only macros whose name matches one of them (or one of include‐symbols) are extracted.

When empty (the default), every macro is a candidate, so with extract‐all‐macros off the documented macros are shown and can then be narrowed with these patterns.

Macro names are unqualified, so namespace‐scoped include‐symbols patterns never match a macro; use these patterns to scope macros by name (e.g.

MY_LIB_*).

A macro also listed in include‐symbols is still included.

See include‐symbols for the pattern syntax.

Created with MrDocs