mrdocs::Config::autoFunctionObjects

Declared in <mrdocs/Config.hpp>

When true, Mr.Docs automatically detects algorithm function objects (informally known as niebloids): variables whose type is a record whose only public non‐special members are operator() overloads.

Set to false to disable auto‐detection and rely solely on the

/

doc command.

The

command is still useful when auto‐detection is enabled, to force treatment of types that fail auto‐detection (e.g.

because they have extra public members); it may be placed on the variable or on the function‐object record.

When a variable is treated as an algorithm function object, its documentation comes from the record's operator() overloads, falling back to the variable's own doc comment when operator() is undocumented; the record's own doc comment is not used.

Created with MrDocs