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