The Configuration File

generate: (1)
concurrency: (2)
defines: (3)
ignore-failures: (4)
input:
  include: (5)
multipage: (6)
source-root: (7)
filters: (8)
referenced-declarations: (9)
anonymous-namespaces: (10)
inaccessible-members: (11)
inaccessible-bases: (12)

1	Optional `generate` key
2	Optional `concurrency` key
3	Optional `defines` key
4	Optional `ignore-failures` key
5	Optional `include` key
6	Optional `multipage` key
7	Optional `source-root` key
8	Optional `filters` key
9	Optional `referenced-declarations` key
10	Optional `anonymous-namespaces` key
11	Optional `inaccessible-members` key
12	Optional `inaccessible-bases` key

Available configuration keys

Keys Description Required

Keys	Description	Required
concurrency	The generator to use. Supported generators are `adoc`, `html`, and `xml`. Defaults to `adoc`.	No
concurrency	The amount of parallelism desired. 0 to use the hardware-suggested concurrency.	No
defines	Additional preprocessor directives in the form "NAME=VALUE".	No
ignore-failures	Whether to ignore failures during symbol extraction. `true` or `false`.	No
include	The amount of parallelism desired. 0 to use the hardware-suggested concurrency.	No
multipage	Whether to emit the reference as a set of files or just one file. `true` or `false`.	No
source-root	The absolute or relative path to the directory containing the input file hierarchy.	No
filters	Patterns specifying symbols which should be included/excluded. See specifying filters for details.	No
referenced-declarations	When to extract external declarations referenced by symbols. Unconditionally extracted when `always`, never extracted when `never`, and only extracted when used as a base class/deduced local class return type when set to `dependency`.	No
anonymous-namespaces	Whether to extract anonymous namespaces. `always` or `never`.	No
inaccessible-members	Whether to extract private/protected members. `always` or `never`.	No

concurrency

The generator to use. Supported generators are adoc, html, and xml. Defaults to adoc.

concurrency

The amount of parallelism desired. 0 to use the hardware-suggested concurrency.

defines

Additional preprocessor directives in the form "NAME=VALUE".

ignore-failures

Whether to ignore failures during symbol extraction. true or false.

include

The amount of parallelism desired. 0 to use the hardware-suggested concurrency.

multipage

Whether to emit the reference as a set of files or just one file. true or false.

source-root

The absolute or relative path to the directory containing the input file hierarchy.

filters

Patterns specifying symbols which should be included/excluded. See specifying filters for details.

referenced-declarations

When to extract external declarations referenced by symbols. Unconditionally extracted when always, never extracted when never, and only extracted when used as a base class/deduced local class return type when set to dependency.

anonymous-namespaces

Whether to extract anonymous namespaces. always or never.

inaccessible-members

Whether to extract private/protected members. always or never.