mrdocs::Config::extractAllMacros

Extract all macros

Synopsis

Declared in <mrdocs/Config.hpp>

bool extractAllMacros = false;

Description

Like extract‐all, but for preprocessor macros.

When false (the default), MrDocs extracts only macros that carry a documentation comment, on the assumption that an undocumented macro is an implementation detail while a documented one is public API meant to be shown.

When true, every macro that passes the macro filters is extracted whether documented or not.

This is independent of extract‐all, which does not apply to macros.

Created with MrDocs