mrdocs::Config::maxErrors

Stop after this many documentation errors

Synopsis

Declared in <mrdocs/Config.hpp>

unsigned int maxErrors = 0;

Description

Caps how many documentation errors MrDocs reports, like a compiler's -fmax-errors.

This only takes effect together with warn-as-error: without it, documentation problems are plain warnings and the whole report is always shown.

0 means unlimited (the default).

Once the cap is reached MrDocs stops looking for more problems: it suppresses further diagnostics, prints a short note so you know the report is truncated, and stops dispatching translation units that have not started yet (translation units already in flight finish, so the final count may run a little past the cap).

Use this with warn-as-error and the warn-* family to bring up docs iteratively: keep warn-if-undocumented (and later warn-no-paramdoc, …) on, set max-errors to your fix-loop batch size (for example 40), fix that batch, and repeat.

Full CI validation should leave this at 0.