mrdocs::Config::seeBelow

Exposition only symbols rendered as "see‐below".

Synopsis

Declared in <mrdocs/Config.hpp>

std::vector<SymbolGlobPattern> seeBelow;

Description

Symbols matching these filters, and symbols in scopes that match, are tagged "see‐below" in the documentation.

Use it for symbols that belong to the project's private API but that users still interact with.

On such a symbol's page the implementation synopsis is rendered as "see‐below" and the members of a scope, such as a namespace or record, are not listed, while the rest of the documentation appears as usual.

See include‐symbols for the pattern syntax.

Created with MrDocs