blob: bcf0af75a18fa23863d9d4e5a4808bf388afe578 [file] [log] [blame]
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001# Doxyfile 1.9.3
John Koleszar0ea50ce2010-05-18 11:58:33 -04002
3# This file describes the settings to be used by the documentation system
Yunqing Wangda924eb2020-05-01 16:34:11 -07004# doxygen (www.doxygen.org) for a project.
John Koleszar0ea50ce2010-05-18 11:58:33 -04005#
Yunqing Wangda924eb2020-05-01 16:34:11 -07006# 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.
John Koleszar0ea50ce2010-05-18 11:58:33 -040010# The format is:
Yunqing Wangda924eb2020-05-01 16:34:11 -070011# 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 (\" \").
John Koleszar0ea50ce2010-05-18 11:58:33 -040015
16#---------------------------------------------------------------------------
17# Project related configuration options
18#---------------------------------------------------------------------------
19
Yunqing Wangda924eb2020-05-01 16:34:11 -070020# This tag specifies the encoding used for all characters in the configuration
21# file that follow. The default is UTF-8 which is also the encoding used for all
22# text before the first occurrence of this tag. Doxygen uses libiconv (or the
23# iconv built into libc) for the transcoding. See
24# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
25# The default value is: UTF-8.
John Koleszar0ea50ce2010-05-18 11:58:33 -040026
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -070027## Copyright (c) 2021, Alliance for Open Media. All rights reserved
28##
29## This source code is subject to the terms of the BSD 3-Clause Clear License and the
30## Alliance for Open Media Patent License 1.0. If the BSD 3-Clause Clear License was
31## not distributed with this source code in the LICENSE file, you can obtain it
32## at aomedia.org/license/software-license/bsd-3-c-c/. If the Alliance for Open Media Patent
33## License 1.0 was not distributed with this source code in the PATENTS file, you
34## can obtain it at aomedia.org/license/patent-license/.
35##
36
John Koleszar0ea50ce2010-05-18 11:58:33 -040037DOXYFILE_ENCODING = UTF-8
38
Yunqing Wangda924eb2020-05-01 16:34:11 -070039# 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.
John Koleszar0ea50ce2010-05-18 11:58:33 -040044
Yunqing Wang0fd27732020-05-04 14:48:28 -070045PROJECT_NAME = "AOMedia AV1 Codec"
John Koleszar0ea50ce2010-05-18 11:58:33 -040046
Yunqing Wangda924eb2020-05-01 16:34:11 -070047# 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 =
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.
John Koleszar0ea50ce2010-05-18 11:58:33 -040070
71OUTPUT_DIRECTORY = docs
72
Yunqing Wangda924eb2020-05-01 16:34:11 -070073# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
74# directories (in 2 levels) under the output directory of each output format and
75# will distribute the generated files over these directories. Enabling this
76# 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
78# performance problems for the file system.
79# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -040080
81CREATE_SUBDIRS = NO
82
Yunqing Wangda924eb2020-05-01 16:34:11 -070083# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
84# characters to appear in the names of generated files. If set to NO, non-ASCII
85# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
86# U+3044.
87# The default value is: NO.
88
89ALLOW_UNICODE_NAMES = NO
90
John Koleszar0ea50ce2010-05-18 11:58:33 -040091# The OUTPUT_LANGUAGE tag is used to specify the language in which all
92# documentation generated by doxygen is written. Doxygen will use this
93# information to generate all constant output in the proper language.
Yunqing Wangda924eb2020-05-01 16:34:11 -070094# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
95# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
96# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
97# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
98# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
99# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
100# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
101# Ukrainian and Vietnamese.
102# The default value is: English.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400103
104OUTPUT_LANGUAGE = English
105
Yunqing Wangda924eb2020-05-01 16:34:11 -0700106# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
107# descriptions after the members that are listed in the file and class
108# documentation (similar to Javadoc). Set to NO to disable this.
109# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400110
111BRIEF_MEMBER_DESC = YES
112
Yunqing Wangda924eb2020-05-01 16:34:11 -0700113# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
114# description of a member or function before the detailed description
115#
116# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
John Koleszar0ea50ce2010-05-18 11:58:33 -0400117# brief descriptions will be completely suppressed.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700118# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400119
120REPEAT_BRIEF = YES
121
Yunqing Wangda924eb2020-05-01 16:34:11 -0700122# This tag implements a quasi-intelligent brief description abbreviator that is
123# used to form the text in various listings. Each string in this list, if found
124# as the leading text of the brief description, will be stripped from the text
125# and the result, after processing the whole list, is used as the annotated
126# text. Otherwise, the brief description is used as-is. If left blank, the
127# following values are used ($name is automatically replaced with the name of
128# the entity):The $name class, The $name widget, The $name file, is, provides,
129# specifies, contains, represents, a, an and the.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400130
131ABBREVIATE_BRIEF =
132
133# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
Yunqing Wangda924eb2020-05-01 16:34:11 -0700134# doxygen will generate a detailed section even if there is only a brief
John Koleszar0ea50ce2010-05-18 11:58:33 -0400135# description.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700136# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400137
138ALWAYS_DETAILED_SEC = NO
139
140# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
141# inherited members of a class in the documentation of that class as if those
142# members were ordinary class members. Constructors, destructors and assignment
143# operators of the base classes will not be shown.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700144# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400145
146INLINE_INHERITED_MEMB = NO
147
Yunqing Wangda924eb2020-05-01 16:34:11 -0700148# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
149# before files name in the file list and in the header files. If set to NO the
150# shortest path that makes the file name unique will be used
151# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400152
153FULL_PATH_NAMES = YES
154
Yunqing Wangda924eb2020-05-01 16:34:11 -0700155# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
156# Stripping is only done if one of the specified strings matches the left-hand
157# part of the path. The tag can be used to show relative paths in the file list.
158# If left blank the directory from which doxygen is run is used as the path to
159# strip.
160#
161# Note that you can specify absolute paths here, but also relative paths, which
162# will be relative from the directory where doxygen is started.
163# This tag requires that the tag FULL_PATH_NAMES is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400164
165STRIP_FROM_PATH =
166
Yunqing Wangda924eb2020-05-01 16:34:11 -0700167# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
168# path mentioned in the documentation of a class, which tells the reader which
169# header file to include in order to use a class. If left blank only the name of
170# the header file containing the class definition is used. Otherwise one should
171# specify the list of include paths that are normally passed to the compiler
172# using the -I flag.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400173
174STRIP_FROM_INC_PATH =
175
Yunqing Wangda924eb2020-05-01 16:34:11 -0700176# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
177# less readable) file names. This can be useful is your file systems doesn't
178# support long names like on DOS, Mac, or CD-ROM.
179# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400180
181SHORT_NAMES = NO
182
Yunqing Wangda924eb2020-05-01 16:34:11 -0700183# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
184# first line (until the first dot) of a Javadoc-style comment as the brief
185# description. If set to NO, the Javadoc-style will behave just like regular Qt-
186# style comments (thus requiring an explicit @brief command for a brief
187# description.)
188# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400189
190JAVADOC_AUTOBRIEF = NO
191
Yunqing Wangda924eb2020-05-01 16:34:11 -0700192# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
193# such as
194# /***************
195# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
196# Javadoc-style will behave just like regular comments and it will not be
197# interpreted by doxygen.
198# The default value is: NO.
199
200JAVADOC_BANNER = NO
201
202# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
203# line (until the first dot) of a Qt-style comment as the brief description. If
204# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
205# requiring an explicit \brief command for a brief description.)
206# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400207
208QT_AUTOBRIEF = NO
209
Yunqing Wangda924eb2020-05-01 16:34:11 -0700210# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
211# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
212# a brief description. This used to be the default behavior. The new default is
213# to treat a multi-line C++ comment block as a detailed description. Set this
214# tag to YES if you prefer the old behavior instead.
215#
216# Note that setting this tag to YES also means that rational rose comments are
217# not recognized any more.
218# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400219
220MULTILINE_CPP_IS_BRIEF = NO
221
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -0700222# By default Python docstrings are displayed as preformatted text and doxygen's
223# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
224# doxygen's special commands can be used and the contents of the docstring
225# documentation blocks is shown as doxygen documentation.
226# The default value is: YES.
227
228PYTHON_DOCSTRING = YES
229
Yunqing Wangda924eb2020-05-01 16:34:11 -0700230# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
231# documentation from any documented member that it re-implements.
232# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400233
234INHERIT_DOCS = YES
235
Yunqing Wangda924eb2020-05-01 16:34:11 -0700236# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
237# page for each member. If set to NO, the documentation of a member will be part
238# of the file/class/namespace that contains it.
239# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400240
241SEPARATE_MEMBER_PAGES = NO
242
Yunqing Wangda924eb2020-05-01 16:34:11 -0700243# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
244# uses this value to replace tabs by spaces in code fragments.
245# Minimum value: 1, maximum value: 16, default value: 4.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400246
247TAB_SIZE = 4
248
Yunqing Wangda924eb2020-05-01 16:34:11 -0700249# This tag can be used to specify a number of aliases that act as commands in
250# the documentation. An alias has the form:
251# name=value
252# For example adding
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -0700253# "sideeffect=@par Side Effects:^^"
Yunqing Wangda924eb2020-05-01 16:34:11 -0700254# will allow you to put the command \sideeffect (or @sideeffect) in the
255# documentation, which will result in a user-defined paragraph with heading
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -0700256# "Side Effects:". Note that you cannot put \n's in the value part of an alias
257# to insert newlines (in the resulting output). You can put ^^ in the value part
258# of an alias to insert a newline as if a physical newline was in the original
259# file. When you need a literal { or } or , in the value part of an alias you
260# have to escape them by means of a backslash (\), this can lead to conflicts
261# with the commands \{ and \} for these it is advised to use the version @{ and
262# @} or use a double escape (\\{ and \\})
John Koleszar0ea50ce2010-05-18 11:58:33 -0400263
264ALIASES =
265
Yunqing Wangda924eb2020-05-01 16:34:11 -0700266# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
267# only. Doxygen will then generate output that is more tailored for C. For
268# instance, some of the names that are used will be different. The list of all
269# members will be omitted, etc.
270# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400271
272OPTIMIZE_OUTPUT_FOR_C = YES
273
Yunqing Wangda924eb2020-05-01 16:34:11 -0700274# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
275# Python sources only. Doxygen will then generate output that is more tailored
276# for that language. For instance, namespaces will be presented as packages,
277# qualified scopes will look different, etc.
278# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400279
280OPTIMIZE_OUTPUT_JAVA = NO
281
Yunqing Wangda924eb2020-05-01 16:34:11 -0700282# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
283# sources. Doxygen will then generate output that is tailored for Fortran.
284# The default value is: NO.
285
286OPTIMIZE_FOR_FORTRAN = NO
287
288# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
289# sources. Doxygen will then generate output that is tailored for VHDL.
290# The default value is: NO.
291
292OPTIMIZE_OUTPUT_VHDL = NO
293
294# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
295# sources only. Doxygen will then generate output that is more tailored for that
296# language. For instance, namespaces will be presented as modules, types will be
297# separated into more groups, etc.
298# The default value is: NO.
299
300OPTIMIZE_OUTPUT_SLICE = NO
301
302# Doxygen selects the parser to use depending on the extension of the files it
303# parses. With this tag you can assign which parser to use for a given
304# extension. Doxygen has a built-in mapping, but you can override or extend it
305# using this tag. The format is ext=language, where ext is a file extension, and
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -0700306# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
307# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
308# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
Yunqing Wangda924eb2020-05-01 16:34:11 -0700309# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
310# tries to guess whether the code is fixed or free formatted code, this is the
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -0700311# default for Fortran type files). For instance to make doxygen treat .inc files
312# as Fortran files (default is PHP), and .f files as C (default is Fortran),
313# use: inc=Fortran f=C.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700314#
315# Note: For files without extension you can use no_extension as a placeholder.
316#
317# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -0700318# the files are not read by doxygen. When specifying no_extension you should add
319# * to the FILE_PATTERNS.
320#
321# Note see also the list of default file extension mappings.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700322
323EXTENSION_MAPPING =
324
325# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
326# according to the Markdown format, which allows for more readable
327# documentation. See https://daringfireball.net/projects/markdown/ for details.
328# The output of markdown processing is further processed by doxygen, so you can
329# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
330# case of backward compatibilities issues.
331# The default value is: YES.
332
333MARKDOWN_SUPPORT = YES
334
335# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
336# to that level are automatically included in the table of contents, even if
337# they do not have an id attribute.
338# Note: This feature currently applies only to Markdown headings.
339# Minimum value: 0, maximum value: 99, default value: 5.
340# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
341
342TOC_INCLUDE_HEADINGS = 5
343
344# When enabled doxygen tries to link words that correspond to documented
345# classes, or namespaces to their corresponding documentation. Such a link can
346# be prevented in individual cases by putting a % sign in front of the word or
347# globally by setting AUTOLINK_SUPPORT to NO.
348# The default value is: YES.
349
350AUTOLINK_SUPPORT = YES
351
352# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
353# to include (a tag file for) the STL sources as input, then you should set this
354# tag to YES in order to let doxygen match functions declarations and
355# definitions whose arguments contain STL classes (e.g. func(std::string);
356# versus func(std::string) {}). This also make the inheritance and collaboration
John Koleszar0ea50ce2010-05-18 11:58:33 -0400357# diagrams that involve STL classes more complete and accurate.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700358# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400359
360BUILTIN_STL_SUPPORT = NO
361
362# If you use Microsoft's C++/CLI language, you should set this option to YES to
363# enable parsing support.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700364# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400365
366CPP_CLI_SUPPORT = NO
367
Yunqing Wangda924eb2020-05-01 16:34:11 -0700368# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
369# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
370# will parse them like normal C++ but will assume all classes use public instead
371# of private inheritance when no explicit protection keyword is present.
372# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400373
374SIP_SUPPORT = NO
375
Yunqing Wangda924eb2020-05-01 16:34:11 -0700376# For Microsoft's IDL there are propget and propput attributes to indicate
377# getter and setter methods for a property. Setting this option to YES will make
378# doxygen to replace the get and set methods by a property in the documentation.
379# This will only work if the methods are indeed getting or setting a simple
380# type. If this is not the case, or you want to show the methods anyway, you
381# should set this option to NO.
382# The default value is: YES.
383
384IDL_PROPERTY_SUPPORT = YES
385
John Koleszar0ea50ce2010-05-18 11:58:33 -0400386# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
Yunqing Wangda924eb2020-05-01 16:34:11 -0700387# tag is set to YES then doxygen will reuse the documentation of the first
John Koleszar0ea50ce2010-05-18 11:58:33 -0400388# member in the group (if any) for the other members of the group. By default
389# all members of a group must be documented explicitly.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700390# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400391
392DISTRIBUTE_GROUP_DOC = NO
393
Yunqing Wangda924eb2020-05-01 16:34:11 -0700394# If one adds a struct or class to a group and this option is enabled, then also
395# any nested class or struct is added to the same group. By default this option
396# is disabled and one has to add nested compounds explicitly via \ingroup.
397# The default value is: NO.
398
399GROUP_NESTED_COMPOUNDS = NO
400
401# Set the SUBGROUPING tag to YES to allow class member groups of the same type
402# (for instance a group of public functions) to be put as a subgroup of that
403# type (e.g. under the Public Functions section). Set it to NO to prevent
404# subgrouping. Alternatively, this can be done per class using the
405# \nosubgrouping command.
406# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400407
408SUBGROUPING = YES
409
Yunqing Wangda924eb2020-05-01 16:34:11 -0700410# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
411# are shown inside the group in which they are included (e.g. using \ingroup)
412# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
413# and RTF).
414#
415# Note that this feature does not work in combination with
416# SEPARATE_MEMBER_PAGES.
417# The default value is: NO.
418
419INLINE_GROUPED_CLASSES = NO
420
421# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
422# with only public data fields or simple typedef fields will be shown inline in
423# the documentation of the scope in which they are defined (i.e. file,
424# namespace, or group documentation), provided this scope is documented. If set
425# to NO, structs, classes, and unions are shown on a separate page (for HTML and
426# Man pages) or section (for LaTeX and RTF).
427# The default value is: NO.
428
429INLINE_SIMPLE_STRUCTS = NO
430
431# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
432# enum is documented as struct, union, or enum with the name of the typedef. So
433# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
434# with name TypeT. When disabled the typedef will appear as a member of a file,
435# namespace, or class. And the struct will be named TypeS. This can typically be
436# useful for C code in case the coding convention dictates that all compound
437# types are typedef'ed and only the typedef is referenced, never the tag name.
438# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400439
440TYPEDEF_HIDES_STRUCT = NO
441
Yunqing Wangda924eb2020-05-01 16:34:11 -0700442# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
443# cache is used to resolve symbols given their name and scope. Since this can be
444# an expensive process and often the same symbol appears multiple times in the
445# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
446# doxygen will become slower. If the cache is too large, memory is wasted. The
447# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
448# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
449# symbols. At the end of a run doxygen will report the cache usage and suggest
450# the optimal cache size from a speed point of view.
451# Minimum value: 0, maximum value: 9, default value: 0.
452
453LOOKUP_CACHE_SIZE = 0
454
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -0700455# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use
456# during processing. When set to 0 doxygen will based this on the number of
457# cores available in the system. You can set it explicitly to a value larger
458# than 0 to get more control over the balance between CPU load and processing
459# speed. At this moment only the input processing can be done using multiple
460# threads. Since this is still an experimental feature the default is set to 1,
461# which effectively disables parallel processing. Please report any issues you
462# encounter. Generating dot graphs in parallel is controlled by the
463# DOT_NUM_THREADS setting.
464# Minimum value: 0, maximum value: 32, default value: 1.
465
466NUM_PROC_THREADS = 1
467
John Koleszar0ea50ce2010-05-18 11:58:33 -0400468#---------------------------------------------------------------------------
469# Build related configuration options
470#---------------------------------------------------------------------------
471
Yunqing Wangda924eb2020-05-01 16:34:11 -0700472# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
473# documentation are documented, even if no documentation was available. Private
474# class members and static file members will be hidden unless the
475# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
476# Note: This will also disable the warnings about undocumented members that are
477# normally produced when WARNINGS is set to YES.
478# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400479
480EXTRACT_ALL = NO
481
Yunqing Wangda924eb2020-05-01 16:34:11 -0700482# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
483# be included in the documentation.
484# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400485
486EXTRACT_PRIVATE = NO
487
Yunqing Wangda924eb2020-05-01 16:34:11 -0700488# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
489# methods of a class will be included in the documentation.
490# The default value is: NO.
491
492EXTRACT_PRIV_VIRTUAL = NO
493
494# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
495# scope will be included in the documentation.
496# The default value is: NO.
497
498EXTRACT_PACKAGE = NO
499
500# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
501# included in the documentation.
502# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400503
Yue Chen18491742020-06-08 11:54:41 -0700504EXTRACT_STATIC = YES
John Koleszar0ea50ce2010-05-18 11:58:33 -0400505
Yunqing Wangda924eb2020-05-01 16:34:11 -0700506# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
507# locally in source files will be included in the documentation. If set to NO,
508# only classes defined in header files are included. Does not have any effect
509# for Java sources.
510# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400511
512EXTRACT_LOCAL_CLASSES = YES
513
Yunqing Wangda924eb2020-05-01 16:34:11 -0700514# This flag is only useful for Objective-C code. If set to YES, local methods,
515# which are defined in the implementation section but not in the interface are
516# included in the documentation. If set to NO, only methods in the interface are
517# included.
518# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400519
520EXTRACT_LOCAL_METHODS = NO
521
Yunqing Wangda924eb2020-05-01 16:34:11 -0700522# If this flag is set to YES, the members of anonymous namespaces will be
523# extracted and appear in the documentation as a namespace called
524# 'anonymous_namespace{file}', where file will be replaced with the base name of
525# the file that contains the anonymous namespace. By default anonymous namespace
526# are hidden.
527# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400528
529EXTRACT_ANON_NSPACES = NO
530
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -0700531# If this flag is set to YES, the name of an unnamed parameter in a declaration
532# will be determined by the corresponding definition. By default unnamed
533# parameters remain unnamed in the output.
534# The default value is: YES.
535
536RESOLVE_UNNAMED_PARAMS = YES
537
Yunqing Wangda924eb2020-05-01 16:34:11 -0700538# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
539# undocumented members inside documented classes or files. If set to NO these
540# members will be included in the various overviews, but no documentation
541# section is generated. This option has no effect if EXTRACT_ALL is enabled.
542# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400543
544HIDE_UNDOC_MEMBERS = NO
545
Yunqing Wangda924eb2020-05-01 16:34:11 -0700546# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
547# undocumented classes that are normally visible in the class hierarchy. If set
548# to NO, these classes will be included in the various overviews. This option
549# has no effect if EXTRACT_ALL is enabled.
550# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400551
552HIDE_UNDOC_CLASSES = NO
553
Yunqing Wangda924eb2020-05-01 16:34:11 -0700554# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -0700555# declarations. If set to NO, these declarations will be included in the
556# documentation.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700557# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400558
559HIDE_FRIEND_COMPOUNDS = NO
560
Yunqing Wangda924eb2020-05-01 16:34:11 -0700561# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
562# documentation blocks found inside the body of a function. If set to NO, these
563# blocks will be appended to the function's detailed documentation block.
564# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400565
566HIDE_IN_BODY_DOCS = NO
567
Yunqing Wangda924eb2020-05-01 16:34:11 -0700568# The INTERNAL_DOCS tag determines if documentation that is typed after a
569# \internal command is included. If the tag is set to NO then the documentation
570# will be excluded. Set it to YES to include the internal documentation.
571# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400572
573INTERNAL_DOCS = NO
574
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -0700575# With the correct setting of option CASE_SENSE_NAMES doxygen will better be
576# able to match the capabilities of the underlying filesystem. In case the
577# filesystem is case sensitive (i.e. it supports files in the same directory
578# whose names only differ in casing), the option must be set to YES to properly
579# deal with such files in case they appear in the input. For filesystems that
580# are not case sensitive the option should be be set to NO to properly deal with
581# output files written for symbols that only differ in casing, such as for two
582# classes, one named CLASS and the other named Class, and to also support
583# references to files without having to specify the exact matching casing. On
584# Windows (including Cygwin) and MacOS, users should typically set this option
585# to NO, whereas on Linux or other Unix flavors it should typically be set to
586# YES.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700587# The default value is: system dependent.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400588
589CASE_SENSE_NAMES = YES
590
Yunqing Wangda924eb2020-05-01 16:34:11 -0700591# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
592# their full class and namespace scopes in the documentation. If set to YES, the
593# scope will be hidden.
594# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400595
596HIDE_SCOPE_NAMES = NO
597
Yunqing Wangda924eb2020-05-01 16:34:11 -0700598# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
599# append additional text to a page's title, such as Class Reference. If set to
600# YES the compound reference will be hidden.
601# The default value is: NO.
602
603HIDE_COMPOUND_REFERENCE= NO
604
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -0700605# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
606# will show which file needs to be included to use the class.
607# The default value is: YES.
608
609SHOW_HEADERFILE = YES
610
Yunqing Wangda924eb2020-05-01 16:34:11 -0700611# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
612# the files that are included by a file in the documentation of that file.
613# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400614
615SHOW_INCLUDE_FILES = YES
616
Yunqing Wangda924eb2020-05-01 16:34:11 -0700617# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
618# grouped member an include statement to the documentation, telling the reader
619# which file to include in order to use the member.
620# The default value is: NO.
621
622SHOW_GROUPED_MEMB_INC = NO
623
624# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
625# files with double quotes in the documentation rather than with sharp brackets.
626# The default value is: NO.
627
628FORCE_LOCAL_INCLUDES = NO
629
630# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
631# documentation for inline members.
632# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400633
634INLINE_INFO = YES
635
Yunqing Wangda924eb2020-05-01 16:34:11 -0700636# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
637# (detailed) documentation of file and class members alphabetically by member
638# name. If set to NO, the members will appear in declaration order.
639# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400640
641SORT_MEMBER_DOCS = NO
642
Yunqing Wangda924eb2020-05-01 16:34:11 -0700643# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
644# descriptions of file, namespace and class members alphabetically by member
645# name. If set to NO, the members will appear in declaration order. Note that
646# this will also influence the order of the classes in the class list.
647# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400648
649SORT_BRIEF_DOCS = NO
650
Yunqing Wangda924eb2020-05-01 16:34:11 -0700651# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
652# (brief and detailed) documentation of class members so that constructors and
653# destructors are listed first. If set to NO the constructors will appear in the
654# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
655# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
656# member documentation.
657# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
658# detailed member documentation.
659# The default value is: NO.
660
661SORT_MEMBERS_CTORS_1ST = NO
662
663# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
664# of group names into alphabetical order. If set to NO the group names will
665# appear in their defined order.
666# The default value is: NO.
667
668SORT_GROUP_NAMES = NO
669
670# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
671# fully-qualified names, including namespaces. If set to NO, the class list will
672# be sorted only by class name, not including the namespace part.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400673# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700674# Note: This option applies only to the class list, not to the alphabetical
675# list.
676# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400677
678SORT_BY_SCOPE_NAME = NO
679
Yunqing Wangda924eb2020-05-01 16:34:11 -0700680# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
681# type resolution of all parameters of a function it will reject a match between
682# the prototype and the implementation of a member function even if there is
683# only one candidate or it is obvious which candidate to choose by doing a
684# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
685# accept a match between prototype and implementation in such cases.
686# The default value is: NO.
687
688STRICT_PROTO_MATCHING = NO
689
690# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
691# list. This list is created by putting \todo commands in the documentation.
692# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400693
694GENERATE_TODOLIST = YES
695
Yunqing Wangda924eb2020-05-01 16:34:11 -0700696# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
697# list. This list is created by putting \test commands in the documentation.
698# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400699
700GENERATE_TESTLIST = YES
701
Yunqing Wangda924eb2020-05-01 16:34:11 -0700702# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
703# list. This list is created by putting \bug commands in the documentation.
704# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400705
706GENERATE_BUGLIST = YES
707
Yunqing Wangda924eb2020-05-01 16:34:11 -0700708# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
709# the deprecated list. This list is created by putting \deprecated commands in
710# the documentation.
711# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400712
713GENERATE_DEPRECATEDLIST= YES
714
Yunqing Wangda924eb2020-05-01 16:34:11 -0700715# The ENABLED_SECTIONS tag can be used to enable conditional documentation
716# sections, marked by \if <section_label> ... \endif and \cond <section_label>
717# ... \endcond blocks.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400718
719ENABLED_SECTIONS =
720
Yunqing Wangda924eb2020-05-01 16:34:11 -0700721# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
722# initial value of a variable or macro / define can have for it to appear in the
723# documentation. If the initializer consists of more lines than specified here
724# it will be hidden. Use a value of 0 to hide initializers completely. The
725# appearance of the value of individual variables and macros / defines can be
726# controlled using \showinitializer or \hideinitializer command in the
727# documentation regardless of this setting.
728# Minimum value: 0, maximum value: 10000, default value: 30.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400729
730MAX_INITIALIZER_LINES = 30
731
Yunqing Wangda924eb2020-05-01 16:34:11 -0700732# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
733# the bottom of the documentation of classes and structs. If set to YES, the
John Koleszar0ea50ce2010-05-18 11:58:33 -0400734# list will mention the files that were used to generate the documentation.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700735# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400736
737SHOW_USED_FILES = YES
738
Yunqing Wangda924eb2020-05-01 16:34:11 -0700739# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
740# will remove the Files entry from the Quick Index and from the Folder Tree View
741# (if specified).
742# The default value is: YES.
743
744SHOW_FILES = YES
745
746# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
747# page. This will remove the Namespaces entry from the Quick Index and from the
748# Folder Tree View (if specified).
749# The default value is: YES.
750
751SHOW_NAMESPACES = YES
752
John Koleszar0ea50ce2010-05-18 11:58:33 -0400753# The FILE_VERSION_FILTER tag can be used to specify a program or script that
Yunqing Wangda924eb2020-05-01 16:34:11 -0700754# doxygen should invoke to get the current version for each file (typically from
755# the version control system). Doxygen will invoke the program by executing (via
756# popen()) the command command input-file, where command is the value of the
757# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
758# by doxygen. Whatever the program writes to standard output is used as the file
759# version. For an example see the documentation.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400760
761FILE_VERSION_FILTER =
762
Yunqing Wangda924eb2020-05-01 16:34:11 -0700763# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
764# by doxygen. The layout file controls the global structure of the generated
765# output files in an output format independent way. To create the layout file
766# that represents doxygen's defaults, run doxygen with the -l option. You can
767# optionally specify a file name after the option, if omitted DoxygenLayout.xml
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -0700768# will be used as the name of the layout file. See also section "Changing the
769# layout of pages" for information.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700770#
771# Note that if you run doxygen from a directory containing a file called
772# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
773# tag is left empty.
774
775LAYOUT_FILE =
776
777# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
778# the reference definitions. This must be a list of .bib files. The .bib
779# extension is automatically appended if omitted. This requires the bibtex tool
780# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
781# For LaTeX the style of the bibliography can be controlled using
782# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
783# search path. See also \cite for info how to create references.
784
785CITE_BIB_FILES =
786
John Koleszar0ea50ce2010-05-18 11:58:33 -0400787#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -0700788# Configuration options related to warning and progress messages
John Koleszar0ea50ce2010-05-18 11:58:33 -0400789#---------------------------------------------------------------------------
790
Yunqing Wangda924eb2020-05-01 16:34:11 -0700791# The QUIET tag can be used to turn on/off the messages that are generated to
792# standard output by doxygen. If QUIET is set to YES this implies that the
793# messages are off.
794# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400795
796QUIET = YES
797
798# The WARNINGS tag can be used to turn on/off the warning messages that are
Yunqing Wangda924eb2020-05-01 16:34:11 -0700799# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
800# this implies that the warnings are on.
801#
802# Tip: Turn warnings on while writing the documentation.
803# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400804
805WARNINGS = YES
806
Yunqing Wangda924eb2020-05-01 16:34:11 -0700807# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
808# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
809# will automatically be disabled.
810# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400811
812WARN_IF_UNDOCUMENTED = YES
813
Yunqing Wangda924eb2020-05-01 16:34:11 -0700814# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -0700815# potential errors in the documentation, such as documenting some parameters in
816# a documented function twice, or documenting parameters that don't exist or
817# using markup commands wrongly.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700818# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400819
820WARN_IF_DOC_ERROR = YES
821
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -0700822# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
823# function parameter documentation. If set to NO, doxygen will accept that some
824# parameters have no documentation without warning.
825# The default value is: YES.
826
827WARN_IF_INCOMPLETE_DOC = YES
828
Yunqing Wangda924eb2020-05-01 16:34:11 -0700829# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
830# are documented, but have no documentation for their parameters or return
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -0700831# value. If set to NO, doxygen will only warn about wrong parameter
832# documentation, but not about the absence of documentation. If EXTRACT_ALL is
833# set to YES then this flag will automatically be disabled. See also
834# WARN_IF_INCOMPLETE_DOC
Yunqing Wangda924eb2020-05-01 16:34:11 -0700835# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400836
837WARN_NO_PARAMDOC = NO
838
Yunqing Wangda924eb2020-05-01 16:34:11 -0700839# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -0700840# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
841# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
842# at the end of the doxygen process doxygen will return with a non-zero status.
843# Possible values are: NO, YES and FAIL_ON_WARNINGS.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700844# The default value is: NO.
845
Urvang Joshib3410f82022-02-19 01:24:13 +0000846WARN_AS_ERROR = FAIL_ON_WARNINGS
Yunqing Wangda924eb2020-05-01 16:34:11 -0700847
848# The WARN_FORMAT tag determines the format of the warning messages that doxygen
849# can produce. The string should contain the $file, $line, and $text tags, which
850# will be replaced by the file and line number from which the warning originated
851# and the warning text. Optionally the format may contain $version, which will
852# be replaced by the version of the file (if it could be obtained via
853# FILE_VERSION_FILTER)
854# The default value is: $file:$line: $text.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400855
856WARN_FORMAT = "$file:$line: $text"
857
Yunqing Wangda924eb2020-05-01 16:34:11 -0700858# The WARN_LOGFILE tag can be used to specify a file to which warning and error
859# messages should be written. If left blank the output is written to standard
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -0700860# error (stderr). In case the file specified cannot be opened for writing the
861# warning and error messages are written to standard error. When as file - is
862# specified the warning and error messages are written to standard output
863# (stdout).
John Koleszar0ea50ce2010-05-18 11:58:33 -0400864
865WARN_LOGFILE =
866
867#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -0700868# Configuration options related to the input files
John Koleszar0ea50ce2010-05-18 11:58:33 -0400869#---------------------------------------------------------------------------
870
Yunqing Wangda924eb2020-05-01 16:34:11 -0700871# The INPUT tag is used to specify the files and/or directories that contain
872# documented source files. You may enter file names like myfile.cpp or
873# directories like /usr/src/myproject. Separate the files or directories with
874# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
875# Note: If this tag is empty the current directory is searched.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400876
Yunqing Wangda924eb2020-05-01 16:34:11 -0700877INPUT =
John Koleszar0ea50ce2010-05-18 11:58:33 -0400878
Yunqing Wangda924eb2020-05-01 16:34:11 -0700879# This tag can be used to specify the character encoding of the source files
880# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
881# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -0700882# documentation (see:
883# https://www.gnu.org/software/libiconv/) for the list of possible encodings.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700884# The default value is: UTF-8.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400885
886INPUT_ENCODING = UTF-8
887
888# If the value of the INPUT tag contains directories, you can use the
Yunqing Wangda924eb2020-05-01 16:34:11 -0700889# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
890# *.h) to filter out the source-files in the directories.
891#
892# Note that for custom extensions or not directly supported extensions you also
893# need to set EXTENSION_MAPPING for the extension otherwise the files are not
894# read by doxygen.
895#
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -0700896# Note the list of default checked file patterns might differ from the list of
897# default file extension mappings.
898#
Yunqing Wangda924eb2020-05-01 16:34:11 -0700899# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
900# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -0700901# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml,
902# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C
903# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
904# *.vhdl, *.ucf, *.qsf and *.ice.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400905
906FILE_PATTERNS =
907
Yunqing Wangda924eb2020-05-01 16:34:11 -0700908# The RECURSIVE tag can be used to specify whether or not subdirectories should
909# be searched for input files as well.
910# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400911
912RECURSIVE = NO
913
Yunqing Wangda924eb2020-05-01 16:34:11 -0700914# The EXCLUDE tag can be used to specify files and/or directories that should be
John Koleszar0ea50ce2010-05-18 11:58:33 -0400915# excluded from the INPUT source files. This way you can easily exclude a
916# subdirectory from a directory tree whose root is specified with the INPUT tag.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700917#
918# Note that relative paths are relative to the directory from which doxygen is
919# run.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400920
921EXCLUDE =
922
Yunqing Wangda924eb2020-05-01 16:34:11 -0700923# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
924# directories that are symbolic links (a Unix file system feature) are excluded
John Koleszar0ea50ce2010-05-18 11:58:33 -0400925# from the input.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700926# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400927
928EXCLUDE_SYMLINKS = NO
929
930# If the value of the INPUT tag contains directories, you can use the
931# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
Yunqing Wangda924eb2020-05-01 16:34:11 -0700932# certain files from those directories.
933#
934# Note that the wildcards are matched against the file with absolute path, so to
935# exclude all test directories for example use the pattern */test/*
John Koleszar0ea50ce2010-05-18 11:58:33 -0400936
937EXCLUDE_PATTERNS =
938
939# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
Yunqing Wangda924eb2020-05-01 16:34:11 -0700940# (namespaces, classes, functions, etc.) that should be excluded from the
941# output. The symbol name can be a fully qualified name, a word, or if the
942# wildcard * is used, a substring. Examples: ANamespace, AClass,
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -0700943# ANamespace::AClass, ANamespace::*Test
Yunqing Wangda924eb2020-05-01 16:34:11 -0700944#
945# Note that the wildcards are matched against the file with absolute path, so to
946# exclude all test directories use the pattern */test/*
John Koleszar0ea50ce2010-05-18 11:58:33 -0400947
948EXCLUDE_SYMBOLS =
949
Yunqing Wangda924eb2020-05-01 16:34:11 -0700950# The EXAMPLE_PATH tag can be used to specify one or more files or directories
951# that contain example code fragments that are included (see the \include
952# command).
John Koleszar0ea50ce2010-05-18 11:58:33 -0400953
954EXAMPLE_PATH =
955
956# If the value of the EXAMPLE_PATH tag contains directories, you can use the
Yunqing Wangda924eb2020-05-01 16:34:11 -0700957# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
958# *.h) to filter out the source-files in the directories. If left blank all
959# files are included.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400960
961EXAMPLE_PATTERNS =
962
963# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
Yunqing Wangda924eb2020-05-01 16:34:11 -0700964# searched for input files to be used with the \include or \dontinclude commands
965# irrespective of the value of the RECURSIVE tag.
966# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400967
968EXAMPLE_RECURSIVE = NO
969
Yunqing Wangda924eb2020-05-01 16:34:11 -0700970# The IMAGE_PATH tag can be used to specify one or more files or directories
971# that contain images that are to be included in the documentation (see the
972# \image command).
John Koleszar0ea50ce2010-05-18 11:58:33 -0400973
974IMAGE_PATH =
975
976# The INPUT_FILTER tag can be used to specify a program that doxygen should
977# invoke to filter for each input file. Doxygen will invoke the filter program
Yunqing Wangda924eb2020-05-01 16:34:11 -0700978# by executing (via popen()) the command:
979#
980# <filter> <input-file>
981#
982# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
983# name of an input file. Doxygen will then use the output that the filter
984# program writes to standard output. If FILTER_PATTERNS is specified, this tag
985# will be ignored.
986#
987# Note that the filter must not add or remove lines; it is applied before the
988# code is scanned, but not when the output code is generated. If lines are added
989# or removed, the anchors will not be placed correctly.
990#
991# Note that for custom extensions or not directly supported extensions you also
992# need to set EXTENSION_MAPPING for the extension otherwise the files are not
993# properly processed by doxygen.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400994
995INPUT_FILTER =
996
997# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
Yunqing Wangda924eb2020-05-01 16:34:11 -0700998# basis. Doxygen will compare the file name with each pattern and apply the
999# filter if there is a match. The filters are a list of the form: pattern=filter
1000# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
1001# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1002# patterns match the file name, INPUT_FILTER is applied.
1003#
1004# Note that for custom extensions or not directly supported extensions you also
1005# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1006# properly processed by doxygen.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001007
1008FILTER_PATTERNS =
1009
1010# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
Yunqing Wangda924eb2020-05-01 16:34:11 -07001011# INPUT_FILTER) will also be used to filter the input files that are used for
1012# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1013# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001014
1015FILTER_SOURCE_FILES = NO
1016
Yunqing Wangda924eb2020-05-01 16:34:11 -07001017# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1018# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1019# it is also possible to disable source filtering for a specific pattern using
1020# *.ext= (so without naming a filter).
1021# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1022
1023FILTER_SOURCE_PATTERNS =
1024
1025# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1026# is part of the input, its contents will be placed on the main page
1027# (index.html). This can be useful if you have a project on for instance GitHub
1028# and want to reuse the introduction page also for the doxygen output.
1029
1030USE_MDFILE_AS_MAINPAGE =
1031
John Koleszar0ea50ce2010-05-18 11:58:33 -04001032#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -07001033# Configuration options related to source browsing
John Koleszar0ea50ce2010-05-18 11:58:33 -04001034#---------------------------------------------------------------------------
1035
Yunqing Wangda924eb2020-05-01 16:34:11 -07001036# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1037# generated. Documented entities will be cross-referenced with these sources.
1038#
1039# Note: To get rid of all source code in the generated output, make sure that
1040# also VERBATIM_HEADERS is set to NO.
1041# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001042
1043SOURCE_BROWSER = NO
1044
Yunqing Wangda924eb2020-05-01 16:34:11 -07001045# Setting the INLINE_SOURCES tag to YES will include the body of functions,
1046# classes and enums directly into the documentation.
1047# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001048
1049INLINE_SOURCES = NO
1050
Yunqing Wangda924eb2020-05-01 16:34:11 -07001051# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1052# special comment blocks from generated source code fragments. Normal C, C++ and
1053# Fortran comments will always remain visible.
1054# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001055
1056STRIP_CODE_COMMENTS = YES
1057
Yunqing Wangda924eb2020-05-01 16:34:11 -07001058# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1059# entity all documented functions referencing it will be listed.
1060# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001061
1062REFERENCED_BY_RELATION = YES
1063
Yunqing Wangda924eb2020-05-01 16:34:11 -07001064# If the REFERENCES_RELATION tag is set to YES then for each documented function
1065# all documented entities called/used by that function will be listed.
1066# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001067
1068REFERENCES_RELATION = YES
1069
Yunqing Wangda924eb2020-05-01 16:34:11 -07001070# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1071# to YES then the hyperlinks from functions in REFERENCES_RELATION and
1072# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1073# link to the documentation.
1074# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001075
1076REFERENCES_LINK_SOURCE = YES
1077
Yunqing Wangda924eb2020-05-01 16:34:11 -07001078# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1079# source code will show a tooltip with additional information such as prototype,
1080# brief description and links to the definition and documentation. Since this
1081# will make the HTML file larger and loading of large files a bit slower, you
1082# can opt to disable this feature.
1083# The default value is: YES.
1084# This tag requires that the tag SOURCE_BROWSER is set to YES.
1085
1086SOURCE_TOOLTIPS = YES
1087
1088# If the USE_HTAGS tag is set to YES then the references to source code will
1089# point to the HTML generated by the htags(1) tool instead of doxygen built-in
1090# source browser. The htags tool is part of GNU's global source tagging system
1091# (see https://www.gnu.org/software/global/global.html). You will need version
1092# 4.8.6 or higher.
1093#
1094# To use it do the following:
1095# - Install the latest version of global
1096# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1097# - Make sure the INPUT points to the root of the source tree
1098# - Run doxygen as normal
1099#
1100# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1101# tools must be available from the command line (i.e. in the search path).
1102#
1103# The result: instead of the source browser generated by doxygen, the links to
1104# source code will now point to the output of htags.
1105# The default value is: NO.
1106# This tag requires that the tag SOURCE_BROWSER is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001107
1108USE_HTAGS = NO
1109
Yunqing Wangda924eb2020-05-01 16:34:11 -07001110# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1111# verbatim copy of the header file for each class for which an include is
1112# specified. Set to NO to disable this.
1113# See also: Section \class.
1114# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001115
1116VERBATIM_HEADERS = YES
1117
Yunqing Wangda924eb2020-05-01 16:34:11 -07001118# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001119# clang parser (see:
1120# http://clang.llvm.org/) for more accurate parsing at the cost of reduced
1121# performance. This can be particularly helpful with template rich C++ code for
1122# which doxygen's built-in parser lacks the necessary type information.
Yunqing Wangda924eb2020-05-01 16:34:11 -07001123# Note: The availability of this option depends on whether or not doxygen was
1124# generated with the -Duse_libclang=ON option for CMake.
1125# The default value is: NO.
1126
1127CLANG_ASSISTED_PARSING = NO
1128
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001129# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS
1130# tag is set to YES then doxygen will add the directory of each input to the
1131# include path.
1132# The default value is: YES.
1133# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1134
1135CLANG_ADD_INC_PATHS = YES
1136
Yunqing Wangda924eb2020-05-01 16:34:11 -07001137# If clang assisted parsing is enabled you can provide the compiler with command
1138# line options that you would normally use when invoking the compiler. Note that
1139# the include paths will already be set by doxygen for the files and directories
1140# specified with INPUT and INCLUDE_PATH.
1141# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1142
1143CLANG_OPTIONS =
1144
1145# If clang assisted parsing is enabled you can provide the clang parser with the
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001146# path to the directory containing a file called compile_commands.json. This
1147# file is the compilation database (see:
1148# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the
1149# options used when the source files were built. This is equivalent to
1150# specifying the -p option to a clang tool, such as clang-check. These options
1151# will then be passed to the parser. Any options specified with CLANG_OPTIONS
1152# will be added as well.
Yunqing Wangda924eb2020-05-01 16:34:11 -07001153# Note: The availability of this option depends on whether or not doxygen was
1154# generated with the -Duse_libclang=ON option for CMake.
1155
1156CLANG_DATABASE_PATH =
1157
John Koleszar0ea50ce2010-05-18 11:58:33 -04001158#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -07001159# Configuration options related to the alphabetical class index
John Koleszar0ea50ce2010-05-18 11:58:33 -04001160#---------------------------------------------------------------------------
1161
Yunqing Wangda924eb2020-05-01 16:34:11 -07001162# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1163# compounds will be generated. Enable this if the project contains a lot of
1164# classes, structs, unions or interfaces.
1165# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001166
1167ALPHABETICAL_INDEX = NO
John Koleszar0ea50ce2010-05-18 11:58:33 -04001168
Yunqing Wangda924eb2020-05-01 16:34:11 -07001169# In case all classes in a project start with a common prefix, all classes will
1170# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1171# can be used to specify a prefix (or a list of prefixes) that should be ignored
1172# while generating the index headers.
1173# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001174
1175IGNORE_PREFIX =
1176
1177#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -07001178# Configuration options related to the HTML output
John Koleszar0ea50ce2010-05-18 11:58:33 -04001179#---------------------------------------------------------------------------
1180
Yunqing Wangda924eb2020-05-01 16:34:11 -07001181# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1182# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001183
1184GENERATE_HTML = YES
1185
Yunqing Wangda924eb2020-05-01 16:34:11 -07001186# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1187# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1188# it.
1189# The default directory is: html.
1190# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001191
1192HTML_OUTPUT = html
1193
Yunqing Wangda924eb2020-05-01 16:34:11 -07001194# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1195# generated HTML page (for example: .htm, .php, .asp).
1196# The default value is: .html.
1197# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001198
1199HTML_FILE_EXTENSION = .html
1200
Yunqing Wangda924eb2020-05-01 16:34:11 -07001201# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1202# each generated HTML page. If the tag is left blank doxygen will generate a
John Koleszar0ea50ce2010-05-18 11:58:33 -04001203# standard header.
Yunqing Wangda924eb2020-05-01 16:34:11 -07001204#
1205# To get valid HTML the header file that includes any scripts and style sheets
1206# that doxygen needs, which is dependent on the configuration options used (e.g.
1207# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1208# default header using
1209# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1210# YourConfigFile
1211# and then modify the file new_header.html. See also section "Doxygen usage"
1212# for information on how to generate the default header that doxygen normally
1213# uses.
1214# Note: The header is subject to change so you typically have to regenerate the
1215# default header when upgrading to a newer version of doxygen. For a description
1216# of the possible markers and block names see the documentation.
1217# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001218
1219HTML_HEADER =
1220
Yunqing Wangda924eb2020-05-01 16:34:11 -07001221# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1222# generated HTML page. If the tag is left blank doxygen will generate a standard
1223# footer. See HTML_HEADER for more information on how to generate a default
1224# footer and what special commands can be used inside the footer. See also
1225# section "Doxygen usage" for information on how to generate the default footer
1226# that doxygen normally uses.
1227# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001228
1229HTML_FOOTER =
1230
Yunqing Wangda924eb2020-05-01 16:34:11 -07001231# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1232# sheet that is used by each HTML page. It can be used to fine-tune the look of
1233# the HTML output. If left blank doxygen will generate a default style sheet.
1234# See also section "Doxygen usage" for information on how to generate the style
1235# sheet that doxygen normally uses.
1236# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1237# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1238# obsolete.
1239# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001240
1241HTML_STYLESHEET =
1242
Yunqing Wangda924eb2020-05-01 16:34:11 -07001243# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1244# cascading style sheets that are included after the standard style sheets
1245# created by doxygen. Using this option one can overrule certain style aspects.
1246# This is preferred over using HTML_STYLESHEET since it does not replace the
1247# standard style sheet and is therefore more robust against future updates.
1248# Doxygen will copy the style sheet files to the output directory.
1249# Note: The order of the extra style sheet files is of importance (e.g. the last
1250# style sheet in the list overrules the setting of the previous ones in the
1251# list). For an example see the documentation.
1252# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001253
Yunqing Wangda924eb2020-05-01 16:34:11 -07001254HTML_EXTRA_STYLESHEET =
1255
1256# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1257# other source files which should be copied to the HTML output directory. Note
1258# that these files will be copied to the base HTML output directory. Use the
1259# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1260# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1261# files will be copied as-is; there are no commands or markers available.
1262# This tag requires that the tag GENERATE_HTML is set to YES.
1263
1264HTML_EXTRA_FILES =
1265
1266# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1267# will adjust the colors in the style sheet and background images according to
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001268# this color. Hue is specified as an angle on a color-wheel, see
Yunqing Wangda924eb2020-05-01 16:34:11 -07001269# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1270# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1271# purple, and 360 is red again.
1272# Minimum value: 0, maximum value: 359, default value: 220.
1273# This tag requires that the tag GENERATE_HTML is set to YES.
1274
1275HTML_COLORSTYLE_HUE = 220
1276
1277# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001278# in the HTML output. For a value of 0 the output will use gray-scales only. A
Yunqing Wangda924eb2020-05-01 16:34:11 -07001279# value of 255 will produce the most vivid colors.
1280# Minimum value: 0, maximum value: 255, default value: 100.
1281# This tag requires that the tag GENERATE_HTML is set to YES.
1282
1283HTML_COLORSTYLE_SAT = 100
1284
1285# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1286# luminance component of the colors in the HTML output. Values below 100
1287# gradually make the output lighter, whereas values above 100 make the output
1288# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1289# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1290# change the gamma.
1291# Minimum value: 40, maximum value: 240, default value: 80.
1292# This tag requires that the tag GENERATE_HTML is set to YES.
1293
1294HTML_COLORSTYLE_GAMMA = 80
1295
1296# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1297# page will contain the date and time when the page was generated. Setting this
1298# to YES can help to show when doxygen was last run and thus if the
1299# documentation is up to date.
1300# The default value is: NO.
1301# This tag requires that the tag GENERATE_HTML is set to YES.
1302
1303HTML_TIMESTAMP = NO
1304
1305# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1306# documentation will contain a main index with vertical navigation menus that
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001307# are dynamically created via JavaScript. If disabled, the navigation index will
Yunqing Wangda924eb2020-05-01 16:34:11 -07001308# consists of multiple levels of tabs that are statically embedded in every HTML
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001309# page. Disable this option to support browsers that do not have JavaScript,
Yunqing Wangda924eb2020-05-01 16:34:11 -07001310# like the Qt help browser.
1311# The default value is: YES.
1312# This tag requires that the tag GENERATE_HTML is set to YES.
1313
1314HTML_DYNAMIC_MENUS = YES
John Koleszar0ea50ce2010-05-18 11:58:33 -04001315
1316# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1317# documentation will contain sections that can be hidden and shown after the
Yunqing Wangda924eb2020-05-01 16:34:11 -07001318# page has loaded.
1319# The default value is: NO.
1320# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001321
1322HTML_DYNAMIC_SECTIONS = NO
1323
Yunqing Wangda924eb2020-05-01 16:34:11 -07001324# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1325# shown in the various tree structured indices initially; the user can expand
1326# and collapse entries dynamically later on. Doxygen will expand the tree to
1327# such a level that at most the specified number of entries are visible (unless
1328# a fully collapsed tree already exceeds this amount). So setting the number of
1329# entries 1 will produce a full collapsed tree by default. 0 is a special value
1330# representing an infinite number of entries and will result in a full expanded
1331# tree by default.
1332# Minimum value: 0, maximum value: 9999, default value: 100.
1333# This tag requires that the tag GENERATE_HTML is set to YES.
1334
1335HTML_INDEX_NUM_ENTRIES = 100
1336
1337# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1338# generated that can be used as input for Apple's Xcode 3 integrated development
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001339# environment (see:
1340# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
1341# create a documentation set, doxygen will generate a Makefile in the HTML
1342# output directory. Running make will produce the docset in that directory and
1343# running make install will install the docset in
Yunqing Wangda924eb2020-05-01 16:34:11 -07001344# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1345# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1346# genXcode/_index.html for more information.
1347# The default value is: NO.
1348# This tag requires that the tag GENERATE_HTML is set to YES.
1349
1350GENERATE_DOCSET = NO
1351
1352# This tag determines the name of the docset feed. A documentation feed provides
1353# an umbrella under which multiple documentation sets from a single provider
1354# (such as a company or product suite) can be grouped.
1355# The default value is: Doxygen generated docs.
1356# This tag requires that the tag GENERATE_DOCSET is set to YES.
1357
1358DOCSET_FEEDNAME = "Doxygen generated docs"
1359
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001360# This tag determines the URL of the docset feed. A documentation feed provides
1361# an umbrella under which multiple documentation sets from a single provider
1362# (such as a company or product suite) can be grouped.
1363# This tag requires that the tag GENERATE_DOCSET is set to YES.
1364
1365DOCSET_FEEDURL =
1366
Yunqing Wangda924eb2020-05-01 16:34:11 -07001367# This tag specifies a string that should uniquely identify the documentation
1368# set bundle. This should be a reverse domain-name style string, e.g.
1369# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1370# The default value is: org.doxygen.Project.
1371# This tag requires that the tag GENERATE_DOCSET is set to YES.
1372
1373DOCSET_BUNDLE_ID = org.doxygen.Project
1374
1375# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1376# the documentation publisher. This should be a reverse domain-name style
1377# string, e.g. com.mycompany.MyDocSet.documentation.
1378# The default value is: org.doxygen.Publisher.
1379# This tag requires that the tag GENERATE_DOCSET is set to YES.
1380
1381DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1382
1383# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1384# The default value is: Publisher.
1385# This tag requires that the tag GENERATE_DOCSET is set to YES.
1386
1387DOCSET_PUBLISHER_NAME = Publisher
1388
1389# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1390# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1391# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001392# on Windows. In the beginning of 2021 Microsoft took the original page, with
1393# a.o. the download links, offline the HTML help workshop was already many years
1394# in maintenance mode). You can download the HTML help workshop from the web
1395# archives at Installation executable (see:
1396# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo
1397# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
Yunqing Wangda924eb2020-05-01 16:34:11 -07001398#
1399# The HTML Help Workshop contains a compiler that can convert all HTML output
1400# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1401# files are now used as the Windows 98 help format, and will replace the old
1402# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1403# HTML files also contain an index, a table of contents, and you can search for
1404# words in the documentation. The HTML workshop also contains a viewer for
1405# compressed HTML files.
1406# The default value is: NO.
1407# This tag requires that the tag GENERATE_HTML is set to YES.
1408
1409GENERATE_HTMLHELP = NO
1410
1411# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1412# file. You can add a path in front of the file if the result should not be
John Koleszar0ea50ce2010-05-18 11:58:33 -04001413# written to the html output directory.
Yunqing Wangda924eb2020-05-01 16:34:11 -07001414# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001415
1416CHM_FILE =
1417
Yunqing Wangda924eb2020-05-01 16:34:11 -07001418# The HHC_LOCATION tag can be used to specify the location (absolute path
1419# including file name) of the HTML help compiler (hhc.exe). If non-empty,
1420# doxygen will try to run the HTML help compiler on the generated index.hhp.
1421# The file has to be specified with full path.
1422# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001423
1424HHC_LOCATION =
1425
Yunqing Wangda924eb2020-05-01 16:34:11 -07001426# The GENERATE_CHI flag controls if a separate .chi index file is generated
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001427# (YES) or that it should be included in the main .chm file (NO).
Yunqing Wangda924eb2020-05-01 16:34:11 -07001428# The default value is: NO.
1429# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001430
1431GENERATE_CHI = NO
1432
Yunqing Wangda924eb2020-05-01 16:34:11 -07001433# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1434# and project file content.
1435# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1436
1437CHM_INDEX_ENCODING =
1438
1439# The BINARY_TOC flag controls whether a binary table of contents is generated
1440# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1441# enables the Previous and Next buttons.
1442# The default value is: NO.
1443# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001444
1445BINARY_TOC = NO
1446
Yunqing Wangda924eb2020-05-01 16:34:11 -07001447# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1448# the table of contents of the HTML help documentation and to the tree view.
1449# The default value is: NO.
1450# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001451
1452TOC_EXPAND = NO
1453
Yunqing Wangda924eb2020-05-01 16:34:11 -07001454# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1455# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1456# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1457# (.qch) of the generated HTML documentation.
1458# The default value is: NO.
1459# This tag requires that the tag GENERATE_HTML is set to YES.
1460
1461GENERATE_QHP = NO
1462
1463# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1464# the file name of the resulting .qch file. The path specified is relative to
1465# the HTML output folder.
1466# This tag requires that the tag GENERATE_QHP is set to YES.
1467
1468QCH_FILE =
1469
1470# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1471# Project output. For more information please see Qt Help Project / Namespace
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001472# (see:
1473# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
Yunqing Wangda924eb2020-05-01 16:34:11 -07001474# The default value is: org.doxygen.Project.
1475# This tag requires that the tag GENERATE_QHP is set to YES.
1476
1477QHP_NAMESPACE = org.doxygen.Project
1478
1479# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1480# Help Project output. For more information please see Qt Help Project / Virtual
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001481# Folders (see:
1482# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
Yunqing Wangda924eb2020-05-01 16:34:11 -07001483# The default value is: doc.
1484# This tag requires that the tag GENERATE_QHP is set to YES.
1485
1486QHP_VIRTUAL_FOLDER = doc
1487
1488# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1489# filter to add. For more information please see Qt Help Project / Custom
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001490# Filters (see:
1491# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
Yunqing Wangda924eb2020-05-01 16:34:11 -07001492# This tag requires that the tag GENERATE_QHP is set to YES.
1493
1494QHP_CUST_FILTER_NAME =
1495
1496# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1497# custom filter to add. For more information please see Qt Help Project / Custom
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001498# Filters (see:
1499# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
Yunqing Wangda924eb2020-05-01 16:34:11 -07001500# This tag requires that the tag GENERATE_QHP is set to YES.
1501
1502QHP_CUST_FILTER_ATTRS =
1503
1504# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1505# project's filter section matches. Qt Help Project / Filter Attributes (see:
1506# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1507# This tag requires that the tag GENERATE_QHP is set to YES.
1508
1509QHP_SECT_FILTER_ATTRS =
1510
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001511# The QHG_LOCATION tag can be used to specify the location (absolute path
1512# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1513# run qhelpgenerator on the generated .qhp file.
Yunqing Wangda924eb2020-05-01 16:34:11 -07001514# This tag requires that the tag GENERATE_QHP is set to YES.
1515
1516QHG_LOCATION =
1517
1518# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1519# generated, together with the HTML files, they form an Eclipse help plugin. To
1520# install this plugin and make it available under the help contents menu in
1521# Eclipse, the contents of the directory containing the HTML and XML files needs
1522# to be copied into the plugins directory of eclipse. The name of the directory
1523# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1524# After copying Eclipse needs to be restarted before the help appears.
1525# The default value is: NO.
1526# This tag requires that the tag GENERATE_HTML is set to YES.
1527
1528GENERATE_ECLIPSEHELP = NO
1529
1530# A unique identifier for the Eclipse help plugin. When installing the plugin
1531# the directory name containing the HTML and XML files should also have this
1532# name. Each documentation set should have its own identifier.
1533# The default value is: org.doxygen.Project.
1534# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1535
1536ECLIPSE_DOC_ID = org.doxygen.Project
1537
1538# If you want full control over the layout of the generated HTML pages it might
1539# be necessary to disable the index and replace it with your own. The
1540# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1541# of each HTML page. A value of NO enables the index and the value YES disables
1542# it. Since the tabs in the index contain the same information as the navigation
1543# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1544# The default value is: NO.
1545# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001546
1547DISABLE_INDEX = NO
1548
Yunqing Wangda924eb2020-05-01 16:34:11 -07001549# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1550# structure should be generated to display hierarchical information. If the tag
1551# value is set to YES, a side panel will be generated containing a tree-like
1552# index structure (just like the one that is generated for HTML Help). For this
1553# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1554# (i.e. any modern browser). Windows users are probably better off using the
1555# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001556# further fine tune the look of the index (see "Fine-tuning the output"). As an
1557# example, the default style sheet generated by doxygen has an example that
1558# shows how to put an image at the root of the tree instead of the PROJECT_NAME.
1559# Since the tree basically has the same information as the tab index, you could
1560# consider setting DISABLE_INDEX to YES when enabling this option.
Yunqing Wangda924eb2020-05-01 16:34:11 -07001561# The default value is: NO.
1562# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001563
Yunqing Wangab4ab5a2020-05-04 15:09:35 -07001564GENERATE_TREEVIEW = YES
John Koleszar0ea50ce2010-05-18 11:58:33 -04001565
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001566# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
1567# FULL_SIDEBAR option determines if the side bar is limited to only the treeview
1568# area (value NO) or if it should extend to the full height of the window (value
1569# YES). Setting this to YES gives a layout similar to
1570# https://docs.readthedocs.io with more room for contents, but less room for the
1571# project logo, title, and description. If either GENERATE_TREEVIEW or
1572# DISABLE_INDEX is set to NO, this option has no effect.
1573# The default value is: NO.
1574# This tag requires that the tag GENERATE_HTML is set to YES.
1575
1576FULL_SIDEBAR = NO
1577
Yunqing Wangda924eb2020-05-01 16:34:11 -07001578# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1579# doxygen will group on one line in the generated HTML documentation.
1580#
1581# Note that a value of 0 will completely suppress the enum values from appearing
1582# in the overview section.
1583# Minimum value: 0, maximum value: 20, default value: 4.
1584# This tag requires that the tag GENERATE_HTML is set to YES.
1585
1586ENUM_VALUES_PER_LINE = 4
1587
1588# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1589# to set the initial width (in pixels) of the frame in which the tree is shown.
1590# Minimum value: 0, maximum value: 1500, default value: 250.
1591# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001592
1593TREEVIEW_WIDTH = 250
1594
Yunqing Wangda924eb2020-05-01 16:34:11 -07001595# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1596# external symbols imported via tag files in a separate window.
1597# The default value is: NO.
1598# This tag requires that the tag GENERATE_HTML is set to YES.
1599
1600EXT_LINKS_IN_WINDOW = NO
1601
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001602# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
1603# addresses.
1604# The default value is: YES.
1605# This tag requires that the tag GENERATE_HTML is set to YES.
1606
1607OBFUSCATE_EMAILS = YES
1608
1609# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1610# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
1611# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
1612# the HTML output. These images will generally look nicer at scaled resolutions.
1613# Possible values are: png (the default) and svg (looks nicer but requires the
1614# pdf2svg or inkscape tool).
1615# The default value is: png.
1616# This tag requires that the tag GENERATE_HTML is set to YES.
1617
1618HTML_FORMULA_FORMAT = png
1619
Yunqing Wangda924eb2020-05-01 16:34:11 -07001620# Use this tag to change the font size of LaTeX formulas included as images in
1621# the HTML documentation. When you change the font size after a successful
1622# doxygen run you need to manually remove any form_*.png images from the HTML
1623# output directory to force them to be regenerated.
1624# Minimum value: 8, maximum value: 50, default value: 10.
1625# This tag requires that the tag GENERATE_HTML is set to YES.
1626
1627FORMULA_FONTSIZE = 10
1628
1629# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1630# generated for formulas are transparent PNGs. Transparent PNGs are not
1631# supported properly for IE 6.0, but are supported on all modern browsers.
1632#
1633# Note that when changing this option you need to delete any form_*.png files in
1634# the HTML output directory before the changes have effect.
1635# The default value is: YES.
1636# This tag requires that the tag GENERATE_HTML is set to YES.
1637
1638FORMULA_TRANSPARENT = YES
1639
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001640# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
1641# to create new LaTeX commands to be used in formulas as building blocks. See
1642# the section "Including formulas" for details.
1643
1644FORMULA_MACROFILE =
1645
Yunqing Wangda924eb2020-05-01 16:34:11 -07001646# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001647# https://www.mathjax.org) which uses client side JavaScript for the rendering
Yunqing Wangda924eb2020-05-01 16:34:11 -07001648# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1649# installed or if you want to formulas look prettier in the HTML output. When
1650# enabled you may also need to install MathJax separately and configure the path
1651# to it using the MATHJAX_RELPATH option.
1652# The default value is: NO.
1653# This tag requires that the tag GENERATE_HTML is set to YES.
1654
Yunqing Wangc7c0f272020-05-08 14:15:09 -07001655USE_MATHJAX = YES
Yunqing Wangda924eb2020-05-01 16:34:11 -07001656
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001657# With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
1658# Note that the different versions of MathJax have different requirements with
1659# regards to the different settings, so it is possible that also other MathJax
1660# settings have to be changed when switching between the different MathJax
1661# versions.
1662# Possible values are: MathJax_2 and MathJax_3.
1663# The default value is: MathJax_2.
1664# This tag requires that the tag USE_MATHJAX is set to YES.
1665
1666MATHJAX_VERSION = MathJax_2
1667
Yunqing Wangda924eb2020-05-01 16:34:11 -07001668# When MathJax is enabled you can set the default output format to be used for
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001669# the MathJax output. For more details about the output format see MathJax
1670# version 2 (see:
1671# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
1672# (see:
1673# http://docs.mathjax.org/en/latest/web/components/output.html).
Yunqing Wangda924eb2020-05-01 16:34:11 -07001674# Possible values are: HTML-CSS (which is slower, but has the best
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001675# compatibility. This is the name for Mathjax version 2, for MathJax version 3
1676# this will be translated into chtml), NativeMML (i.e. MathML. Only supported
1677# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
1678# is the name for Mathjax version 3, for MathJax version 2 this will be
1679# translated into HTML-CSS) and SVG.
Yunqing Wangda924eb2020-05-01 16:34:11 -07001680# The default value is: HTML-CSS.
1681# This tag requires that the tag USE_MATHJAX is set to YES.
1682
1683MATHJAX_FORMAT = HTML-CSS
1684
1685# When MathJax is enabled you need to specify the location relative to the HTML
1686# output directory using the MATHJAX_RELPATH option. The destination directory
1687# should contain the MathJax.js script. For instance, if the mathjax directory
1688# is located at the same level as the HTML output directory, then
1689# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1690# Content Delivery Network so you can quickly see the result without installing
1691# MathJax. However, it is strongly recommended to install a local copy of
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001692# MathJax from https://www.mathjax.org before deployment. The default value is:
1693# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
1694# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
Yunqing Wangda924eb2020-05-01 16:34:11 -07001695# This tag requires that the tag USE_MATHJAX is set to YES.
1696
1697MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/
1698
1699# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1700# extension names that should be enabled during MathJax rendering. For example
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001701# for MathJax version 2 (see https://docs.mathjax.org/en/v2.7-latest/tex.html
1702# #tex-and-latex-extensions):
Yunqing Wangda924eb2020-05-01 16:34:11 -07001703# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001704# For example for MathJax version 3 (see
1705# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):
1706# MATHJAX_EXTENSIONS = ams
Yunqing Wangda924eb2020-05-01 16:34:11 -07001707# This tag requires that the tag USE_MATHJAX is set to YES.
1708
1709MATHJAX_EXTENSIONS =
1710
1711# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1712# of code that will be used on startup of the MathJax code. See the MathJax site
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001713# (see:
1714# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
Yunqing Wangda924eb2020-05-01 16:34:11 -07001715# example see the documentation.
1716# This tag requires that the tag USE_MATHJAX is set to YES.
1717
1718MATHJAX_CODEFILE =
1719
1720# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1721# the HTML output. The underlying search engine uses javascript and DHTML and
1722# should work on any modern browser. Note that when using HTML help
1723# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1724# there is already a search function so this one should typically be disabled.
1725# For large projects the javascript based search engine can be slow, then
1726# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1727# search using the keyboard; to jump to the search box use <access key> + S
1728# (what the <access key> is depends on the OS and browser, but it is typically
1729# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1730# key> to jump into the search results window, the results can be navigated
1731# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1732# the search. The filter options can be selected when the cursor is inside the
1733# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1734# to select a filter and <Enter> or <escape> to activate or cancel the filter
1735# option.
1736# The default value is: YES.
1737# This tag requires that the tag GENERATE_HTML is set to YES.
1738
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001739SEARCHENGINE = NO
Yunqing Wangda924eb2020-05-01 16:34:11 -07001740
1741# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001742# implemented using a web server instead of a web client using JavaScript. There
Yunqing Wangda924eb2020-05-01 16:34:11 -07001743# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1744# setting. When disabled, doxygen will generate a PHP script for searching and
1745# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1746# and searching needs to be provided by external tools. See the section
1747# "External Indexing and Searching" for details.
1748# The default value is: NO.
1749# This tag requires that the tag SEARCHENGINE is set to YES.
1750
1751SERVER_BASED_SEARCH = NO
1752
1753# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1754# script for searching. Instead the search results are written to an XML file
1755# which needs to be processed by an external indexer. Doxygen will invoke an
1756# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1757# search results.
1758#
1759# Doxygen ships with an example indexer (doxyindexer) and search engine
1760# (doxysearch.cgi) which are based on the open source search engine library
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001761# Xapian (see:
1762# https://xapian.org/).
Yunqing Wangda924eb2020-05-01 16:34:11 -07001763#
1764# See the section "External Indexing and Searching" for details.
1765# The default value is: NO.
1766# This tag requires that the tag SEARCHENGINE is set to YES.
1767
1768EXTERNAL_SEARCH = NO
1769
1770# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1771# which will return the search results when EXTERNAL_SEARCH is enabled.
1772#
1773# Doxygen ships with an example indexer (doxyindexer) and search engine
1774# (doxysearch.cgi) which are based on the open source search engine library
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001775# Xapian (see:
1776# https://xapian.org/). See the section "External Indexing and Searching" for
1777# details.
Yunqing Wangda924eb2020-05-01 16:34:11 -07001778# This tag requires that the tag SEARCHENGINE is set to YES.
1779
1780SEARCHENGINE_URL =
1781
1782# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1783# search data is written to a file for indexing by an external tool. With the
1784# SEARCHDATA_FILE tag the name of this file can be specified.
1785# The default file is: searchdata.xml.
1786# This tag requires that the tag SEARCHENGINE is set to YES.
1787
1788SEARCHDATA_FILE = searchdata.xml
1789
1790# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1791# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1792# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1793# projects and redirect the results back to the right project.
1794# This tag requires that the tag SEARCHENGINE is set to YES.
1795
1796EXTERNAL_SEARCH_ID =
1797
1798# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1799# projects other than the one defined by this configuration file, but that are
1800# all added to the same external search index. Each project needs to have a
1801# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1802# to a relative location where the documentation can be found. The format is:
1803# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1804# This tag requires that the tag SEARCHENGINE is set to YES.
1805
1806EXTRA_SEARCH_MAPPINGS =
1807
John Koleszar0ea50ce2010-05-18 11:58:33 -04001808#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -07001809# Configuration options related to the LaTeX output
John Koleszar0ea50ce2010-05-18 11:58:33 -04001810#---------------------------------------------------------------------------
1811
Yunqing Wangda924eb2020-05-01 16:34:11 -07001812# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1813# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001814
1815GENERATE_LATEX = YES
1816
Yunqing Wangda924eb2020-05-01 16:34:11 -07001817# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1818# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1819# it.
1820# The default directory is: latex.
1821# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001822
1823LATEX_OUTPUT = latex
1824
Yunqing Wangda924eb2020-05-01 16:34:11 -07001825# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1826# invoked.
1827#
1828# Note that when not enabling USE_PDFLATEX the default is latex when enabling
1829# USE_PDFLATEX the default is pdflatex and when in the later case latex is
1830# chosen this is overwritten by pdflatex. For specific output languages the
1831# default can have been set differently, this depends on the implementation of
1832# the output language.
1833# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001834
1835LATEX_CMD_NAME = latex
1836
Yunqing Wangda924eb2020-05-01 16:34:11 -07001837# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1838# index for LaTeX.
1839# Note: This tag is used in the Makefile / make.bat.
1840# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
1841# (.tex).
1842# The default file is: makeindex.
1843# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001844
1845MAKEINDEX_CMD_NAME = makeindex
1846
Yunqing Wangda924eb2020-05-01 16:34:11 -07001847# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
1848# generate index for LaTeX. In case there is no backslash (\) as first character
1849# it will be automatically added in the LaTeX code.
1850# Note: This tag is used in the generated output file (.tex).
1851# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
1852# The default value is: makeindex.
1853# This tag requires that the tag GENERATE_LATEX is set to YES.
1854
1855LATEX_MAKEINDEX_CMD = makeindex
1856
1857# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1858# documents. This may be useful for small projects and may help to save some
1859# trees in general.
1860# The default value is: NO.
1861# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001862
1863COMPACT_LATEX = YES
1864
Yunqing Wangda924eb2020-05-01 16:34:11 -07001865# The PAPER_TYPE tag can be used to set the paper type that is used by the
1866# printer.
1867# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1868# 14 inches) and executive (7.25 x 10.5 inches).
1869# The default value is: a4.
1870# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001871
1872PAPER_TYPE = letter
1873
Yunqing Wangda924eb2020-05-01 16:34:11 -07001874# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1875# that should be included in the LaTeX output. The package can be specified just
1876# by its name or with the correct syntax as to be used with the LaTeX
1877# \usepackage command. To get the times font for instance you can specify :
1878# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1879# To use the option intlimits with the amsmath package you can specify:
1880# EXTRA_PACKAGES=[intlimits]{amsmath}
1881# If left blank no extra packages will be included.
1882# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001883
1884EXTRA_PACKAGES =
1885
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001886# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
1887# the generated LaTeX document. The header should contain everything until the
1888# first chapter. If it is left blank doxygen will generate a standard header. It
1889# is highly recommended to start with a default header using
1890# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
1891# and then modify the file new_header.tex. See also section "Doxygen usage" for
1892# information on how to generate the default header that doxygen normally uses.
Yunqing Wangda924eb2020-05-01 16:34:11 -07001893#
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001894# Note: Only use a user-defined header if you know what you are doing!
1895# Note: The header is subject to change so you typically have to regenerate the
1896# default header when upgrading to a newer version of doxygen. The following
1897# commands have a special meaning inside the header (and footer): For a
1898# description of the possible markers and block names see the documentation.
Yunqing Wangda924eb2020-05-01 16:34:11 -07001899# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001900
1901LATEX_HEADER =
1902
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001903# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
1904# the generated LaTeX document. The footer should contain everything after the
1905# last chapter. If it is left blank doxygen will generate a standard footer. See
Yunqing Wangda924eb2020-05-01 16:34:11 -07001906# LATEX_HEADER for more information on how to generate a default footer and what
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001907# special commands can be used inside the footer. See also section "Doxygen
1908# usage" for information on how to generate the default footer that doxygen
1909# normally uses. Note: Only use a user-defined footer if you know what you are
1910# doing!
Yunqing Wangda924eb2020-05-01 16:34:11 -07001911# This tag requires that the tag GENERATE_LATEX is set to YES.
1912
1913LATEX_FOOTER =
1914
1915# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1916# LaTeX style sheets that are included after the standard style sheets created
1917# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1918# will copy the style sheet files to the output directory.
1919# Note: The order of the extra style sheet files is of importance (e.g. the last
1920# style sheet in the list overrules the setting of the previous ones in the
1921# list).
1922# This tag requires that the tag GENERATE_LATEX is set to YES.
1923
1924LATEX_EXTRA_STYLESHEET =
1925
1926# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1927# other source files which should be copied to the LATEX_OUTPUT output
1928# directory. Note that the files will be copied as-is; there are no commands or
1929# markers available.
1930# This tag requires that the tag GENERATE_LATEX is set to YES.
1931
1932LATEX_EXTRA_FILES =
1933
1934# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1935# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1936# contain links (just like the HTML output) instead of page references. This
1937# makes the output suitable for online browsing using a PDF viewer.
1938# The default value is: YES.
1939# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001940
1941PDF_HYPERLINKS = YES
1942
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001943# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
1944# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
1945# files. Set this option to YES, to get a higher quality PDF documentation.
1946#
1947# See also section LATEX_CMD_NAME for selecting the engine.
Yunqing Wangda924eb2020-05-01 16:34:11 -07001948# The default value is: YES.
1949# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001950
1951USE_PDFLATEX = YES
1952
Yunqing Wangda924eb2020-05-01 16:34:11 -07001953# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1954# command to the generated LaTeX files. This will instruct LaTeX to keep running
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07001955# if errors occur, instead of asking the user for help.
Yunqing Wangda924eb2020-05-01 16:34:11 -07001956# The default value is: NO.
1957# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001958
1959LATEX_BATCHMODE = NO
1960
Yunqing Wangda924eb2020-05-01 16:34:11 -07001961# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1962# index chapters (such as File Index, Compound Index, etc.) in the output.
1963# The default value is: NO.
1964# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001965
1966LATEX_HIDE_INDICES = NO
1967
Yunqing Wangda924eb2020-05-01 16:34:11 -07001968# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1969# bibliography, e.g. plainnat, or ieeetr. See
1970# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1971# The default value is: plain.
1972# This tag requires that the tag GENERATE_LATEX is set to YES.
1973
1974LATEX_BIB_STYLE = plain
1975
1976# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1977# page will contain the date and time when the page was generated. Setting this
1978# to NO can help when comparing the output of multiple runs.
1979# The default value is: NO.
1980# This tag requires that the tag GENERATE_LATEX is set to YES.
1981
1982LATEX_TIMESTAMP = NO
1983
1984# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
1985# path from which the emoji images will be read. If a relative path is entered,
1986# it will be relative to the LATEX_OUTPUT directory. If left blank the
1987# LATEX_OUTPUT directory will be used.
1988# This tag requires that the tag GENERATE_LATEX is set to YES.
1989
1990LATEX_EMOJI_DIRECTORY =
1991
John Koleszar0ea50ce2010-05-18 11:58:33 -04001992#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -07001993# Configuration options related to the RTF output
John Koleszar0ea50ce2010-05-18 11:58:33 -04001994#---------------------------------------------------------------------------
1995
Yunqing Wangda924eb2020-05-01 16:34:11 -07001996# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1997# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1998# readers/editors.
1999# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002000
2001GENERATE_RTF = NO
2002
Yunqing Wangda924eb2020-05-01 16:34:11 -07002003# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2004# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2005# it.
2006# The default directory is: rtf.
2007# This tag requires that the tag GENERATE_RTF is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002008
2009RTF_OUTPUT = rtf
2010
Yunqing Wangda924eb2020-05-01 16:34:11 -07002011# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
2012# documents. This may be useful for small projects and may help to save some
2013# trees in general.
2014# The default value is: NO.
2015# This tag requires that the tag GENERATE_RTF is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002016
2017COMPACT_RTF = NO
2018
Yunqing Wangda924eb2020-05-01 16:34:11 -07002019# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
2020# contain hyperlink fields. The RTF file will contain links (just like the HTML
2021# output) instead of page references. This makes the output suitable for online
2022# browsing using Word or some other Word compatible readers that support those
2023# fields.
2024#
2025# Note: WordPad (write) and others do not support links.
2026# The default value is: NO.
2027# This tag requires that the tag GENERATE_RTF is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002028
2029RTF_HYPERLINKS = NO
2030
2031# Load stylesheet definitions from file. Syntax is similar to doxygen's
Yunqing Wangda924eb2020-05-01 16:34:11 -07002032# configuration file, i.e. a series of assignments. You only have to provide
John Koleszar0ea50ce2010-05-18 11:58:33 -04002033# replacements, missing definitions are set to their default value.
Yunqing Wangda924eb2020-05-01 16:34:11 -07002034#
2035# See also section "Doxygen usage" for information on how to generate the
2036# default style sheet that doxygen normally uses.
2037# This tag requires that the tag GENERATE_RTF is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002038
2039RTF_STYLESHEET_FILE =
2040
Yunqing Wangda924eb2020-05-01 16:34:11 -07002041# Set optional variables used in the generation of an RTF document. Syntax is
2042# similar to doxygen's configuration file. A template extensions file can be
2043# generated using doxygen -e rtf extensionFile.
2044# This tag requires that the tag GENERATE_RTF is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002045
2046RTF_EXTENSIONS_FILE =
2047
2048#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -07002049# Configuration options related to the man page output
John Koleszar0ea50ce2010-05-18 11:58:33 -04002050#---------------------------------------------------------------------------
2051
Yunqing Wangda924eb2020-05-01 16:34:11 -07002052# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2053# classes and files.
2054# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002055
2056GENERATE_MAN = NO
2057
Yunqing Wangda924eb2020-05-01 16:34:11 -07002058# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2059# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2060# it. A directory man3 will be created inside the directory specified by
2061# MAN_OUTPUT.
2062# The default directory is: man.
2063# This tag requires that the tag GENERATE_MAN is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002064
2065MAN_OUTPUT = man
2066
Yunqing Wangda924eb2020-05-01 16:34:11 -07002067# The MAN_EXTENSION tag determines the extension that is added to the generated
2068# man pages. In case the manual section does not start with a number, the number
2069# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2070# optional.
2071# The default value is: .3.
2072# This tag requires that the tag GENERATE_MAN is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002073
2074MAN_EXTENSION = .3
2075
Yunqing Wangda924eb2020-05-01 16:34:11 -07002076# The MAN_SUBDIR tag determines the name of the directory created within
2077# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2078# MAN_EXTENSION with the initial . removed.
2079# This tag requires that the tag GENERATE_MAN is set to YES.
2080
2081MAN_SUBDIR =
2082
2083# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2084# will generate one additional man file for each entity documented in the real
2085# man page(s). These additional files only source the real man page, but without
2086# them the man command would be unable to find the correct page.
2087# The default value is: NO.
2088# This tag requires that the tag GENERATE_MAN is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002089
2090MAN_LINKS = YES
2091
2092#---------------------------------------------------------------------------
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07002093# Configuration options related to the XML output
2094#---------------------------------------------------------------------------
2095
2096# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2097# captures the structure of the code including all documentation.
2098# The default value is: NO.
2099
2100GENERATE_XML = NO
2101
2102# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2103# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2104# it.
2105# The default directory is: xml.
2106# This tag requires that the tag GENERATE_XML is set to YES.
2107
2108XML_OUTPUT = xml
2109
2110# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2111# listings (including syntax highlighting and cross-referencing information) to
2112# the XML output. Note that enabling this will significantly increase the size
2113# of the XML output.
2114# The default value is: YES.
2115# This tag requires that the tag GENERATE_XML is set to YES.
2116
2117XML_PROGRAMLISTING = YES
2118
2119# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2120# namespace members in file scope as well, matching the HTML output.
2121# The default value is: NO.
2122# This tag requires that the tag GENERATE_XML is set to YES.
2123
2124XML_NS_MEMB_FILE_SCOPE = NO
2125
2126#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -07002127# Configuration options related to the DOCBOOK output
John Koleszar0ea50ce2010-05-18 11:58:33 -04002128#---------------------------------------------------------------------------
2129
Yunqing Wangda924eb2020-05-01 16:34:11 -07002130# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2131# that can be used to generate PDF.
2132# The default value is: NO.
2133
2134GENERATE_DOCBOOK = NO
2135
2136# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2137# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2138# front of it.
2139# The default directory is: docbook.
2140# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2141
2142DOCBOOK_OUTPUT = docbook
2143
Yunqing Wangda924eb2020-05-01 16:34:11 -07002144#---------------------------------------------------------------------------
2145# Configuration options for the AutoGen Definitions output
2146#---------------------------------------------------------------------------
2147
2148# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2149# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
2150# the structure of the code including all documentation. Note that this feature
2151# is still experimental and incomplete at the moment.
2152# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002153
2154GENERATE_AUTOGEN_DEF = NO
2155
2156#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -07002157# Configuration options related to the Perl module output
John Koleszar0ea50ce2010-05-18 11:58:33 -04002158#---------------------------------------------------------------------------
2159
Yunqing Wangda924eb2020-05-01 16:34:11 -07002160# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2161# file that captures the structure of the code including all documentation.
2162#
2163# Note that this feature is still experimental and incomplete at the moment.
2164# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002165
2166GENERATE_PERLMOD = NO
2167
Yunqing Wangda924eb2020-05-01 16:34:11 -07002168# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2169# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2170# output from the Perl module output.
2171# The default value is: NO.
2172# This tag requires that the tag GENERATE_PERLMOD is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002173
2174PERLMOD_LATEX = NO
2175
Yunqing Wangda924eb2020-05-01 16:34:11 -07002176# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2177# formatted so it can be parsed by a human reader. This is useful if you want to
2178# understand what is going on. On the other hand, if this tag is set to NO, the
2179# size of the Perl module output will be much smaller and Perl will parse it
2180# just the same.
2181# The default value is: YES.
2182# This tag requires that the tag GENERATE_PERLMOD is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002183
2184PERLMOD_PRETTY = YES
2185
Yunqing Wangda924eb2020-05-01 16:34:11 -07002186# The names of the make variables in the generated doxyrules.make file are
2187# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2188# so different doxyrules.make files included by the same Makefile don't
2189# overwrite each other's variables.
2190# This tag requires that the tag GENERATE_PERLMOD is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002191
2192PERLMOD_MAKEVAR_PREFIX =
2193
2194#---------------------------------------------------------------------------
2195# Configuration options related to the preprocessor
2196#---------------------------------------------------------------------------
2197
Yunqing Wangda924eb2020-05-01 16:34:11 -07002198# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2199# C-preprocessor directives found in the sources and include files.
2200# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002201
2202ENABLE_PREPROCESSING = YES
2203
Yunqing Wangda924eb2020-05-01 16:34:11 -07002204# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2205# in the source code. If set to NO, only conditional compilation will be
2206# performed. Macro expansion can be done in a controlled way by setting
2207# EXPAND_ONLY_PREDEF to YES.
2208# The default value is: NO.
2209# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002210
2211MACRO_EXPANSION = YES
2212
Yunqing Wangda924eb2020-05-01 16:34:11 -07002213# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2214# the macro expansion is limited to the macros specified with the PREDEFINED and
2215# EXPAND_AS_DEFINED tags.
2216# The default value is: NO.
2217# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002218
2219EXPAND_ONLY_PREDEF = NO
2220
Yunqing Wangda924eb2020-05-01 16:34:11 -07002221# If the SEARCH_INCLUDES tag is set to YES, the include files in the
2222# INCLUDE_PATH will be searched if a #include is found.
2223# The default value is: YES.
2224# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002225
2226SEARCH_INCLUDES = YES
2227
2228# The INCLUDE_PATH tag can be used to specify one or more directories that
Yunqing Wangda924eb2020-05-01 16:34:11 -07002229# contain include files that are not input files but should be processed by the
2230# preprocessor.
2231# This tag requires that the tag SEARCH_INCLUDES is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002232
2233INCLUDE_PATH =
2234
2235# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2236# patterns (like *.h and *.hpp) to filter out the header-files in the
Yunqing Wangda924eb2020-05-01 16:34:11 -07002237# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2238# used.
2239# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002240
2241INCLUDE_FILE_PATTERNS = *.h
2242
Yunqing Wangda924eb2020-05-01 16:34:11 -07002243# The PREDEFINED tag can be used to specify one or more macro names that are
2244# defined before the preprocessor is started (similar to the -D option of e.g.
2245# gcc). The argument of the tag is a list of macros of the form: name or
2246# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2247# is assumed. To prevent a macro definition from being undefined via #undef or
2248# recursively expanded use the := operator instead of the = operator.
2249# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002250
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07002251PREDEFINED = CONFIG_REALTIME_ONLY=0
John Koleszar0ea50ce2010-05-18 11:58:33 -04002252
Yunqing Wangda924eb2020-05-01 16:34:11 -07002253# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2254# tag can be used to specify a list of macro names that should be expanded. The
2255# macro definition that is found in the sources will be used. Use the PREDEFINED
2256# tag if you want to use a different macro definition that overrules the
2257# definition found in the source code.
2258# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002259
2260EXPAND_AS_DEFINED =
2261
Yunqing Wangda924eb2020-05-01 16:34:11 -07002262# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2263# remove all references to function-like macros that are alone on a line, have
2264# an all uppercase name, and do not end with a semicolon. Such function macros
2265# are typically used for boiler-plate code, and will confuse the parser if not
2266# removed.
2267# The default value is: YES.
2268# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002269
2270SKIP_FUNCTION_MACROS = YES
2271
2272#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -07002273# Configuration options related to external references
John Koleszar0ea50ce2010-05-18 11:58:33 -04002274#---------------------------------------------------------------------------
2275
Yunqing Wangda924eb2020-05-01 16:34:11 -07002276# The TAGFILES tag can be used to specify one or more tag files. For each tag
2277# file the location of the external documentation should be added. The format of
2278# a tag file without this location is as follows:
2279# TAGFILES = file1 file2 ...
John Koleszar0ea50ce2010-05-18 11:58:33 -04002280# Adding location for the tag files is done as follows:
Yunqing Wangda924eb2020-05-01 16:34:11 -07002281# TAGFILES = file1=loc1 "file2 = loc2" ...
2282# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2283# section "Linking to external documentation" for more information about the use
2284# of tag files.
2285# Note: Each tag file must have a unique name (where the name does NOT include
2286# the path). If a tag file is not located in the directory in which doxygen is
2287# run, you must also specify the path to the tagfile here.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002288
2289TAGFILES =
2290
Yunqing Wangda924eb2020-05-01 16:34:11 -07002291# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2292# tag file that is based on the input files it reads. See section "Linking to
2293# external documentation" for more information about the usage of tag files.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002294
2295GENERATE_TAGFILE =
2296
Yunqing Wangda924eb2020-05-01 16:34:11 -07002297# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2298# the class index. If set to NO, only the inherited external classes will be
2299# listed.
2300# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002301
2302ALLEXTERNALS = NO
2303
Yunqing Wangda924eb2020-05-01 16:34:11 -07002304# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2305# in the modules index. If set to NO, only the current project's groups will be
2306# listed.
2307# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002308
2309EXTERNAL_GROUPS = YES
2310
Yunqing Wangda924eb2020-05-01 16:34:11 -07002311# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2312# the related pages index. If set to NO, only the current project's pages will
2313# be listed.
2314# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002315
Yunqing Wangda924eb2020-05-01 16:34:11 -07002316EXTERNAL_PAGES = YES
John Koleszar0ea50ce2010-05-18 11:58:33 -04002317
2318#---------------------------------------------------------------------------
2319# Configuration options related to the dot tool
2320#---------------------------------------------------------------------------
2321
Yunqing Wangda924eb2020-05-01 16:34:11 -07002322# You can include diagrams made with dia in doxygen documentation. Doxygen will
2323# then run dia to produce the diagram and insert it in the documentation. The
2324# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2325# If left empty dia is assumed to be found in the default search path.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002326
Yunqing Wangda924eb2020-05-01 16:34:11 -07002327DIA_PATH =
John Koleszar0ea50ce2010-05-18 11:58:33 -04002328
Yunqing Wangda924eb2020-05-01 16:34:11 -07002329# If set to YES the inheritance and collaboration graphs will hide inheritance
2330# and usage relations if the target is undocumented or is not a class.
2331# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002332
2333HIDE_UNDOC_RELATIONS = YES
2334
2335# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
Yunqing Wangda924eb2020-05-01 16:34:11 -07002336# available from the path. This tool is part of Graphviz (see:
2337# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2338# Bell Labs. The other options in this section have no effect if this option is
2339# set to NO
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07002340# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002341
Yunqing Wanged7d20c2020-05-08 11:46:37 -07002342HAVE_DOT = NO
John Koleszar0ea50ce2010-05-18 11:58:33 -04002343
Yunqing Wangda924eb2020-05-01 16:34:11 -07002344# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2345# to run in parallel. When set to 0 doxygen will base this on the number of
2346# processors available in the system. You can set it explicitly to a value
2347# larger than 0 to get control over the balance between CPU load and processing
2348# speed.
2349# Minimum value: 0, maximum value: 32, default value: 0.
2350# This tag requires that the tag HAVE_DOT is set to YES.
2351
2352DOT_NUM_THREADS = 0
2353
2354# When you want a differently looking font in the dot files that doxygen
2355# generates you can specify the font name using DOT_FONTNAME. You need to make
2356# sure dot is able to find the font, which can be done by putting it in a
2357# standard location or by setting the DOTFONTPATH environment variable or by
2358# setting DOT_FONTPATH to the directory containing the font.
2359# The default value is: Helvetica.
2360# This tag requires that the tag HAVE_DOT is set to YES.
2361
2362DOT_FONTNAME = Helvetica
2363
2364# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2365# dot graphs.
2366# Minimum value: 4, maximum value: 24, default value: 10.
2367# This tag requires that the tag HAVE_DOT is set to YES.
2368
2369DOT_FONTSIZE = 10
2370
2371# By default doxygen will tell dot to use the default font as specified with
2372# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2373# the path where dot can find it using this tag.
2374# This tag requires that the tag HAVE_DOT is set to YES.
2375
2376DOT_FONTPATH =
2377
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07002378# If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a
2379# graph for each documented class showing the direct and indirect inheritance
2380# relations. In case HAVE_DOT is set as well dot will be used to draw the graph,
2381# otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set
2382# to TEXT the direct and indirect inheritance relations will be shown as texts /
2383# links.
2384# Possible values are: NO, YES, TEXT and GRAPH.
Yunqing Wangda924eb2020-05-01 16:34:11 -07002385# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002386
2387CLASS_GRAPH = YES
2388
Yunqing Wangda924eb2020-05-01 16:34:11 -07002389# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2390# graph for each documented class showing the direct and indirect implementation
2391# dependencies (inheritance, containment, and class references variables) of the
2392# class with other documented classes.
2393# The default value is: YES.
2394# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002395
2396COLLABORATION_GRAPH = YES
2397
Yunqing Wangda924eb2020-05-01 16:34:11 -07002398# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2399# groups, showing the direct groups dependencies.
2400# The default value is: YES.
2401# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002402
2403GROUP_GRAPHS = YES
2404
Yunqing Wangda924eb2020-05-01 16:34:11 -07002405# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
John Koleszar0ea50ce2010-05-18 11:58:33 -04002406# collaboration diagrams in a style similar to the OMG's Unified Modeling
2407# Language.
Yunqing Wangda924eb2020-05-01 16:34:11 -07002408# The default value is: NO.
2409# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002410
2411UML_LOOK = NO
2412
Yunqing Wangda924eb2020-05-01 16:34:11 -07002413# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2414# class node. If there are many fields or methods and many nodes the graph may
2415# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2416# number of items for each type to make the size more manageable. Set this to 0
2417# for no limit. Note that the threshold may be exceeded by 50% before the limit
2418# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2419# but if the number exceeds 15, the total amount of fields shown is limited to
2420# 10.
2421# Minimum value: 0, maximum value: 100, default value: 10.
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07002422# This tag requires that the tag UML_LOOK is set to YES.
Yunqing Wangda924eb2020-05-01 16:34:11 -07002423
2424UML_LIMIT_NUM_FIELDS = 10
2425
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07002426# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2427# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
2428# tag is set to YES, doxygen will add type and arguments for attributes and
2429# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
2430# will not generate fields with class member information in the UML graphs. The
2431# class diagrams will look similar to the default class diagrams but using UML
2432# notation for the relationships.
2433# Possible values are: NO, YES and NONE.
2434# The default value is: NO.
2435# This tag requires that the tag UML_LOOK is set to YES.
2436
2437DOT_UML_DETAILS = NO
2438
2439# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
2440# to display on a single line. If the actual line length exceeds this threshold
2441# significantly it will wrapped across multiple lines. Some heuristics are apply
2442# to avoid ugly line breaks.
2443# Minimum value: 0, maximum value: 1000, default value: 17.
2444# This tag requires that the tag HAVE_DOT is set to YES.
2445
2446DOT_WRAP_THRESHOLD = 17
2447
Yunqing Wangda924eb2020-05-01 16:34:11 -07002448# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2449# collaboration graphs will show the relations between templates and their
2450# instances.
2451# The default value is: NO.
2452# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002453
2454TEMPLATE_RELATIONS = NO
2455
Yunqing Wangda924eb2020-05-01 16:34:11 -07002456# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2457# YES then doxygen will generate a graph for each documented file showing the
2458# direct and indirect include dependencies of the file with other documented
2459# files.
2460# The default value is: YES.
2461# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002462
2463INCLUDE_GRAPH = YES
2464
Yunqing Wangda924eb2020-05-01 16:34:11 -07002465# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2466# set to YES then doxygen will generate a graph for each documented file showing
2467# the direct and indirect include dependencies of the file with other documented
2468# files.
2469# The default value is: YES.
2470# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002471
2472INCLUDED_BY_GRAPH = YES
2473
Yunqing Wangda924eb2020-05-01 16:34:11 -07002474# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2475# dependency graph for every global function or class method.
2476#
John Koleszar0ea50ce2010-05-18 11:58:33 -04002477# Note that enabling this option will significantly increase the time of a run.
2478# So in most cases it will be better to enable call graphs for selected
Yunqing Wangda924eb2020-05-01 16:34:11 -07002479# functions only using the \callgraph command. Disabling a call graph can be
2480# accomplished by means of the command \hidecallgraph.
2481# The default value is: NO.
2482# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002483
2484CALL_GRAPH = NO
2485
Yunqing Wangda924eb2020-05-01 16:34:11 -07002486# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2487# dependency graph for every global function or class method.
2488#
John Koleszar0ea50ce2010-05-18 11:58:33 -04002489# Note that enabling this option will significantly increase the time of a run.
2490# So in most cases it will be better to enable caller graphs for selected
Yunqing Wangda924eb2020-05-01 16:34:11 -07002491# functions only using the \callergraph command. Disabling a caller graph can be
2492# accomplished by means of the command \hidecallergraph.
2493# The default value is: NO.
2494# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002495
2496CALLER_GRAPH = NO
2497
Yunqing Wangda924eb2020-05-01 16:34:11 -07002498# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2499# hierarchy of all classes instead of a textual one.
2500# The default value is: YES.
2501# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002502
2503GRAPHICAL_HIERARCHY = YES
2504
Yunqing Wangda924eb2020-05-01 16:34:11 -07002505# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2506# dependencies a directory has on other directories in a graphical way. The
2507# dependency relations are determined by the #include relations between the
2508# files in the directories.
2509# The default value is: YES.
2510# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002511
2512DIRECTORY_GRAPH = YES
2513
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07002514# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels
2515# of child directories generated in directory dependency graphs by dot.
2516# Minimum value: 1, maximum value: 25, default value: 1.
2517# This tag requires that the tag DIRECTORY_GRAPH is set to YES.
2518
2519DIR_GRAPH_MAX_DEPTH = 1
2520
John Koleszar0ea50ce2010-05-18 11:58:33 -04002521# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
Yunqing Wangda924eb2020-05-01 16:34:11 -07002522# generated by dot. For an explanation of the image formats see the section
2523# output formats in the documentation of the dot tool (Graphviz (see:
2524# http://www.graphviz.org/)).
2525# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2526# to make the SVG files visible in IE 9+ (other browsers do not have this
2527# requirement).
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07002528# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
Yunqing Wangda924eb2020-05-01 16:34:11 -07002529# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2530# png:gdiplus:gdiplus.
2531# The default value is: png.
2532# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002533
2534DOT_IMAGE_FORMAT = png
2535
Yunqing Wangda924eb2020-05-01 16:34:11 -07002536# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2537# enable generation of interactive SVG images that allow zooming and panning.
2538#
2539# Note that this requires a modern browser other than Internet Explorer. Tested
2540# and working are Firefox, Chrome, Safari, and Opera.
2541# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2542# the SVG files visible. Older versions of IE do not have SVG support.
2543# The default value is: NO.
2544# This tag requires that the tag HAVE_DOT is set to YES.
2545
2546INTERACTIVE_SVG = NO
2547
2548# The DOT_PATH tag can be used to specify the path where the dot tool can be
John Koleszar0ea50ce2010-05-18 11:58:33 -04002549# found. If left blank, it is assumed the dot tool can be found in the path.
Yunqing Wangda924eb2020-05-01 16:34:11 -07002550# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002551
2552DOT_PATH =
2553
2554# The DOTFILE_DIRS tag can be used to specify one or more directories that
Yunqing Wangda924eb2020-05-01 16:34:11 -07002555# contain dot files that are included in the documentation (see the \dotfile
2556# command).
2557# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002558
2559DOTFILE_DIRS =
2560
Yunqing Wangda924eb2020-05-01 16:34:11 -07002561# The MSCFILE_DIRS tag can be used to specify one or more directories that
2562# contain msc files that are included in the documentation (see the \mscfile
2563# command).
2564
2565MSCFILE_DIRS =
2566
2567# The DIAFILE_DIRS tag can be used to specify one or more directories that
2568# contain dia files that are included in the documentation (see the \diafile
2569# command).
2570
2571DIAFILE_DIRS =
2572
2573# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07002574# path where java can find the plantuml.jar file or to the filename of jar file
2575# to be used. If left blank, it is assumed PlantUML is not used or called during
2576# a preprocessing step. Doxygen will generate a warning when it encounters a
2577# \startuml command in this case and will not generate output for the diagram.
Yunqing Wangda924eb2020-05-01 16:34:11 -07002578
2579PLANTUML_JAR_PATH =
2580
2581# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2582# configuration file for plantuml.
2583
2584PLANTUML_CFG_FILE =
2585
2586# When using plantuml, the specified paths are searched for files specified by
2587# the !include statement in a plantuml block.
2588
2589PLANTUML_INCLUDE_PATH =
2590
2591# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2592# that will be shown in the graph. If the number of nodes in a graph becomes
2593# larger than this value, doxygen will truncate the graph, which is visualized
2594# by representing a node as a red box. Note that doxygen if the number of direct
2595# children of the root node in a graph is already larger than
2596# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2597# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2598# Minimum value: 0, maximum value: 10000, default value: 50.
2599# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002600
2601DOT_GRAPH_MAX_NODES = 50
2602
Yunqing Wangda924eb2020-05-01 16:34:11 -07002603# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2604# generated by dot. A depth value of 3 means that only nodes reachable from the
2605# root by following a path via at most 3 edges will be shown. Nodes that lay
2606# further from the root node will be omitted. Note that setting this option to 1
2607# or 2 may greatly reduce the computation time needed for large code bases. Also
2608# note that the size of a graph can be further restricted by
John Koleszar0ea50ce2010-05-18 11:58:33 -04002609# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
Yunqing Wangda924eb2020-05-01 16:34:11 -07002610# Minimum value: 0, maximum value: 1000, default value: 0.
2611# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002612
2613MAX_DOT_GRAPH_DEPTH = 0
2614
2615# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
Yunqing Wangda924eb2020-05-01 16:34:11 -07002616# background. This is disabled by default, because dot on Windows does not seem
2617# to support this out of the box.
2618#
John Koleszar0ea50ce2010-05-18 11:58:33 -04002619# Warning: Depending on the platform used, enabling this option may lead to
2620# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2621# read).
Yunqing Wangda924eb2020-05-01 16:34:11 -07002622# The default value is: NO.
2623# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002624
Yunqing Wangda924eb2020-05-01 16:34:11 -07002625DOT_TRANSPARENT = NO
John Koleszar0ea50ce2010-05-18 11:58:33 -04002626
Yunqing Wangda924eb2020-05-01 16:34:11 -07002627# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
John Koleszar0ea50ce2010-05-18 11:58:33 -04002628# files in one run (i.e. multiple -o and -T options on the command line). This
Yunqing Wangda924eb2020-05-01 16:34:11 -07002629# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2630# this, this feature is disabled by default.
2631# The default value is: NO.
2632# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002633
2634DOT_MULTI_TARGETS = NO
2635
Yunqing Wangda924eb2020-05-01 16:34:11 -07002636# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2637# explaining the meaning of the various boxes and arrows in the dot generated
2638# graphs.
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07002639# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal
2640# graphical representation for inheritance and collaboration diagrams is used.
Yunqing Wangda924eb2020-05-01 16:34:11 -07002641# The default value is: YES.
2642# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002643
2644GENERATE_LEGEND = YES
2645
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07002646# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
Yunqing Wangda924eb2020-05-01 16:34:11 -07002647# files that are used to generate the various graphs.
Urvang Joshi8ef1c2c2022-03-14 15:23:55 -07002648#
2649# Note: This setting is not only used for dot files but also for msc temporary
2650# files.
Yunqing Wangda924eb2020-05-01 16:34:11 -07002651# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002652
2653DOT_CLEANUP = YES