xref: /netbsd-src/external/gpl3/gcc/dist/libstdc++-v3/doc/doxygen/user.cfg.in (revision 0a3071956a3a9fdebdbf7f338cf2d439b45fc728)
1# Doxyfile 1.8.20
2
3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project.
5#
6# All text after a double hash (##) is considered a comment and is placed in
7# front of the TAG it is preceding.
8#
9# All text after a single hash (#) is considered a comment and will be ignored.
10# The format is:
11# TAG = value [value, ...]
12# For lists, items can also be appended using:
13# TAG += value [value, ...]
14# Values that contain spaces should be placed between quotes (\" \").
15
16#---------------------------------------------------------------------------
17# Project related configuration options
18#---------------------------------------------------------------------------
19
20# This tag specifies the encoding used for all characters in the configuration
21# file that follow. The default is UTF-8 which is also the encoding used for all
22# text before the first occurrence of this tag. Doxygen uses libiconv (or the
23# iconv built into libc) for the transcoding. See
24# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
25# The default value is: UTF-8.
26
27DOXYFILE_ENCODING      = UTF-8
28
29# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30# double-quotes, unless you are using Doxywizard) that should identify the
31# project for which the documentation is generated. This name is used in the
32# title of most generated pages and in a few other places.
33# The default value is: My Project.
34
35PROJECT_NAME           = libstdc++
36
37# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38# could be handy for archiving the generated documentation or if some version
39# control system is used.
40
41PROJECT_NUMBER         =
42
43# Using the PROJECT_BRIEF tag one can provide an optional one line description
44# for a project that appears at the top of each page and should give viewer a
45# quick idea about the purpose of the project. Keep the description short.
46
47PROJECT_BRIEF          =
48
49# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
50# in the documentation. The maximum height of the logo should not exceed 55
51# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
52# the logo to the output directory.
53
54PROJECT_LOGO           =
55
56# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57# into which the generated documentation will be written. If a relative path is
58# entered, it will be relative to the location where doxygen was started. If
59# left blank the current directory will be used.
60
61OUTPUT_DIRECTORY       = @outdir@
62
63# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
64# directories (in 2 levels) under the output directory of each output format and
65# will distribute the generated files over these directories. Enabling this
66# option can be useful when feeding doxygen a huge amount of source files, where
67# putting all generated files in the same directory would otherwise causes
68# performance problems for the file system.
69# The default value is: NO.
70
71CREATE_SUBDIRS         = NO
72
73# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74# characters to appear in the names of generated files. If set to NO, non-ASCII
75# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
76# U+3044.
77# The default value is: NO.
78
79ALLOW_UNICODE_NAMES    = NO
80
81# The OUTPUT_LANGUAGE tag is used to specify the language in which all
82# documentation generated by doxygen is written. Doxygen will use this
83# information to generate all constant output in the proper language.
84# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
85# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
86# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
87# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
88# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
89# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
90# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
91# Ukrainian and Vietnamese.
92# The default value is: English.
93
94OUTPUT_LANGUAGE        = English
95
96# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
97# descriptions after the members that are listed in the file and class
98# documentation (similar to Javadoc). Set to NO to disable this.
99# The default value is: YES.
100
101BRIEF_MEMBER_DESC      = @do_man@
102
103# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
104# description of a member or function before the detailed description
105#
106# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
107# brief descriptions will be completely suppressed.
108# The default value is: YES.
109
110REPEAT_BRIEF           = YES
111
112# This tag implements a quasi-intelligent brief description abbreviator that is
113# used to form the text in various listings. Each string in this list, if found
114# as the leading text of the brief description, will be stripped from the text
115# and the result, after processing the whole list, is used as the annotated
116# text. Otherwise, the brief description is used as-is. If left blank, the
117# following values are used ($name is automatically replaced with the name of
118# the entity):The $name class, The $name widget, The $name file, is, provides,
119# specifies, contains, represents, a, an and the.
120
121ABBREVIATE_BRIEF       =
122
123# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
124# doxygen will generate a detailed section even if there is only a brief
125# description.
126# The default value is: NO.
127
128ALWAYS_DETAILED_SEC    = YES
129
130# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
131# inherited members of a class in the documentation of that class as if those
132# members were ordinary class members. Constructors, destructors and assignment
133# operators of the base classes will not be shown.
134# The default value is: NO.
135
136INLINE_INHERITED_MEMB  = YES
137
138# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
139# before files name in the file list and in the header files. If set to NO the
140# shortest path that makes the file name unique will be used
141# The default value is: YES.
142
143FULL_PATH_NAMES        = NO
144
145# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
146# Stripping is only done if one of the specified strings matches the left-hand
147# part of the path. The tag can be used to show relative paths in the file list.
148# If left blank the directory from which doxygen is run is used as the path to
149# strip.
150#
151# Note that you can specify absolute paths here, but also relative paths, which
152# will be relative from the directory where doxygen is started.
153# This tag requires that the tag FULL_PATH_NAMES is set to YES.
154
155STRIP_FROM_PATH        = @srcdir@/doc/ @srcdir@/libsupc++/ include/
156
157# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
158# path mentioned in the documentation of a class, which tells the reader which
159# header file to include in order to use a class. If left blank only the name of
160# the header file containing the class definition is used. Otherwise one should
161# specify the list of include paths that are normally passed to the compiler
162# using the -I flag.
163
164STRIP_FROM_INC_PATH    =
165
166# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
167# less readable) file names. This can be useful is your file systems doesn't
168# support long names like on DOS, Mac, or CD-ROM.
169# The default value is: NO.
170
171SHORT_NAMES            = @shortname@
172
173# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
174# first line (until the first dot) of a Javadoc-style comment as the brief
175# description. If set to NO, the Javadoc-style will behave just like regular Qt-
176# style comments (thus requiring an explicit @brief command for a brief
177# description.)
178# The default value is: NO.
179
180JAVADOC_AUTOBRIEF      = NO
181
182# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
183# such as
184# /***************
185# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
186# Javadoc-style will behave just like regular comments and it will not be
187# interpreted by doxygen.
188# The default value is: NO.
189
190JAVADOC_BANNER         = NO
191
192# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
193# line (until the first dot) of a Qt-style comment as the brief description. If
194# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
195# requiring an explicit \brief command for a brief description.)
196# The default value is: NO.
197
198QT_AUTOBRIEF           = NO
199
200# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
201# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
202# a brief description. This used to be the default behavior. The new default is
203# to treat a multi-line C++ comment block as a detailed description. Set this
204# tag to YES if you prefer the old behavior instead.
205#
206# Note that setting this tag to YES also means that rational rose comments are
207# not recognized any more.
208# The default value is: NO.
209
210MULTILINE_CPP_IS_BRIEF = YES
211
212# By default Python docstrings are displayed as preformatted text and doxygen's
213# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
214# doxygen's special commands can be used and the contents of the docstring
215# documentation blocks is shown as doxygen documentation.
216# The default value is: YES.
217
218PYTHON_DOCSTRING       = YES
219
220# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
221# documentation from any documented member that it re-implements.
222# The default value is: YES.
223
224INHERIT_DOCS           = YES
225
226# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
227# page for each member. If set to NO, the documentation of a member will be part
228# of the file/class/namespace that contains it.
229# The default value is: NO.
230
231SEPARATE_MEMBER_PAGES  = NO
232
233# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
234# uses this value to replace tabs by spaces in code fragments.
235# Minimum value: 1, maximum value: 16, default value: 4.
236
237TAB_SIZE               = 8
238
239# This tag can be used to specify a number of aliases that act as commands in
240# the documentation. An alias has the form:
241# name=value
242# For example adding
243# "sideeffect=@par Side Effects:\n"
244# will allow you to put the command \sideeffect (or @sideeffect) in the
245# documentation, which will result in a user-defined paragraph with heading
246# "Side Effects:". You can put \n's in the value part of an alias to insert
247# newlines (in the resulting output). You can put ^^ in the value part of an
248# alias to insert a newline as if a physical newline was in the original file.
249# When you need a literal { or } or , in the value part of an alias you have to
250# escape them by means of a backslash (\), this can lead to conflicts with the
251# commands \{ and \} for these it is advised to use the version @{ and @} or use
252# a double escape (\\{ and \\})
253
254ALIASES                = "doctodo=@todo Needs documentation! See http://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_style.html" \
255                         "headername{1}=Instead, include \<\1\>." \
256                         "headername{2}=Instead, include \<\1\> or \<\2\>."
257
258# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
259# only. Doxygen will then generate output that is more tailored for C. For
260# instance, some of the names that are used will be different. The list of all
261# members will be omitted, etc.
262# The default value is: NO.
263
264OPTIMIZE_OUTPUT_FOR_C  = NO
265
266# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
267# Python sources only. Doxygen will then generate output that is more tailored
268# for that language. For instance, namespaces will be presented as packages,
269# qualified scopes will look different, etc.
270# The default value is: NO.
271
272OPTIMIZE_OUTPUT_JAVA   = NO
273
274# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
275# sources. Doxygen will then generate output that is tailored for Fortran.
276# The default value is: NO.
277
278OPTIMIZE_FOR_FORTRAN   = NO
279
280# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
281# sources. Doxygen will then generate output that is tailored for VHDL.
282# The default value is: NO.
283
284OPTIMIZE_OUTPUT_VHDL   = NO
285
286# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
287# sources only. Doxygen will then generate output that is more tailored for that
288# language. For instance, namespaces will be presented as modules, types will be
289# separated into more groups, etc.
290# The default value is: NO.
291
292OPTIMIZE_OUTPUT_SLICE  = NO
293
294# Doxygen selects the parser to use depending on the extension of the files it
295# parses. With this tag you can assign which parser to use for a given
296# extension. Doxygen has a built-in mapping, but you can override or extend it
297# using this tag. The format is ext=language, where ext is a file extension, and
298# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
299# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL,
300# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
301# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
302# tries to guess whether the code is fixed or free formatted code, this is the
303# default for Fortran type files). For instance to make doxygen treat .inc files
304# as Fortran files (default is PHP), and .f files as C (default is Fortran),
305# use: inc=Fortran f=C.
306#
307# Note: For files without extension you can use no_extension as a placeholder.
308#
309# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
310# the files are not read by doxygen.
311
312EXTENSION_MAPPING      = no_extension=C++ \
313                         .h=C++ \
314                         .tcc=C++ \
315                         .hpp=C++
316
317# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
318# according to the Markdown format, which allows for more readable
319# documentation. See https://daringfireball.net/projects/markdown/ for details.
320# The output of markdown processing is further processed by doxygen, so you can
321# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
322# case of backward compatibilities issues.
323# The default value is: YES.
324
325MARKDOWN_SUPPORT       = YES
326
327# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
328# to that level are automatically included in the table of contents, even if
329# they do not have an id attribute.
330# Note: This feature currently applies only to Markdown headings.
331# Minimum value: 0, maximum value: 99, default value: 5.
332# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
333
334TOC_INCLUDE_HEADINGS   = 0
335
336# When enabled doxygen tries to link words that correspond to documented
337# classes, or namespaces to their corresponding documentation. Such a link can
338# be prevented in individual cases by putting a % sign in front of the word or
339# globally by setting AUTOLINK_SUPPORT to NO.
340# The default value is: YES.
341
342AUTOLINK_SUPPORT       = NO
343
344# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
345# to include (a tag file for) the STL sources as input, then you should set this
346# tag to YES in order to let doxygen match functions declarations and
347# definitions whose arguments contain STL classes (e.g. func(std::string);
348# versus func(std::string) {}). This also make the inheritance and collaboration
349# diagrams that involve STL classes more complete and accurate.
350# The default value is: NO.
351
352BUILTIN_STL_SUPPORT    = NO
353
354# If you use Microsoft's C++/CLI language, you should set this option to YES to
355# enable parsing support.
356# The default value is: NO.
357
358CPP_CLI_SUPPORT        = NO
359
360# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
361# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
362# will parse them like normal C++ but will assume all classes use public instead
363# of private inheritance when no explicit protection keyword is present.
364# The default value is: NO.
365
366SIP_SUPPORT            = NO
367
368# For Microsoft's IDL there are propget and propput attributes to indicate
369# getter and setter methods for a property. Setting this option to YES will make
370# doxygen to replace the get and set methods by a property in the documentation.
371# This will only work if the methods are indeed getting or setting a simple
372# type. If this is not the case, or you want to show the methods anyway, you
373# should set this option to NO.
374# The default value is: YES.
375
376IDL_PROPERTY_SUPPORT   = NO
377
378# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
379# tag is set to YES then doxygen will reuse the documentation of the first
380# member in the group (if any) for the other members of the group. By default
381# all members of a group must be documented explicitly.
382# The default value is: NO.
383
384DISTRIBUTE_GROUP_DOC   = YES
385
386# If one adds a struct or class to a group and this option is enabled, then also
387# any nested class or struct is added to the same group. By default this option
388# is disabled and one has to add nested compounds explicitly via \ingroup.
389# The default value is: NO.
390
391GROUP_NESTED_COMPOUNDS = NO
392
393# Set the SUBGROUPING tag to YES to allow class member groups of the same type
394# (for instance a group of public functions) to be put as a subgroup of that
395# type (e.g. under the Public Functions section). Set it to NO to prevent
396# subgrouping. Alternatively, this can be done per class using the
397# \nosubgrouping command.
398# The default value is: YES.
399
400SUBGROUPING            = YES
401
402# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
403# are shown inside the group in which they are included (e.g. using \ingroup)
404# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
405# and RTF).
406#
407# Note that this feature does not work in combination with
408# SEPARATE_MEMBER_PAGES.
409# The default value is: NO.
410
411INLINE_GROUPED_CLASSES = NO
412
413# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
414# with only public data fields or simple typedef fields will be shown inline in
415# the documentation of the scope in which they are defined (i.e. file,
416# namespace, or group documentation), provided this scope is documented. If set
417# to NO, structs, classes, and unions are shown on a separate page (for HTML and
418# Man pages) or section (for LaTeX and RTF).
419# The default value is: NO.
420
421INLINE_SIMPLE_STRUCTS  = NO
422
423# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
424# enum is documented as struct, union, or enum with the name of the typedef. So
425# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
426# with name TypeT. When disabled the typedef will appear as a member of a file,
427# namespace, or class. And the struct will be named TypeS. This can typically be
428# useful for C code in case the coding convention dictates that all compound
429# types are typedef'ed and only the typedef is referenced, never the tag name.
430# The default value is: NO.
431
432TYPEDEF_HIDES_STRUCT   = NO
433
434# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
435# cache is used to resolve symbols given their name and scope. Since this can be
436# an expensive process and often the same symbol appears multiple times in the
437# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
438# doxygen will become slower. If the cache is too large, memory is wasted. The
439# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
440# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
441# symbols. At the end of a run doxygen will report the cache usage and suggest
442# the optimal cache size from a speed point of view.
443# Minimum value: 0, maximum value: 9, default value: 0.
444
445LOOKUP_CACHE_SIZE      = 0
446
447# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use
448# during processing. When set to 0 doxygen will based this on the number of
449# cores available in the system. You can set it explicitly to a value larger
450# than 0 to get more control over the balance between CPU load and processing
451# speed. At this moment only the input processing can be done using multiple
452# threads. Since this is still an experimental feature the default is set to 1,
453# which efficively disables parallel processing. Please report any issues you
454# encounter. Generating dot graphs in parallel is controlled by the
455# DOT_NUM_THREADS setting.
456# Minimum value: 0, maximum value: 32, default value: 1.
457
458NUM_PROC_THREADS       = 1
459
460#---------------------------------------------------------------------------
461# Build related configuration options
462#---------------------------------------------------------------------------
463
464# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
465# documentation are documented, even if no documentation was available. Private
466# class members and static file members will be hidden unless the
467# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
468# Note: This will also disable the warnings about undocumented members that are
469# normally produced when WARNINGS is set to YES.
470# The default value is: NO.
471
472EXTRACT_ALL            = NO
473
474# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
475# be included in the documentation.
476# The default value is: NO.
477
478EXTRACT_PRIVATE        = NO
479
480# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
481# methods of a class will be included in the documentation.
482# The default value is: NO.
483
484EXTRACT_PRIV_VIRTUAL   = NO
485
486# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
487# scope will be included in the documentation.
488# The default value is: NO.
489
490EXTRACT_PACKAGE        = NO
491
492# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
493# included in the documentation.
494# The default value is: NO.
495
496EXTRACT_STATIC         = YES
497
498# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
499# locally in source files will be included in the documentation. If set to NO,
500# only classes defined in header files are included. Does not have any effect
501# for Java sources.
502# The default value is: YES.
503
504EXTRACT_LOCAL_CLASSES  = YES
505
506# This flag is only useful for Objective-C code. If set to YES, local methods,
507# which are defined in the implementation section but not in the interface are
508# included in the documentation. If set to NO, only methods in the interface are
509# included.
510# The default value is: NO.
511
512EXTRACT_LOCAL_METHODS  = YES
513
514# If this flag is set to YES, the members of anonymous namespaces will be
515# extracted and appear in the documentation as a namespace called
516# 'anonymous_namespace{file}', where file will be replaced with the base name of
517# the file that contains the anonymous namespace. By default anonymous namespace
518# are hidden.
519# The default value is: NO.
520
521EXTRACT_ANON_NSPACES   = NO
522
523# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
524# undocumented members inside documented classes or files. If set to NO these
525# members will be included in the various overviews, but no documentation
526# section is generated. This option has no effect if EXTRACT_ALL is enabled.
527# The default value is: NO.
528
529HIDE_UNDOC_MEMBERS     = NO
530
531# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
532# undocumented classes that are normally visible in the class hierarchy. If set
533# to NO, these classes will be included in the various overviews. This option
534# has no effect if EXTRACT_ALL is enabled.
535# The default value is: NO.
536
537HIDE_UNDOC_CLASSES     = YES
538
539# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
540# declarations. If set to NO, these declarations will be included in the
541# documentation.
542# The default value is: NO.
543
544HIDE_FRIEND_COMPOUNDS  = NO
545
546# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
547# documentation blocks found inside the body of a function. If set to NO, these
548# blocks will be appended to the function's detailed documentation block.
549# The default value is: NO.
550
551HIDE_IN_BODY_DOCS      = NO
552
553# The INTERNAL_DOCS tag determines if documentation that is typed after a
554# \internal command is included. If the tag is set to NO then the documentation
555# will be excluded. Set it to YES to include the internal documentation.
556# The default value is: NO.
557
558INTERNAL_DOCS          = NO
559
560# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
561# names in lower-case letters. If set to YES, upper-case letters are also
562# allowed. This is useful if you have classes or files whose names only differ
563# in case and if your file system supports case sensitive file names. Windows
564# (including Cygwin) and Mac users are advised to set this option to NO.
565# The default value is: system dependent.
566
567CASE_SENSE_NAMES       = NO
568
569# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
570# their full class and namespace scopes in the documentation. If set to YES, the
571# scope will be hidden.
572# The default value is: NO.
573
574HIDE_SCOPE_NAMES       = NO
575
576# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
577# append additional text to a page's title, such as Class Reference. If set to
578# YES the compound reference will be hidden.
579# The default value is: NO.
580
581HIDE_COMPOUND_REFERENCE= NO
582
583# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
584# will show which file needs to be included to use the class.
585# The default value is: YES.
586
587SHOW_HEADERFILE        = YES
588
589# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
590# the files that are included by a file in the documentation of that file.
591# The default value is: YES.
592
593SHOW_INCLUDE_FILES     = NO
594
595# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
596# grouped member an include statement to the documentation, telling the reader
597# which file to include in order to use the member.
598# The default value is: NO.
599
600SHOW_GROUPED_MEMB_INC  = NO
601
602# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
603# files with double quotes in the documentation rather than with sharp brackets.
604# The default value is: NO.
605
606FORCE_LOCAL_INCLUDES   = NO
607
608# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
609# documentation for inline members.
610# The default value is: YES.
611
612INLINE_INFO            = YES
613
614# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
615# (detailed) documentation of file and class members alphabetically by member
616# name. If set to NO, the members will appear in declaration order.
617# The default value is: YES.
618
619SORT_MEMBER_DOCS       = YES
620
621# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
622# descriptions of file, namespace and class members alphabetically by member
623# name. If set to NO, the members will appear in declaration order. Note that
624# this will also influence the order of the classes in the class list.
625# The default value is: NO.
626
627SORT_BRIEF_DOCS        = YES
628
629# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
630# (brief and detailed) documentation of class members so that constructors and
631# destructors are listed first. If set to NO the constructors will appear in the
632# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
633# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
634# member documentation.
635# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
636# detailed member documentation.
637# The default value is: NO.
638
639SORT_MEMBERS_CTORS_1ST = YES
640
641# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
642# of group names into alphabetical order. If set to NO the group names will
643# appear in their defined order.
644# The default value is: NO.
645
646SORT_GROUP_NAMES       = YES
647
648# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
649# fully-qualified names, including namespaces. If set to NO, the class list will
650# be sorted only by class name, not including the namespace part.
651# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
652# Note: This option applies only to the class list, not to the alphabetical
653# list.
654# The default value is: NO.
655
656SORT_BY_SCOPE_NAME     = NO
657
658# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
659# type resolution of all parameters of a function it will reject a match between
660# the prototype and the implementation of a member function even if there is
661# only one candidate or it is obvious which candidate to choose by doing a
662# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
663# accept a match between prototype and implementation in such cases.
664# The default value is: NO.
665
666STRICT_PROTO_MATCHING  = NO
667
668# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
669# list. This list is created by putting \todo commands in the documentation.
670# The default value is: YES.
671
672GENERATE_TODOLIST      = YES
673
674# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
675# list. This list is created by putting \test commands in the documentation.
676# The default value is: YES.
677
678GENERATE_TESTLIST      = NO
679
680# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
681# list. This list is created by putting \bug commands in the documentation.
682# The default value is: YES.
683
684GENERATE_BUGLIST       = YES
685
686# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
687# the deprecated list. This list is created by putting \deprecated commands in
688# the documentation.
689# The default value is: YES.
690
691GENERATE_DEPRECATEDLIST= YES
692
693# The ENABLED_SECTIONS tag can be used to enable conditional documentation
694# sections, marked by \if <section_label> ... \endif and \cond <section_label>
695# ... \endcond blocks.
696
697ENABLED_SECTIONS       = @enabled_sections@
698
699# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
700# initial value of a variable or macro / define can have for it to appear in the
701# documentation. If the initializer consists of more lines than specified here
702# it will be hidden. Use a value of 0 to hide initializers completely. The
703# appearance of the value of individual variables and macros / defines can be
704# controlled using \showinitializer or \hideinitializer command in the
705# documentation regardless of this setting.
706# Minimum value: 0, maximum value: 10000, default value: 30.
707
708MAX_INITIALIZER_LINES  = 0
709
710# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
711# the bottom of the documentation of classes and structs. If set to YES, the
712# list will mention the files that were used to generate the documentation.
713# The default value is: YES.
714
715SHOW_USED_FILES        = YES
716
717# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
718# will remove the Files entry from the Quick Index and from the Folder Tree View
719# (if specified).
720# The default value is: YES.
721
722SHOW_FILES             = YES
723
724# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
725# page. This will remove the Namespaces entry from the Quick Index and from the
726# Folder Tree View (if specified).
727# The default value is: YES.
728
729SHOW_NAMESPACES        = YES
730
731# The FILE_VERSION_FILTER tag can be used to specify a program or script that
732# doxygen should invoke to get the current version for each file (typically from
733# the version control system). Doxygen will invoke the program by executing (via
734# popen()) the command command input-file, where command is the value of the
735# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
736# by doxygen. Whatever the program writes to standard output is used as the file
737# version. For an example see the documentation.
738
739FILE_VERSION_FILTER    =
740
741# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
742# by doxygen. The layout file controls the global structure of the generated
743# output files in an output format independent way. To create the layout file
744# that represents doxygen's defaults, run doxygen with the -l option. You can
745# optionally specify a file name after the option, if omitted DoxygenLayout.xml
746# will be used as the name of the layout file.
747#
748# Note that if you run doxygen from a directory containing a file called
749# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
750# tag is left empty.
751
752LAYOUT_FILE            =
753
754# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
755# the reference definitions. This must be a list of .bib files. The .bib
756# extension is automatically appended if omitted. This requires the bibtex tool
757# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
758# For LaTeX the style of the bibliography can be controlled using
759# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
760# search path. See also \cite for info how to create references.
761
762CITE_BIB_FILES         =
763
764#---------------------------------------------------------------------------
765# Configuration options related to warning and progress messages
766#---------------------------------------------------------------------------
767
768# The QUIET tag can be used to turn on/off the messages that are generated to
769# standard output by doxygen. If QUIET is set to YES this implies that the
770# messages are off.
771# The default value is: NO.
772
773QUIET                  = YES
774
775# The WARNINGS tag can be used to turn on/off the warning messages that are
776# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
777# this implies that the warnings are on.
778#
779# Tip: Turn warnings on while writing the documentation.
780# The default value is: YES.
781
782WARNINGS               = YES
783
784# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
785# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
786# will automatically be disabled.
787# The default value is: YES.
788
789WARN_IF_UNDOCUMENTED   = NO
790
791# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
792# potential errors in the documentation, such as not documenting some parameters
793# in a documented function, or documenting parameters that don't exist or using
794# markup commands wrongly.
795# The default value is: YES.
796
797WARN_IF_DOC_ERROR      = YES
798
799# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
800# are documented, but have no documentation for their parameters or return
801# value. If set to NO, doxygen will only warn about wrong or incomplete
802# parameter documentation, but not about the absence of documentation. If
803# EXTRACT_ALL is set to YES then this flag will automatically be disabled.
804# The default value is: NO.
805
806WARN_NO_PARAMDOC       = NO
807
808# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
809# a warning is encountered.
810# The default value is: NO.
811
812WARN_AS_ERROR          = NO
813
814# The WARN_FORMAT tag determines the format of the warning messages that doxygen
815# can produce. The string should contain the $file, $line, and $text tags, which
816# will be replaced by the file and line number from which the warning originated
817# and the warning text. Optionally the format may contain $version, which will
818# be replaced by the version of the file (if it could be obtained via
819# FILE_VERSION_FILTER)
820# The default value is: $file:$line: $text.
821
822WARN_FORMAT            = "$file:$line: $text  "
823
824# The WARN_LOGFILE tag can be used to specify a file to which warning and error
825# messages should be written. If left blank the output is written to standard
826# error (stderr).
827
828WARN_LOGFILE           =
829
830#---------------------------------------------------------------------------
831# Configuration options related to the input files
832#---------------------------------------------------------------------------
833
834# The INPUT tag is used to specify the files and/or directories that contain
835# documented source files. You may enter file names like myfile.cpp or
836# directories like /usr/src/myproject. Separate the files or directories with
837# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
838# Note: If this tag is empty the current directory is searched.
839
840# N.B. update STRIP_FROM_PATH to sanitize paths outside the build tree.
841INPUT                  = @srcdir@/doc/doxygen/doxygroups.cc \
842                         @srcdir@/libsupc++/compare \
843                         @srcdir@/libsupc++/cxxabi.h \
844                         @srcdir@/libsupc++/exception \
845                         @srcdir@/libsupc++/initializer_list \
846                         @srcdir@/libsupc++/new \
847                         @srcdir@/libsupc++/typeinfo \
848                         include/algorithm \
849                         include/any \
850                         include/array \
851                         include/atomic \
852                         include/barrier \
853                         include/bit \
854                         include/bitset \
855                         include/charconv \
856                         include/chrono \
857                         include/codecvt \
858                         include/complex \
859                         include/concepts \
860                         include/condition_variable \
861                         include/deque \
862                         include/expected \
863                         include/filesystem \
864                         include/forward_list \
865                         include/fstream \
866                         include/functional \
867                         include/future \
868                         include/iomanip \
869                         include/ios \
870                         include/iosfwd \
871                         include/iostream \
872                         include/istream \
873                         include/iterator \
874                         include/latch \
875                         include/limits \
876                         include/list \
877                         include/locale \
878                         include/map \
879                         include/memory \
880                         include/memory_resource \
881                         include/mutex \
882                         include/numeric \
883                         include/numbers \
884                         include/optional \
885                         include/ostream \
886                         include/queue \
887                         include/random \
888                         include/ranges \
889                         include/ratio \
890                         include/regex \
891                         include/scoped_allocator \
892                         include/semaphore \
893                         include/set \
894                         include/shared_mutex \
895                         include/source_location \
896                         include/span \
897                         include/sstream \
898                         include/stack \
899                         include/stdexcept \
900                         include/stop_token \
901                         include/streambuf \
902                         include/string \
903                         include/string_view \
904                         include/syncstream \
905                         include/system_error \
906                         include/thread \
907                         include/tuple \
908                         include/typeindex \
909                         include/type_traits \
910                         include/unordered_map \
911                         include/unordered_set \
912                         include/utility \
913                         include/valarray \
914                         include/variant \
915                         include/vector \
916                         include/cassert \
917                         include/ccomplex \
918                         include/cctype \
919                         include/cerrno \
920                         include/cfenv \
921                         include/cfloat \
922                         include/cinttypes \
923                         include/ciso646 \
924                         include/climits \
925                         include/clocale \
926                         include/cmath \
927                         include/csetjmp \
928                         include/csignal \
929                         include/cstdalign \
930                         include/cstdarg \
931                         include/cstdbool \
932                         include/cstddef \
933                         include/cstdint \
934                         include/cstdio \
935                         include/cstdlib \
936                         include/cstring \
937                         include/ctgmath \
938                         include/ctime \
939                         include/cwchar \
940                         include/cuchar \
941                         include/cwctype \
942                         include/ \
943                         include/bits \
944                         include/@host_alias@/bits \
945                         include/backward \
946                         include/backward/hash_map \
947                         include/backward/hash_set \
948                         include/backward/strstream \
949                         include/debug \
950                         include/debug/bitset \
951                         include/debug/deque \
952                         include/debug/forward_list \
953                         include/debug/list \
954                         include/debug/map \
955                         include/debug/set \
956                         include/debug/string \
957                         include/debug/unordered_map \
958                         include/debug/unordered_set \
959                         include/debug/vector \
960                         include/ext/algorithm \
961                         include/ext/cmath \
962                         include/ext/functional \
963                         include/ext/iterator \
964                         include/ext/memory \
965                         include/ext/numeric \
966                         include/ext/rb_tree \
967                         include/ext/rope \
968                         include/ext/slist \
969                         include/parallel \
970                         include/parallel/algorithm \
971                         include/parallel/numeric \
972                         include/tr1/ccomplex \
973                         include/tr1/cctype \
974                         include/tr1/cfenv \
975                         include/tr1/cfloat \
976                         include/tr1/cinttypes \
977                         include/tr1/climits \
978                         include/tr1/cmath \
979                         include/tr1/complex \
980                         include/tr1/cstdarg \
981                         include/tr1/cstdbool \
982                         include/tr1/cstdint \
983                         include/tr1/cstdio \
984                         include/tr1/cstdlib \
985                         include/tr1/ctgmath \
986                         include/tr1/ctime \
987                         include/tr1/cwchar \
988                         include/tr1/cwctype \
989                         include/tr2/ \
990                         include/tr2/bool_set \
991                         include/tr2/dynamic_bitset \
992                         include/tr2/ratio \
993                         include/tr2/type_traits \
994                         include/decimal/decimal \
995                         include/experimental/bits \
996                         include/experimental/algorithm \
997                         include/experimental/any \
998                         include/experimental/array \
999                         include/experimental/chrono \
1000                         include/experimental/deque \
1001                         include/experimental/filesystem \
1002                         include/experimental/forward_list \
1003                         include/experimental/functional \
1004                         include/experimental/iterator \
1005                         include/experimental/list \
1006                         include/experimental/map \
1007                         include/experimental/memory \
1008                         include/experimental/memory_resource \
1009                         include/experimental/numeric \
1010                         include/experimental/optional \
1011                         include/experimental/propagate_const \
1012                         include/experimental/random \
1013                         include/experimental/ratio \
1014                         include/experimental/regex \
1015                         include/experimental/set \
1016                         include/experimental/simd \
1017                         include/experimental/string \
1018                         include/experimental/string_view \
1019                         include/experimental/system_error \
1020                         include/experimental/tuple \
1021                         include/experimental/type_traits \
1022                         include/experimental/unordered_map \
1023                         include/experimental/unordered_set \
1024                         include/experimental/utility \
1025                         include/experimental/vector \
1026                         include/ext \
1027                         include/ext/pb_ds \
1028                         include/ext/pb_ds/detail \
1029                         include/ext/pb_ds/detail/binary_heap_ \
1030                         include/ext/pb_ds/detail/binomial_heap_ \
1031                         include/ext/pb_ds/detail/binomial_heap_base_ \
1032                         include/ext/pb_ds/detail/bin_search_tree_ \
1033                         include/ext/pb_ds/detail/branch_policy \
1034                         include/ext/pb_ds/detail/cc_hash_table_map_ \
1035                         include/ext/pb_ds/detail/eq_fn \
1036                         include/ext/pb_ds/detail/gp_hash_table_map_ \
1037                         include/ext/pb_ds/detail/hash_fn \
1038                         include/ext/pb_ds/detail/left_child_next_sibling_heap_ \
1039                         include/ext/pb_ds/detail/list_update_map_ \
1040                         include/ext/pb_ds/detail/list_update_policy \
1041                         include/ext/pb_ds/detail/ov_tree_map_ \
1042                         include/ext/pb_ds/detail/pairing_heap_ \
1043                         include/ext/pb_ds/detail/pat_trie_ \
1044                         include/ext/pb_ds/detail/rb_tree_map_ \
1045                         include/ext/pb_ds/detail/rc_binomial_heap_ \
1046                         include/ext/pb_ds/detail/resize_policy \
1047                         include/ext/pb_ds/detail/splay_tree_ \
1048                         include/ext/pb_ds/detail/thin_heap_ \
1049                         include/ext/pb_ds/detail/tree_policy \
1050                         include/ext/pb_ds/detail/trie_policy \
1051                         include/ext/pb_ds/detail/unordered_iterator
1052
1053# This tag can be used to specify the character encoding of the source files
1054# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
1055# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
1056# documentation (see: https://www.gnu.org/software/libiconv/) for the list of
1057# possible encodings.
1058# The default value is: UTF-8.
1059
1060INPUT_ENCODING         = UTF-8
1061
1062# If the value of the INPUT tag contains directories, you can use the
1063# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
1064# *.h) to filter out the source-files in the directories.
1065#
1066# Note that for custom extensions or not directly supported extensions you also
1067# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1068# read by doxygen.
1069#
1070# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
1071# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
1072# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
1073# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
1074# *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen
1075# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
1076# *.vhdl, *.ucf, *.qsf and *.ice.
1077
1078FILE_PATTERNS          = *.h \
1079                         *.hpp \
1080                         *.tcc
1081
1082# The RECURSIVE tag can be used to specify whether or not subdirectories should
1083# be searched for input files as well.
1084# The default value is: NO.
1085
1086RECURSIVE              = NO
1087
1088# The EXCLUDE tag can be used to specify files and/or directories that should be
1089# excluded from the INPUT source files. This way you can easily exclude a
1090# subdirectory from a directory tree whose root is specified with the INPUT tag.
1091#
1092# Note that relative paths are relative to the directory from which doxygen is
1093# run.
1094
1095EXCLUDE                = Makefile \
1096                         include/experimental/bits/net.h
1097
1098# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
1099# directories that are symbolic links (a Unix file system feature) are excluded
1100# from the input.
1101# The default value is: NO.
1102
1103EXCLUDE_SYMLINKS       = NO
1104
1105# If the value of the INPUT tag contains directories, you can use the
1106# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
1107# certain files from those directories.
1108#
1109# Note that the wildcards are matched against the file with absolute path, so to
1110# exclude all test directories for example use the pattern */test/*
1111
1112EXCLUDE_PATTERNS       = stamp-* \
1113                         doxygroups.cc \
1114                         *.gch \
1115                         */.svn/*
1116
1117# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
1118# (namespaces, classes, functions, etc.) that should be excluded from the
1119# output. The symbol name can be a fully qualified name, a word, or if the
1120# wildcard * is used, a substring. Examples: ANamespace, AClass,
1121# AClass::ANamespace, ANamespace::*Test
1122#
1123# Note that the wildcards are matched against the file with absolute path, so to
1124# exclude all test directories use the pattern */test/*
1125
1126EXCLUDE_SYMBOLS        =
1127
1128# The EXAMPLE_PATH tag can be used to specify one or more files or directories
1129# that contain example code fragments that are included (see the \include
1130# command).
1131
1132EXAMPLE_PATH           =
1133
1134# If the value of the EXAMPLE_PATH tag contains directories, you can use the
1135# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
1136# *.h) to filter out the source-files in the directories. If left blank all
1137# files are included.
1138
1139EXAMPLE_PATTERNS       =
1140
1141# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1142# searched for input files to be used with the \include or \dontinclude commands
1143# irrespective of the value of the RECURSIVE tag.
1144# The default value is: NO.
1145
1146EXAMPLE_RECURSIVE      = NO
1147
1148# The IMAGE_PATH tag can be used to specify one or more files or directories
1149# that contain images that are to be included in the documentation (see the
1150# \image command).
1151
1152IMAGE_PATH             =
1153
1154# The INPUT_FILTER tag can be used to specify a program that doxygen should
1155# invoke to filter for each input file. Doxygen will invoke the filter program
1156# by executing (via popen()) the command:
1157#
1158# <filter> <input-file>
1159#
1160# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1161# name of an input file. Doxygen will then use the output that the filter
1162# program writes to standard output. If FILTER_PATTERNS is specified, this tag
1163# will be ignored.
1164#
1165# Note that the filter must not add or remove lines; it is applied before the
1166# code is scanned, but not when the output code is generated. If lines are added
1167# or removed, the anchors will not be placed correctly.
1168#
1169# Note that for custom extensions or not directly supported extensions you also
1170# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1171# properly processed by doxygen.
1172
1173INPUT_FILTER           =
1174
1175# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1176# basis. Doxygen will compare the file name with each pattern and apply the
1177# filter if there is a match. The filters are a list of the form: pattern=filter
1178# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
1179# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1180# patterns match the file name, INPUT_FILTER is applied.
1181#
1182# Note that for custom extensions or not directly supported extensions you also
1183# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1184# properly processed by doxygen.
1185
1186FILTER_PATTERNS        =
1187
1188# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1189# INPUT_FILTER) will also be used to filter the input files that are used for
1190# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1191# The default value is: NO.
1192
1193FILTER_SOURCE_FILES    = NO
1194
1195# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1196# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1197# it is also possible to disable source filtering for a specific pattern using
1198# *.ext= (so without naming a filter).
1199# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1200
1201FILTER_SOURCE_PATTERNS =
1202
1203# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1204# is part of the input, its contents will be placed on the main page
1205# (index.html). This can be useful if you have a project on for instance GitHub
1206# and want to reuse the introduction page also for the doxygen output.
1207
1208USE_MDFILE_AS_MAINPAGE =
1209
1210#---------------------------------------------------------------------------
1211# Configuration options related to source browsing
1212#---------------------------------------------------------------------------
1213
1214# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1215# generated. Documented entities will be cross-referenced with these sources.
1216#
1217# Note: To get rid of all source code in the generated output, make sure that
1218# also VERBATIM_HEADERS is set to NO.
1219# The default value is: NO.
1220
1221SOURCE_BROWSER         = @do_html@
1222
1223# Setting the INLINE_SOURCES tag to YES will include the body of functions,
1224# classes and enums directly into the documentation.
1225# The default value is: NO.
1226
1227INLINE_SOURCES         = NO
1228
1229# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1230# special comment blocks from generated source code fragments. Normal C, C++ and
1231# Fortran comments will always remain visible.
1232# The default value is: YES.
1233
1234STRIP_CODE_COMMENTS    = NO
1235
1236# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1237# entity all documented functions referencing it will be listed.
1238# The default value is: NO.
1239
1240REFERENCED_BY_RELATION = YES
1241
1242# If the REFERENCES_RELATION tag is set to YES then for each documented function
1243# all documented entities called/used by that function will be listed.
1244# The default value is: NO.
1245
1246REFERENCES_RELATION    = YES
1247
1248# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1249# to YES then the hyperlinks from functions in REFERENCES_RELATION and
1250# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1251# link to the documentation.
1252# The default value is: YES.
1253
1254REFERENCES_LINK_SOURCE = YES
1255
1256# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1257# source code will show a tooltip with additional information such as prototype,
1258# brief description and links to the definition and documentation. Since this
1259# will make the HTML file larger and loading of large files a bit slower, you
1260# can opt to disable this feature.
1261# The default value is: YES.
1262# This tag requires that the tag SOURCE_BROWSER is set to YES.
1263
1264SOURCE_TOOLTIPS        = YES
1265
1266# If the USE_HTAGS tag is set to YES then the references to source code will
1267# point to the HTML generated by the htags(1) tool instead of doxygen built-in
1268# source browser. The htags tool is part of GNU's global source tagging system
1269# (see https://www.gnu.org/software/global/global.html). You will need version
1270# 4.8.6 or higher.
1271#
1272# To use it do the following:
1273# - Install the latest version of global
1274# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1275# - Make sure the INPUT points to the root of the source tree
1276# - Run doxygen as normal
1277#
1278# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1279# tools must be available from the command line (i.e. in the search path).
1280#
1281# The result: instead of the source browser generated by doxygen, the links to
1282# source code will now point to the output of htags.
1283# The default value is: NO.
1284# This tag requires that the tag SOURCE_BROWSER is set to YES.
1285
1286USE_HTAGS              = NO
1287
1288# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1289# verbatim copy of the header file for each class for which an include is
1290# specified. Set to NO to disable this.
1291# See also: Section \class.
1292# The default value is: YES.
1293
1294VERBATIM_HEADERS       = NO
1295
1296#---------------------------------------------------------------------------
1297# Configuration options related to the alphabetical class index
1298#---------------------------------------------------------------------------
1299
1300# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1301# compounds will be generated. Enable this if the project contains a lot of
1302# classes, structs, unions or interfaces.
1303# The default value is: YES.
1304
1305ALPHABETICAL_INDEX     = YES
1306
1307# In case all classes in a project start with a common prefix, all classes will
1308# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1309# can be used to specify a prefix (or a list of prefixes) that should be ignored
1310# while generating the index headers.
1311# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1312
1313IGNORE_PREFIX          =
1314
1315#---------------------------------------------------------------------------
1316# Configuration options related to the HTML output
1317#---------------------------------------------------------------------------
1318
1319# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1320# The default value is: YES.
1321
1322GENERATE_HTML          = @do_html@
1323
1324# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1325# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1326# it.
1327# The default directory is: html.
1328# This tag requires that the tag GENERATE_HTML is set to YES.
1329
1330HTML_OUTPUT            = html
1331
1332# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1333# generated HTML page (for example: .htm, .php, .asp).
1334# The default value is: .html.
1335# This tag requires that the tag GENERATE_HTML is set to YES.
1336
1337HTML_FILE_EXTENSION    = .html
1338
1339# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1340# each generated HTML page. If the tag is left blank doxygen will generate a
1341# standard header.
1342#
1343# To get valid HTML the header file that includes any scripts and style sheets
1344# that doxygen needs, which is dependent on the configuration options used (e.g.
1345# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1346# default header using
1347# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1348# YourConfigFile
1349# and then modify the file new_header.html. See also section "Doxygen usage"
1350# for information on how to generate the default header that doxygen normally
1351# uses.
1352# Note: The header is subject to change so you typically have to regenerate the
1353# default header when upgrading to a newer version of doxygen. For a description
1354# of the possible markers and block names see the documentation.
1355# This tag requires that the tag GENERATE_HTML is set to YES.
1356
1357HTML_HEADER            =
1358
1359# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1360# generated HTML page. If the tag is left blank doxygen will generate a standard
1361# footer. See HTML_HEADER for more information on how to generate a default
1362# footer and what special commands can be used inside the footer. See also
1363# section "Doxygen usage" for information on how to generate the default footer
1364# that doxygen normally uses.
1365# This tag requires that the tag GENERATE_HTML is set to YES.
1366
1367HTML_FOOTER            =
1368
1369# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1370# sheet that is used by each HTML page. It can be used to fine-tune the look of
1371# the HTML output. If left blank doxygen will generate a default style sheet.
1372# See also section "Doxygen usage" for information on how to generate the style
1373# sheet that doxygen normally uses.
1374# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1375# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1376# obsolete.
1377# This tag requires that the tag GENERATE_HTML is set to YES.
1378
1379HTML_STYLESHEET        =
1380
1381# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1382# cascading style sheets that are included after the standard style sheets
1383# created by doxygen. Using this option one can overrule certain style aspects.
1384# This is preferred over using HTML_STYLESHEET since it does not replace the
1385# standard style sheet and is therefore more robust against future updates.
1386# Doxygen will copy the style sheet files to the output directory.
1387# Note: The order of the extra style sheet files is of importance (e.g. the last
1388# style sheet in the list overrules the setting of the previous ones in the
1389# list). For an example see the documentation.
1390# This tag requires that the tag GENERATE_HTML is set to YES.
1391
1392HTML_EXTRA_STYLESHEET  =
1393
1394# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1395# other source files which should be copied to the HTML output directory. Note
1396# that these files will be copied to the base HTML output directory. Use the
1397# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1398# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1399# files will be copied as-is; there are no commands or markers available.
1400# This tag requires that the tag GENERATE_HTML is set to YES.
1401
1402HTML_EXTRA_FILES       =
1403
1404# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1405# will adjust the colors in the style sheet and background images according to
1406# this color. Hue is specified as an angle on a colorwheel, see
1407# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1408# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1409# purple, and 360 is red again.
1410# Minimum value: 0, maximum value: 359, default value: 220.
1411# This tag requires that the tag GENERATE_HTML is set to YES.
1412
1413HTML_COLORSTYLE_HUE    = 220
1414
1415# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1416# in the HTML output. For a value of 0 the output will use grayscales only. A
1417# value of 255 will produce the most vivid colors.
1418# Minimum value: 0, maximum value: 255, default value: 100.
1419# This tag requires that the tag GENERATE_HTML is set to YES.
1420
1421HTML_COLORSTYLE_SAT    = 100
1422
1423# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1424# luminance component of the colors in the HTML output. Values below 100
1425# gradually make the output lighter, whereas values above 100 make the output
1426# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1427# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1428# change the gamma.
1429# Minimum value: 40, maximum value: 240, default value: 80.
1430# This tag requires that the tag GENERATE_HTML is set to YES.
1431
1432HTML_COLORSTYLE_GAMMA  = 80
1433
1434# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1435# page will contain the date and time when the page was generated. Setting this
1436# to YES can help to show when doxygen was last run and thus if the
1437# documentation is up to date.
1438# The default value is: NO.
1439# This tag requires that the tag GENERATE_HTML is set to YES.
1440
1441HTML_TIMESTAMP         = NO
1442
1443# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1444# documentation will contain a main index with vertical navigation menus that
1445# are dynamically created via JavaScript. If disabled, the navigation index will
1446# consists of multiple levels of tabs that are statically embedded in every HTML
1447# page. Disable this option to support browsers that do not have JavaScript,
1448# like the Qt help browser.
1449# The default value is: YES.
1450# This tag requires that the tag GENERATE_HTML is set to YES.
1451
1452HTML_DYNAMIC_MENUS     = YES
1453
1454# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1455# documentation will contain sections that can be hidden and shown after the
1456# page has loaded.
1457# The default value is: NO.
1458# This tag requires that the tag GENERATE_HTML is set to YES.
1459
1460HTML_DYNAMIC_SECTIONS  = NO
1461
1462# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1463# shown in the various tree structured indices initially; the user can expand
1464# and collapse entries dynamically later on. Doxygen will expand the tree to
1465# such a level that at most the specified number of entries are visible (unless
1466# a fully collapsed tree already exceeds this amount). So setting the number of
1467# entries 1 will produce a full collapsed tree by default. 0 is a special value
1468# representing an infinite number of entries and will result in a full expanded
1469# tree by default.
1470# Minimum value: 0, maximum value: 9999, default value: 100.
1471# This tag requires that the tag GENERATE_HTML is set to YES.
1472
1473HTML_INDEX_NUM_ENTRIES = 0
1474
1475# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1476# generated that can be used as input for Apple's Xcode 3 integrated development
1477# environment (see: https://developer.apple.com/xcode/), introduced with OSX
1478# 10.5 (Leopard). To create a documentation set, doxygen will generate a
1479# Makefile in the HTML output directory. Running make will produce the docset in
1480# that directory and running make install will install the docset in
1481# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1482# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1483# genXcode/_index.html for more information.
1484# The default value is: NO.
1485# This tag requires that the tag GENERATE_HTML is set to YES.
1486
1487GENERATE_DOCSET        = NO
1488
1489# This tag determines the name of the docset feed. A documentation feed provides
1490# an umbrella under which multiple documentation sets from a single provider
1491# (such as a company or product suite) can be grouped.
1492# The default value is: Doxygen generated docs.
1493# This tag requires that the tag GENERATE_DOCSET is set to YES.
1494
1495DOCSET_FEEDNAME        = "Doxygen generated docs"
1496
1497# This tag specifies a string that should uniquely identify the documentation
1498# set bundle. This should be a reverse domain-name style string, e.g.
1499# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1500# The default value is: org.doxygen.Project.
1501# This tag requires that the tag GENERATE_DOCSET is set to YES.
1502
1503DOCSET_BUNDLE_ID       = org.gnu.libstdc++
1504
1505# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1506# the documentation publisher. This should be a reverse domain-name style
1507# string, e.g. com.mycompany.MyDocSet.documentation.
1508# The default value is: org.doxygen.Publisher.
1509# This tag requires that the tag GENERATE_DOCSET is set to YES.
1510
1511DOCSET_PUBLISHER_ID    = org.fsf
1512
1513# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1514# The default value is: Publisher.
1515# This tag requires that the tag GENERATE_DOCSET is set to YES.
1516
1517DOCSET_PUBLISHER_NAME  = libstdc++
1518
1519# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1520# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1521# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1522# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1523# Windows.
1524#
1525# The HTML Help Workshop contains a compiler that can convert all HTML output
1526# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1527# files are now used as the Windows 98 help format, and will replace the old
1528# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1529# HTML files also contain an index, a table of contents, and you can search for
1530# words in the documentation. The HTML workshop also contains a viewer for
1531# compressed HTML files.
1532# The default value is: NO.
1533# This tag requires that the tag GENERATE_HTML is set to YES.
1534
1535GENERATE_HTMLHELP      = NO
1536
1537# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1538# file. You can add a path in front of the file if the result should not be
1539# written to the html output directory.
1540# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1541
1542CHM_FILE               =
1543
1544# The HHC_LOCATION tag can be used to specify the location (absolute path
1545# including file name) of the HTML help compiler (hhc.exe). If non-empty,
1546# doxygen will try to run the HTML help compiler on the generated index.hhp.
1547# The file has to be specified with full path.
1548# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1549
1550HHC_LOCATION           =
1551
1552# The GENERATE_CHI flag controls if a separate .chi index file is generated
1553# (YES) or that it should be included in the main .chm file (NO).
1554# The default value is: NO.
1555# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1556
1557GENERATE_CHI           = NO
1558
1559# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1560# and project file content.
1561# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1562
1563CHM_INDEX_ENCODING     =
1564
1565# The BINARY_TOC flag controls whether a binary table of contents is generated
1566# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1567# enables the Previous and Next buttons.
1568# The default value is: NO.
1569# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1570
1571BINARY_TOC             = NO
1572
1573# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1574# the table of contents of the HTML help documentation and to the tree view.
1575# The default value is: NO.
1576# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1577
1578TOC_EXPAND             = NO
1579
1580# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1581# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1582# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1583# (.qch) of the generated HTML documentation.
1584# The default value is: NO.
1585# This tag requires that the tag GENERATE_HTML is set to YES.
1586
1587GENERATE_QHP           = NO
1588
1589# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1590# the file name of the resulting .qch file. The path specified is relative to
1591# the HTML output folder.
1592# This tag requires that the tag GENERATE_QHP is set to YES.
1593
1594QCH_FILE               =
1595
1596# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1597# Project output. For more information please see Qt Help Project / Namespace
1598# (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1599# The default value is: org.doxygen.Project.
1600# This tag requires that the tag GENERATE_QHP is set to YES.
1601
1602QHP_NAMESPACE          = org.doxygen.Project
1603
1604# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1605# Help Project output. For more information please see Qt Help Project / Virtual
1606# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
1607# The default value is: doc.
1608# This tag requires that the tag GENERATE_QHP is set to YES.
1609
1610QHP_VIRTUAL_FOLDER     = doc
1611
1612# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1613# filter to add. For more information please see Qt Help Project / Custom
1614# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1615# This tag requires that the tag GENERATE_QHP is set to YES.
1616
1617QHP_CUST_FILTER_NAME   =
1618
1619# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1620# custom filter to add. For more information please see Qt Help Project / Custom
1621# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1622# This tag requires that the tag GENERATE_QHP is set to YES.
1623
1624QHP_CUST_FILTER_ATTRS  =
1625
1626# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1627# project's filter section matches. Qt Help Project / Filter Attributes (see:
1628# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1629# This tag requires that the tag GENERATE_QHP is set to YES.
1630
1631QHP_SECT_FILTER_ATTRS  =
1632
1633# The QHG_LOCATION tag can be used to specify the location of Qt's
1634# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1635# generated .qhp file.
1636# This tag requires that the tag GENERATE_QHP is set to YES.
1637
1638QHG_LOCATION           =
1639
1640# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1641# generated, together with the HTML files, they form an Eclipse help plugin. To
1642# install this plugin and make it available under the help contents menu in
1643# Eclipse, the contents of the directory containing the HTML and XML files needs
1644# to be copied into the plugins directory of eclipse. The name of the directory
1645# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1646# After copying Eclipse needs to be restarted before the help appears.
1647# The default value is: NO.
1648# This tag requires that the tag GENERATE_HTML is set to YES.
1649
1650GENERATE_ECLIPSEHELP   = NO
1651
1652# A unique identifier for the Eclipse help plugin. When installing the plugin
1653# the directory name containing the HTML and XML files should also have this
1654# name. Each documentation set should have its own identifier.
1655# The default value is: org.doxygen.Project.
1656# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1657
1658ECLIPSE_DOC_ID         = org.doxygen.Project
1659
1660# If you want full control over the layout of the generated HTML pages it might
1661# be necessary to disable the index and replace it with your own. The
1662# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1663# of each HTML page. A value of NO enables the index and the value YES disables
1664# it. Since the tabs in the index contain the same information as the navigation
1665# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1666# The default value is: NO.
1667# This tag requires that the tag GENERATE_HTML is set to YES.
1668
1669DISABLE_INDEX          = YES
1670
1671# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1672# structure should be generated to display hierarchical information. If the tag
1673# value is set to YES, a side panel will be generated containing a tree-like
1674# index structure (just like the one that is generated for HTML Help). For this
1675# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1676# (i.e. any modern browser). Windows users are probably better off using the
1677# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1678# further fine-tune the look of the index. As an example, the default style
1679# sheet generated by doxygen has an example that shows how to put an image at
1680# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1681# the same information as the tab index, you could consider setting
1682# DISABLE_INDEX to YES when enabling this option.
1683# The default value is: NO.
1684# This tag requires that the tag GENERATE_HTML is set to YES.
1685
1686GENERATE_TREEVIEW      = YES
1687
1688# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1689# doxygen will group on one line in the generated HTML documentation.
1690#
1691# Note that a value of 0 will completely suppress the enum values from appearing
1692# in the overview section.
1693# Minimum value: 0, maximum value: 20, default value: 4.
1694# This tag requires that the tag GENERATE_HTML is set to YES.
1695
1696ENUM_VALUES_PER_LINE   = 4
1697
1698# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1699# to set the initial width (in pixels) of the frame in which the tree is shown.
1700# Minimum value: 0, maximum value: 1500, default value: 250.
1701# This tag requires that the tag GENERATE_HTML is set to YES.
1702
1703TREEVIEW_WIDTH         = 250
1704
1705# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1706# external symbols imported via tag files in a separate window.
1707# The default value is: NO.
1708# This tag requires that the tag GENERATE_HTML is set to YES.
1709
1710EXT_LINKS_IN_WINDOW    = NO
1711
1712# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1713# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
1714# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
1715# the HTML output. These images will generally look nicer at scaled resolutions.
1716# Possible values are: png (the default) and svg (looks nicer but requires the
1717# pdf2svg or inkscape tool).
1718# The default value is: png.
1719# This tag requires that the tag GENERATE_HTML is set to YES.
1720
1721HTML_FORMULA_FORMAT    = png
1722
1723# Use this tag to change the font size of LaTeX formulas included as images in
1724# the HTML documentation. When you change the font size after a successful
1725# doxygen run you need to manually remove any form_*.png images from the HTML
1726# output directory to force them to be regenerated.
1727# Minimum value: 8, maximum value: 50, default value: 10.
1728# This tag requires that the tag GENERATE_HTML is set to YES.
1729
1730FORMULA_FONTSIZE       = 10
1731
1732# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1733# generated for formulas are transparent PNGs. Transparent PNGs are not
1734# supported properly for IE 6.0, but are supported on all modern browsers.
1735#
1736# Note that when changing this option you need to delete any form_*.png files in
1737# the HTML output directory before the changes have effect.
1738# The default value is: YES.
1739# This tag requires that the tag GENERATE_HTML is set to YES.
1740
1741FORMULA_TRANSPARENT    = YES
1742
1743# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
1744# to create new LaTeX commands to be used in formulas as building blocks. See
1745# the section "Including formulas" for details.
1746
1747FORMULA_MACROFILE      =
1748
1749# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1750# https://www.mathjax.org) which uses client side JavaScript for the rendering
1751# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1752# installed or if you want to formulas look prettier in the HTML output. When
1753# enabled you may also need to install MathJax separately and configure the path
1754# to it using the MATHJAX_RELPATH option.
1755# The default value is: NO.
1756# This tag requires that the tag GENERATE_HTML is set to YES.
1757
1758USE_MATHJAX            = NO
1759
1760# When MathJax is enabled you can set the default output format to be used for
1761# the MathJax output. See the MathJax site (see:
1762# http://docs.mathjax.org/en/latest/output.html) for more details.
1763# Possible values are: HTML-CSS (which is slower, but has the best
1764# compatibility), NativeMML (i.e. MathML) and SVG.
1765# The default value is: HTML-CSS.
1766# This tag requires that the tag USE_MATHJAX is set to YES.
1767
1768MATHJAX_FORMAT         = HTML-CSS
1769
1770# When MathJax is enabled you need to specify the location relative to the HTML
1771# output directory using the MATHJAX_RELPATH option. The destination directory
1772# should contain the MathJax.js script. For instance, if the mathjax directory
1773# is located at the same level as the HTML output directory, then
1774# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1775# Content Delivery Network so you can quickly see the result without installing
1776# MathJax. However, it is strongly recommended to install a local copy of
1777# MathJax from https://www.mathjax.org before deployment.
1778# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2.
1779# This tag requires that the tag USE_MATHJAX is set to YES.
1780
1781MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
1782
1783# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1784# extension names that should be enabled during MathJax rendering. For example
1785# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1786# This tag requires that the tag USE_MATHJAX is set to YES.
1787
1788MATHJAX_EXTENSIONS     =
1789
1790# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1791# of code that will be used on startup of the MathJax code. See the MathJax site
1792# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1793# example see the documentation.
1794# This tag requires that the tag USE_MATHJAX is set to YES.
1795
1796MATHJAX_CODEFILE       =
1797
1798# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1799# the HTML output. The underlying search engine uses javascript and DHTML and
1800# should work on any modern browser. Note that when using HTML help
1801# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1802# there is already a search function so this one should typically be disabled.
1803# For large projects the javascript based search engine can be slow, then
1804# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1805# search using the keyboard; to jump to the search box use <access key> + S
1806# (what the <access key> is depends on the OS and browser, but it is typically
1807# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1808# key> to jump into the search results window, the results can be navigated
1809# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1810# the search. The filter options can be selected when the cursor is inside the
1811# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1812# to select a filter and <Enter> or <escape> to activate or cancel the filter
1813# option.
1814# The default value is: YES.
1815# This tag requires that the tag GENERATE_HTML is set to YES.
1816
1817SEARCHENGINE           = NO
1818
1819# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1820# implemented using a web server instead of a web client using JavaScript. There
1821# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1822# setting. When disabled, doxygen will generate a PHP script for searching and
1823# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1824# and searching needs to be provided by external tools. See the section
1825# "External Indexing and Searching" for details.
1826# The default value is: NO.
1827# This tag requires that the tag SEARCHENGINE is set to YES.
1828
1829SERVER_BASED_SEARCH    = NO
1830
1831# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1832# script for searching. Instead the search results are written to an XML file
1833# which needs to be processed by an external indexer. Doxygen will invoke an
1834# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1835# search results.
1836#
1837# Doxygen ships with an example indexer (doxyindexer) and search engine
1838# (doxysearch.cgi) which are based on the open source search engine library
1839# Xapian (see: https://xapian.org/).
1840#
1841# See the section "External Indexing and Searching" for details.
1842# The default value is: NO.
1843# This tag requires that the tag SEARCHENGINE is set to YES.
1844
1845EXTERNAL_SEARCH        = NO
1846
1847# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1848# which will return the search results when EXTERNAL_SEARCH is enabled.
1849#
1850# Doxygen ships with an example indexer (doxyindexer) and search engine
1851# (doxysearch.cgi) which are based on the open source search engine library
1852# Xapian (see: https://xapian.org/). See the section "External Indexing and
1853# Searching" for details.
1854# This tag requires that the tag SEARCHENGINE is set to YES.
1855
1856SEARCHENGINE_URL       =
1857
1858# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1859# search data is written to a file for indexing by an external tool. With the
1860# SEARCHDATA_FILE tag the name of this file can be specified.
1861# The default file is: searchdata.xml.
1862# This tag requires that the tag SEARCHENGINE is set to YES.
1863
1864SEARCHDATA_FILE        = searchdata.xml
1865
1866# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1867# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1868# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1869# projects and redirect the results back to the right project.
1870# This tag requires that the tag SEARCHENGINE is set to YES.
1871
1872EXTERNAL_SEARCH_ID     =
1873
1874# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1875# projects other than the one defined by this configuration file, but that are
1876# all added to the same external search index. Each project needs to have a
1877# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1878# to a relative location where the documentation can be found. The format is:
1879# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1880# This tag requires that the tag SEARCHENGINE is set to YES.
1881
1882EXTRA_SEARCH_MAPPINGS  =
1883
1884#---------------------------------------------------------------------------
1885# Configuration options related to the LaTeX output
1886#---------------------------------------------------------------------------
1887
1888# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1889# The default value is: YES.
1890
1891GENERATE_LATEX         = @do_latex@
1892
1893# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1894# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1895# it.
1896# The default directory is: latex.
1897# This tag requires that the tag GENERATE_LATEX is set to YES.
1898
1899LATEX_OUTPUT           = latex
1900
1901# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1902# invoked.
1903#
1904# Note that when not enabling USE_PDFLATEX the default is latex when enabling
1905# USE_PDFLATEX the default is pdflatex and when in the later case latex is
1906# chosen this is overwritten by pdflatex. For specific output languages the
1907# default can have been set differently, this depends on the implementation of
1908# the output language.
1909# This tag requires that the tag GENERATE_LATEX is set to YES.
1910
1911LATEX_CMD_NAME         = @latex_cmd@
1912
1913# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1914# index for LaTeX.
1915# Note: This tag is used in the Makefile / make.bat.
1916# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
1917# (.tex).
1918# The default file is: makeindex.
1919# This tag requires that the tag GENERATE_LATEX is set to YES.
1920
1921MAKEINDEX_CMD_NAME     = makeindex
1922
1923# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
1924# generate index for LaTeX. In case there is no backslash (\) as first character
1925# it will be automatically added in the LaTeX code.
1926# Note: This tag is used in the generated output file (.tex).
1927# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
1928# The default value is: makeindex.
1929# This tag requires that the tag GENERATE_LATEX is set to YES.
1930
1931LATEX_MAKEINDEX_CMD    = makeindex
1932
1933# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1934# documents. This may be useful for small projects and may help to save some
1935# trees in general.
1936# The default value is: NO.
1937# This tag requires that the tag GENERATE_LATEX is set to YES.
1938
1939COMPACT_LATEX          = YES
1940
1941# The PAPER_TYPE tag can be used to set the paper type that is used by the
1942# printer.
1943# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1944# 14 inches) and executive (7.25 x 10.5 inches).
1945# The default value is: a4.
1946# This tag requires that the tag GENERATE_LATEX is set to YES.
1947
1948PAPER_TYPE             = letter
1949
1950# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1951# that should be included in the LaTeX output. The package can be specified just
1952# by its name or with the correct syntax as to be used with the LaTeX
1953# \usepackage command. To get the times font for instance you can specify :
1954# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1955# To use the option intlimits with the amsmath package you can specify:
1956# EXTRA_PACKAGES=[intlimits]{amsmath}
1957# If left blank no extra packages will be included.
1958# This tag requires that the tag GENERATE_LATEX is set to YES.
1959
1960EXTRA_PACKAGES         = amsmath
1961
1962# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1963# generated LaTeX document. The header should contain everything until the first
1964# chapter. If it is left blank doxygen will generate a standard header. See
1965# section "Doxygen usage" for information on how to let doxygen write the
1966# default header to a separate file.
1967#
1968# Note: Only use a user-defined header if you know what you are doing! The
1969# following commands have a special meaning inside the header: $title,
1970# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1971# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1972# string, for the replacement values of the other commands the user is referred
1973# to HTML_HEADER.
1974# This tag requires that the tag GENERATE_LATEX is set to YES.
1975
1976LATEX_HEADER           =
1977
1978# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1979# generated LaTeX document. The footer should contain everything after the last
1980# chapter. If it is left blank doxygen will generate a standard footer. See
1981# LATEX_HEADER for more information on how to generate a default footer and what
1982# special commands can be used inside the footer.
1983#
1984# Note: Only use a user-defined footer if you know what you are doing!
1985# This tag requires that the tag GENERATE_LATEX is set to YES.
1986
1987LATEX_FOOTER           =
1988
1989# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1990# LaTeX style sheets that are included after the standard style sheets created
1991# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1992# will copy the style sheet files to the output directory.
1993# Note: The order of the extra style sheet files is of importance (e.g. the last
1994# style sheet in the list overrules the setting of the previous ones in the
1995# list).
1996# This tag requires that the tag GENERATE_LATEX is set to YES.
1997
1998LATEX_EXTRA_STYLESHEET =
1999
2000# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
2001# other source files which should be copied to the LATEX_OUTPUT output
2002# directory. Note that the files will be copied as-is; there are no commands or
2003# markers available.
2004# This tag requires that the tag GENERATE_LATEX is set to YES.
2005
2006LATEX_EXTRA_FILES      =
2007
2008# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
2009# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
2010# contain links (just like the HTML output) instead of page references. This
2011# makes the output suitable for online browsing using a PDF viewer.
2012# The default value is: YES.
2013# This tag requires that the tag GENERATE_LATEX is set to YES.
2014
2015PDF_HYPERLINKS         = YES
2016
2017# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
2018# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
2019# files. Set this option to YES, to get a higher quality PDF documentation.
2020#
2021# See also section LATEX_CMD_NAME for selecting the engine.
2022# The default value is: YES.
2023# This tag requires that the tag GENERATE_LATEX is set to YES.
2024
2025USE_PDFLATEX           = YES
2026
2027# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
2028# command to the generated LaTeX files. This will instruct LaTeX to keep running
2029# if errors occur, instead of asking the user for help. This option is also used
2030# when generating formulas in HTML.
2031# The default value is: NO.
2032# This tag requires that the tag GENERATE_LATEX is set to YES.
2033
2034LATEX_BATCHMODE        = YES
2035
2036# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
2037# index chapters (such as File Index, Compound Index, etc.) in the output.
2038# The default value is: NO.
2039# This tag requires that the tag GENERATE_LATEX is set to YES.
2040
2041LATEX_HIDE_INDICES     = YES
2042
2043# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
2044# bibliography, e.g. plainnat, or ieeetr. See
2045# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
2046# The default value is: plain.
2047# This tag requires that the tag GENERATE_LATEX is set to YES.
2048
2049LATEX_BIB_STYLE        = plain
2050
2051# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
2052# page will contain the date and time when the page was generated. Setting this
2053# to NO can help when comparing the output of multiple runs.
2054# The default value is: NO.
2055# This tag requires that the tag GENERATE_LATEX is set to YES.
2056
2057LATEX_TIMESTAMP        = NO
2058
2059# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
2060# path from which the emoji images will be read. If a relative path is entered,
2061# it will be relative to the LATEX_OUTPUT directory. If left blank the
2062# LATEX_OUTPUT directory will be used.
2063# This tag requires that the tag GENERATE_LATEX is set to YES.
2064
2065LATEX_EMOJI_DIRECTORY  =
2066
2067#---------------------------------------------------------------------------
2068# Configuration options related to the RTF output
2069#---------------------------------------------------------------------------
2070
2071# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
2072# RTF output is optimized for Word 97 and may not look too pretty with other RTF
2073# readers/editors.
2074# The default value is: NO.
2075
2076GENERATE_RTF           = NO
2077
2078# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2079# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2080# it.
2081# The default directory is: rtf.
2082# This tag requires that the tag GENERATE_RTF is set to YES.
2083
2084RTF_OUTPUT             = rtf
2085
2086# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
2087# documents. This may be useful for small projects and may help to save some
2088# trees in general.
2089# The default value is: NO.
2090# This tag requires that the tag GENERATE_RTF is set to YES.
2091
2092COMPACT_RTF            = NO
2093
2094# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
2095# contain hyperlink fields. The RTF file will contain links (just like the HTML
2096# output) instead of page references. This makes the output suitable for online
2097# browsing using Word or some other Word compatible readers that support those
2098# fields.
2099#
2100# Note: WordPad (write) and others do not support links.
2101# The default value is: NO.
2102# This tag requires that the tag GENERATE_RTF is set to YES.
2103
2104RTF_HYPERLINKS         = NO
2105
2106# Load stylesheet definitions from file. Syntax is similar to doxygen's
2107# configuration file, i.e. a series of assignments. You only have to provide
2108# replacements, missing definitions are set to their default value.
2109#
2110# See also section "Doxygen usage" for information on how to generate the
2111# default style sheet that doxygen normally uses.
2112# This tag requires that the tag GENERATE_RTF is set to YES.
2113
2114RTF_STYLESHEET_FILE    =
2115
2116# Set optional variables used in the generation of an RTF document. Syntax is
2117# similar to doxygen's configuration file. A template extensions file can be
2118# generated using doxygen -e rtf extensionFile.
2119# This tag requires that the tag GENERATE_RTF is set to YES.
2120
2121RTF_EXTENSIONS_FILE    =
2122
2123#---------------------------------------------------------------------------
2124# Configuration options related to the man page output
2125#---------------------------------------------------------------------------
2126
2127# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2128# classes and files.
2129# The default value is: NO.
2130
2131GENERATE_MAN           = @do_man@
2132
2133# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2134# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2135# it. A directory man3 will be created inside the directory specified by
2136# MAN_OUTPUT.
2137# The default directory is: man.
2138# This tag requires that the tag GENERATE_MAN is set to YES.
2139
2140MAN_OUTPUT             = man
2141
2142# The MAN_EXTENSION tag determines the extension that is added to the generated
2143# man pages. In case the manual section does not start with a number, the number
2144# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2145# optional.
2146# The default value is: .3.
2147# This tag requires that the tag GENERATE_MAN is set to YES.
2148
2149MAN_EXTENSION          = .3
2150
2151# The MAN_SUBDIR tag determines the name of the directory created within
2152# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2153# MAN_EXTENSION with the initial . removed.
2154# This tag requires that the tag GENERATE_MAN is set to YES.
2155
2156MAN_SUBDIR             =
2157
2158# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2159# will generate one additional man file for each entity documented in the real
2160# man page(s). These additional files only source the real man page, but without
2161# them the man command would be unable to find the correct page.
2162# The default value is: NO.
2163# This tag requires that the tag GENERATE_MAN is set to YES.
2164
2165MAN_LINKS              = NO
2166
2167#---------------------------------------------------------------------------
2168# Configuration options related to the XML output
2169#---------------------------------------------------------------------------
2170
2171# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2172# captures the structure of the code including all documentation.
2173# The default value is: NO.
2174
2175GENERATE_XML           = @do_xml@
2176
2177# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2178# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2179# it.
2180# The default directory is: xml.
2181# This tag requires that the tag GENERATE_XML is set to YES.
2182
2183XML_OUTPUT             = xml
2184
2185# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2186# listings (including syntax highlighting and cross-referencing information) to
2187# the XML output. Note that enabling this will significantly increase the size
2188# of the XML output.
2189# The default value is: YES.
2190# This tag requires that the tag GENERATE_XML is set to YES.
2191
2192XML_PROGRAMLISTING     = NO
2193
2194# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2195# namespace members in file scope as well, matching the HTML output.
2196# The default value is: NO.
2197# This tag requires that the tag GENERATE_XML is set to YES.
2198
2199XML_NS_MEMB_FILE_SCOPE = NO
2200
2201#---------------------------------------------------------------------------
2202# Configuration options related to the DOCBOOK output
2203#---------------------------------------------------------------------------
2204
2205# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2206# that can be used to generate PDF.
2207# The default value is: NO.
2208
2209GENERATE_DOCBOOK       = NO
2210
2211# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2212# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2213# front of it.
2214# The default directory is: docbook.
2215# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2216
2217DOCBOOK_OUTPUT         = docbook
2218
2219#---------------------------------------------------------------------------
2220# Configuration options for the AutoGen Definitions output
2221#---------------------------------------------------------------------------
2222
2223# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2224# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
2225# the structure of the code including all documentation. Note that this feature
2226# is still experimental and incomplete at the moment.
2227# The default value is: NO.
2228
2229GENERATE_AUTOGEN_DEF   = NO
2230
2231#---------------------------------------------------------------------------
2232# Configuration options related to the Perl module output
2233#---------------------------------------------------------------------------
2234
2235# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2236# file that captures the structure of the code including all documentation.
2237#
2238# Note that this feature is still experimental and incomplete at the moment.
2239# The default value is: NO.
2240
2241GENERATE_PERLMOD       = NO
2242
2243# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2244# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2245# output from the Perl module output.
2246# The default value is: NO.
2247# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2248
2249PERLMOD_LATEX          = NO
2250
2251# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2252# formatted so it can be parsed by a human reader. This is useful if you want to
2253# understand what is going on. On the other hand, if this tag is set to NO, the
2254# size of the Perl module output will be much smaller and Perl will parse it
2255# just the same.
2256# The default value is: YES.
2257# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2258
2259PERLMOD_PRETTY         = YES
2260
2261# The names of the make variables in the generated doxyrules.make file are
2262# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2263# so different doxyrules.make files included by the same Makefile don't
2264# overwrite each other's variables.
2265# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2266
2267PERLMOD_MAKEVAR_PREFIX =
2268
2269#---------------------------------------------------------------------------
2270# Configuration options related to the preprocessor
2271#---------------------------------------------------------------------------
2272
2273# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2274# C-preprocessor directives found in the sources and include files.
2275# The default value is: YES.
2276
2277ENABLE_PREPROCESSING   = YES
2278
2279# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2280# in the source code. If set to NO, only conditional compilation will be
2281# performed. Macro expansion can be done in a controlled way by setting
2282# EXPAND_ONLY_PREDEF to YES.
2283# The default value is: NO.
2284# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2285
2286MACRO_EXPANSION        = YES
2287
2288# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2289# the macro expansion is limited to the macros specified with the PREDEFINED and
2290# EXPAND_AS_DEFINED tags.
2291# The default value is: NO.
2292# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2293
2294EXPAND_ONLY_PREDEF     = NO
2295
2296# If the SEARCH_INCLUDES tag is set to YES, the include files in the
2297# INCLUDE_PATH will be searched if a #include is found.
2298# The default value is: YES.
2299# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2300
2301SEARCH_INCLUDES        = YES
2302
2303# The INCLUDE_PATH tag can be used to specify one or more directories that
2304# contain include files that are not input files but should be processed by the
2305# preprocessor.
2306# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2307
2308INCLUDE_PATH           = include
2309
2310# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2311# patterns (like *.h and *.hpp) to filter out the header-files in the
2312# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2313# used.
2314# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2315
2316INCLUDE_FILE_PATTERNS  =
2317
2318# The PREDEFINED tag can be used to specify one or more macro names that are
2319# defined before the preprocessor is started (similar to the -D option of e.g.
2320# gcc). The argument of the tag is a list of macros of the form: name or
2321# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2322# is assumed. To prevent a macro definition from being undefined via #undef or
2323# recursively expanded use the := operator instead of the = operator.
2324# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2325
2326PREDEFINED             = __cplusplus=202002L \
2327                         __GTHREADS \
2328                         _GLIBCXX_HAS_GTHREADS \
2329                         _GTHREAD_USE_MUTEX_TIMEDLOCK \
2330                         _GLIBCXX_HAVE_TLS \
2331                         _GLIBCXX_INCLUDE_AS_CXX11 \
2332                         "_GLIBCXX_PURE= " \
2333                         "_GLIBCXX_CONST= " \
2334                         "_GLIBCXX_NODISCARD=[[nodiscard]]" \
2335                         "_GLIBCXX_NORETURN= " \
2336                         "_GLIBCXX_NOEXCEPT_PARM= " \
2337                         "_GLIBCXX_NOEXCEPT_QUAL= " \
2338                         "_GLIBCXX_STD_C= " \
2339                         "_GLIBCXX_STD_A= " \
2340                         "_GLIBCXX_TXN_SAFE_DYN= " \
2341                         "_GLIBCXX_VISIBILITY(V)= " \
2342                         "_GLIBCXX_BEGIN_NAMESPACE_VERSION= " \
2343                         "_GLIBCXX_BEGIN_NAMESPACE_ALGO= " \
2344                         "_GLIBCXX_BEGIN_NAMESPACE_CONTAINER= " \
2345                         "_GLIBCXX_BEGIN_NAMESPACE_CXX11= " \
2346                         "_GLIBCXX_BEGIN_NAMESPACE_LDBL= " \
2347                         "_GLIBCXX_END_NAMESPACE_VERSION= " \
2348                         "_GLIBCXX_END_NAMESPACE_ALGO= " \
2349                         "_GLIBCXX_END_NAMESPACE_CONTAINER= " \
2350                         "_GLIBCXX_END_NAMESPACE_CXX11= " \
2351                         "_GLIBCXX_END_NAMESPACE_LDBL= " \
2352			 "-D_GLIBCXX_BEGIN_INLINE_ABI_NAMESPACE(X)= " \
2353			 "-D_GLIBCXX_END_INLINE_ABI_NAMESPACE(X)= " \
2354                         "_GLIBCXX_TEMPLATE_ARGS=...  " \
2355                         "_GLIBCXX_DEPRECATED= " \
2356                         "_GLIBCXX_DEPRECATED_SUGGEST(E)= " \
2357                         _GLIBCXX_CONSTEXPR=constexpr \
2358                         _GLIBCXX_USE_CONSTEXPR=constexpr \
2359                         "_GLIBCXX_THROW(E)= " \
2360                         _GLIBCXX_NOEXCEPT=noexcept \
2361                         "_GLIBCXX_NOEXCEPT_IF(C)=noexcept(/*conditional*/)" \
2362                         _GLIBCXX_NOTHROW=noexcept \
2363                         _GLIBCXX_USE_NOEXCEPT=noexcept \
2364                         _GLIBCXX_USE_WCHAR_T \
2365                         _GLIBCXX_USE_LONG_LONG \
2366                         _GLIBCXX_USE_C99_STDINT_TR1 \
2367                         _GLIBCXX_USE_SCHED_YIELD \
2368                         _GLIBCXX_USE_NANOSLEEP \
2369                         __cpp_exceptions \
2370                         __cpp_rtti \
2371                         __cpp_inline_variables \
2372                         __cpp_constexpr_dynamic_alloc \
2373                         __cpp_aligned_new \
2374                         __cpp_sized_deallocation \
2375                         __cpp_concepts=209900 \
2376                         __cpp_deduction_guides=209900 \
2377                         __cpp_impl_three_way_comparison=209900 \
2378                         __cpp_impl_coroutine \
2379                         ATOMIC_INT_LOCK_FREE=2 \
2380                         PB_DS_DATA_TRUE_INDICATOR \
2381                         PB_DS_STATIC_ASSERT=// \
2382                         "_GLIBCXX_BEGIN_NAMESPACE_ALGO= " \
2383                         "_GLIBCXX_END_NAMESPACE_ALGO= " \
2384                         __glibcxx_function_requires=// \
2385                         __glibcxx_class_requires=// \
2386                         __glibcxx_class_requires2=// \
2387                         __glibcxx_class_requires3=// \
2388                         __glibcxx_class_requires4=// \
2389                         "__attribute__(X)= " \
2390                         _GLIBCXX14_CONSTEXPR=constexpr \
2391                         _GLIBCXX17_CONSTEXPR=constexpr \
2392                         _GLIBCXX20_CONSTEXPR=constexpr \
2393                         _GLIBCXX23_CONSTEXPR=constexpr \
2394                         "_GLIBCXX11_DEPRECATED= " \
2395                         "_GLIBCXX11_DEPRECATED_SUGGEST(E)= " \
2396                         "_GLIBCXX17_DEPRECATED= " \
2397                         "_GLIBCXX17_DEPRECATED_SUGGEST(E)= " \
2398                         "_GLIBCXX20_DEPRECATED(E)= " \
2399                         "_GLIBCXX20_DEPRECATED(E)= " \
2400                         _GLIBCXX17_INLINE=inline \
2401                         _GLIBCXX_CHRONO_INT64_T=int64_t \
2402                         _GLIBCXX_DEFAULT_ABI_TAG \
2403                         _GLIBCXX_USE_DEPRECATED \
2404                         _GLIBCXX_HOSTED \
2405                         "__has_builtin(x)=1" \
2406                         _GLIBCXX_HAVE_BUILTIN_HAS_UNIQ_OBJ_REP \
2407                         _GLIBCXX_HAVE_BUILTIN_IS_AGGREGATE \
2408                         _GLIBCXX_HAVE_IS_CONSTANT_EVALUATED \
2409                         _GLIBCXX_HAVE_BUILTIN_LAUNDER \
2410			 "_GLIBCXX_DOXYGEN_ONLY(X)=X " \
2411			 __allocator_base=std::__new_allocator \
2412
2413# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2414# tag can be used to specify a list of macro names that should be expanded. The
2415# macro definition that is found in the sources will be used. Use the PREDEFINED
2416# tag if you want to use a different macro definition that overrules the
2417# definition found in the source code.
2418# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2419
2420EXPAND_AS_DEFINED      =
2421
2422# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2423# remove all references to function-like macros that are alone on a line, have
2424# an all uppercase name, and do not end with a semicolon. Such function macros
2425# are typically used for boiler-plate code, and will confuse the parser if not
2426# removed.
2427# The default value is: YES.
2428# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2429
2430SKIP_FUNCTION_MACROS   = YES
2431
2432#---------------------------------------------------------------------------
2433# Configuration options related to external references
2434#---------------------------------------------------------------------------
2435
2436# The TAGFILES tag can be used to specify one or more tag files. For each tag
2437# file the location of the external documentation should be added. The format of
2438# a tag file without this location is as follows:
2439# TAGFILES = file1 file2 ...
2440# Adding location for the tag files is done as follows:
2441# TAGFILES = file1=loc1 "file2 = loc2" ...
2442# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2443# section "Linking to external documentation" for more information about the use
2444# of tag files.
2445# Note: Each tag file must have a unique name (where the name does NOT include
2446# the path). If a tag file is not located in the directory in which doxygen is
2447# run, you must also specify the path to the tagfile here.
2448
2449TAGFILES               =
2450
2451# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2452# tag file that is based on the input files it reads. See section "Linking to
2453# external documentation" for more information about the usage of tag files.
2454
2455GENERATE_TAGFILE       = @generate_tagfile@
2456
2457# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2458# the class index. If set to NO, only the inherited external classes will be
2459# listed.
2460# The default value is: NO.
2461
2462ALLEXTERNALS           = YES
2463
2464# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2465# in the modules index. If set to NO, only the current project's groups will be
2466# listed.
2467# The default value is: YES.
2468
2469EXTERNAL_GROUPS        = YES
2470
2471# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2472# the related pages index. If set to NO, only the current project's pages will
2473# be listed.
2474# The default value is: YES.
2475
2476EXTERNAL_PAGES         = YES
2477
2478#---------------------------------------------------------------------------
2479# Configuration options related to the dot tool
2480#---------------------------------------------------------------------------
2481
2482# You can include diagrams made with dia in doxygen documentation. Doxygen will
2483# then run dia to produce the diagram and insert it in the documentation. The
2484# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2485# If left empty dia is assumed to be found in the default search path.
2486
2487DIA_PATH               =
2488
2489# If set to YES the inheritance and collaboration graphs will hide inheritance
2490# and usage relations if the target is undocumented or is not a class.
2491# The default value is: YES.
2492
2493HIDE_UNDOC_RELATIONS   = NO
2494
2495# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2496# available from the path. This tool is part of Graphviz (see:
2497# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2498# Bell Labs. The other options in this section have no effect if this option is
2499# set to NO
2500# The default value is: NO.
2501
2502HAVE_DOT               = YES
2503
2504# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2505# to run in parallel. When set to 0 doxygen will base this on the number of
2506# processors available in the system. You can set it explicitly to a value
2507# larger than 0 to get control over the balance between CPU load and processing
2508# speed.
2509# Minimum value: 0, maximum value: 32, default value: 0.
2510# This tag requires that the tag HAVE_DOT is set to YES.
2511
2512DOT_NUM_THREADS        = 0
2513
2514# When you want a differently looking font in the dot files that doxygen
2515# generates you can specify the font name using DOT_FONTNAME. You need to make
2516# sure dot is able to find the font, which can be done by putting it in a
2517# standard location or by setting the DOTFONTPATH environment variable or by
2518# setting DOT_FONTPATH to the directory containing the font.
2519# The default value is: Helvetica.
2520# This tag requires that the tag HAVE_DOT is set to YES.
2521
2522DOT_FONTNAME           =
2523
2524# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2525# dot graphs.
2526# Minimum value: 4, maximum value: 24, default value: 10.
2527# This tag requires that the tag HAVE_DOT is set to YES.
2528
2529DOT_FONTSIZE           = 9
2530
2531# By default doxygen will tell dot to use the default font as specified with
2532# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2533# the path where dot can find it using this tag.
2534# This tag requires that the tag HAVE_DOT is set to YES.
2535
2536DOT_FONTPATH           =
2537
2538# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2539# each documented class showing the direct and indirect inheritance relations.
2540# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2541# The default value is: YES.
2542# This tag requires that the tag HAVE_DOT is set to YES.
2543
2544CLASS_GRAPH            = YES
2545
2546# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2547# graph for each documented class showing the direct and indirect implementation
2548# dependencies (inheritance, containment, and class references variables) of the
2549# class with other documented classes.
2550# The default value is: YES.
2551# This tag requires that the tag HAVE_DOT is set to YES.
2552
2553COLLABORATION_GRAPH    = NO
2554
2555# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2556# groups, showing the direct groups dependencies.
2557# The default value is: YES.
2558# This tag requires that the tag HAVE_DOT is set to YES.
2559
2560GROUP_GRAPHS           = YES
2561
2562# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2563# collaboration diagrams in a style similar to the OMG's Unified Modeling
2564# Language.
2565# The default value is: NO.
2566# This tag requires that the tag HAVE_DOT is set to YES.
2567
2568UML_LOOK               = NO
2569
2570# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2571# class node. If there are many fields or methods and many nodes the graph may
2572# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2573# number of items for each type to make the size more manageable. Set this to 0
2574# for no limit. Note that the threshold may be exceeded by 50% before the limit
2575# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2576# but if the number exceeds 15, the total amount of fields shown is limited to
2577# 10.
2578# Minimum value: 0, maximum value: 100, default value: 10.
2579# This tag requires that the tag HAVE_DOT is set to YES.
2580
2581UML_LIMIT_NUM_FIELDS   = 10
2582
2583# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2584# collaboration graphs will show the relations between templates and their
2585# instances.
2586# The default value is: NO.
2587# This tag requires that the tag HAVE_DOT is set to YES.
2588
2589TEMPLATE_RELATIONS     = NO
2590
2591# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2592# YES then doxygen will generate a graph for each documented file showing the
2593# direct and indirect include dependencies of the file with other documented
2594# files.
2595# The default value is: YES.
2596# This tag requires that the tag HAVE_DOT is set to YES.
2597
2598INCLUDE_GRAPH          = NO
2599
2600# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2601# set to YES then doxygen will generate a graph for each documented file showing
2602# the direct and indirect include dependencies of the file with other documented
2603# files.
2604# The default value is: YES.
2605# This tag requires that the tag HAVE_DOT is set to YES.
2606
2607INCLUDED_BY_GRAPH      = NO
2608
2609# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2610# dependency graph for every global function or class method.
2611#
2612# Note that enabling this option will significantly increase the time of a run.
2613# So in most cases it will be better to enable call graphs for selected
2614# functions only using the \callgraph command. Disabling a call graph can be
2615# accomplished by means of the command \hidecallgraph.
2616# The default value is: NO.
2617# This tag requires that the tag HAVE_DOT is set to YES.
2618
2619CALL_GRAPH             = NO
2620
2621# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2622# dependency graph for every global function or class method.
2623#
2624# Note that enabling this option will significantly increase the time of a run.
2625# So in most cases it will be better to enable caller graphs for selected
2626# functions only using the \callergraph command. Disabling a caller graph can be
2627# accomplished by means of the command \hidecallergraph.
2628# The default value is: NO.
2629# This tag requires that the tag HAVE_DOT is set to YES.
2630
2631CALLER_GRAPH           = NO
2632
2633# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2634# hierarchy of all classes instead of a textual one.
2635# The default value is: YES.
2636# This tag requires that the tag HAVE_DOT is set to YES.
2637
2638GRAPHICAL_HIERARCHY    = YES
2639
2640# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2641# dependencies a directory has on other directories in a graphical way. The
2642# dependency relations are determined by the #include relations between the
2643# files in the directories.
2644# The default value is: YES.
2645# This tag requires that the tag HAVE_DOT is set to YES.
2646
2647DIRECTORY_GRAPH        = NO
2648
2649# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2650# generated by dot. For an explanation of the image formats see the section
2651# output formats in the documentation of the dot tool (Graphviz (see:
2652# http://www.graphviz.org/)).
2653# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2654# to make the SVG files visible in IE 9+ (other browsers do not have this
2655# requirement).
2656# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
2657# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2658# png:gdiplus:gdiplus.
2659# The default value is: png.
2660# This tag requires that the tag HAVE_DOT is set to YES.
2661
2662DOT_IMAGE_FORMAT       = svg
2663
2664# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2665# enable generation of interactive SVG images that allow zooming and panning.
2666#
2667# Note that this requires a modern browser other than Internet Explorer. Tested
2668# and working are Firefox, Chrome, Safari, and Opera.
2669# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2670# the SVG files visible. Older versions of IE do not have SVG support.
2671# The default value is: NO.
2672# This tag requires that the tag HAVE_DOT is set to YES.
2673
2674INTERACTIVE_SVG        = YES
2675
2676# The DOT_PATH tag can be used to specify the path where the dot tool can be
2677# found. If left blank, it is assumed the dot tool can be found in the path.
2678# This tag requires that the tag HAVE_DOT is set to YES.
2679
2680DOT_PATH               =
2681
2682# The DOTFILE_DIRS tag can be used to specify one or more directories that
2683# contain dot files that are included in the documentation (see the \dotfile
2684# command).
2685# This tag requires that the tag HAVE_DOT is set to YES.
2686
2687DOTFILE_DIRS           =
2688
2689# The MSCFILE_DIRS tag can be used to specify one or more directories that
2690# contain msc files that are included in the documentation (see the \mscfile
2691# command).
2692
2693MSCFILE_DIRS           =
2694
2695# The DIAFILE_DIRS tag can be used to specify one or more directories that
2696# contain dia files that are included in the documentation (see the \diafile
2697# command).
2698
2699DIAFILE_DIRS           =
2700
2701# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2702# path where java can find the plantuml.jar file. If left blank, it is assumed
2703# PlantUML is not used or called during a preprocessing step. Doxygen will
2704# generate a warning when it encounters a \startuml command in this case and
2705# will not generate output for the diagram.
2706
2707PLANTUML_JAR_PATH      =
2708
2709# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2710# configuration file for plantuml.
2711
2712PLANTUML_CFG_FILE      =
2713
2714# When using plantuml, the specified paths are searched for files specified by
2715# the !include statement in a plantuml block.
2716
2717PLANTUML_INCLUDE_PATH  =
2718
2719# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2720# that will be shown in the graph. If the number of nodes in a graph becomes
2721# larger than this value, doxygen will truncate the graph, which is visualized
2722# by representing a node as a red box. Note that doxygen if the number of direct
2723# children of the root node in a graph is already larger than
2724# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2725# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2726# Minimum value: 0, maximum value: 10000, default value: 50.
2727# This tag requires that the tag HAVE_DOT is set to YES.
2728
2729DOT_GRAPH_MAX_NODES    = 50
2730
2731# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2732# generated by dot. A depth value of 3 means that only nodes reachable from the
2733# root by following a path via at most 3 edges will be shown. Nodes that lay
2734# further from the root node will be omitted. Note that setting this option to 1
2735# or 2 may greatly reduce the computation time needed for large code bases. Also
2736# note that the size of a graph can be further restricted by
2737# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2738# Minimum value: 0, maximum value: 1000, default value: 0.
2739# This tag requires that the tag HAVE_DOT is set to YES.
2740
2741MAX_DOT_GRAPH_DEPTH    = 0
2742
2743# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2744# background. This is disabled by default, because dot on Windows does not seem
2745# to support this out of the box.
2746#
2747# Warning: Depending on the platform used, enabling this option may lead to
2748# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2749# read).
2750# The default value is: NO.
2751# This tag requires that the tag HAVE_DOT is set to YES.
2752
2753DOT_TRANSPARENT        = NO
2754
2755# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2756# files in one run (i.e. multiple -o and -T options on the command line). This
2757# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2758# this, this feature is disabled by default.
2759# The default value is: NO.
2760# This tag requires that the tag HAVE_DOT is set to YES.
2761
2762DOT_MULTI_TARGETS      = YES
2763
2764# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2765# explaining the meaning of the various boxes and arrows in the dot generated
2766# graphs.
2767# The default value is: YES.
2768# This tag requires that the tag HAVE_DOT is set to YES.
2769
2770GENERATE_LEGEND        = YES
2771
2772# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2773# files that are used to generate the various graphs.
2774# The default value is: YES.
2775# This tag requires that the tag HAVE_DOT is set to YES.
2776
2777DOT_CLEANUP            = YES
2778