blob: c989b885c26b504b37c19a7becf403c505adc750 [file] [log] [blame]
Yunqing Wangda924eb2020-05-01 16:34:11 -07001## Copyright (c) 2020, Alliance for Open Media. All rights reserved
John Koleszar0ea50ce2010-05-18 11:58:33 -04002##
Yaowu Xu9c01aa12016-09-01 14:32:49 -07003## This source code is subject to the terms of the BSD 2 Clause License and
4## the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
5## was not distributed with this source code in the LICENSE file, you can
6## obtain it at www.aomedia.org/license/software. If the Alliance for Open
7## Media Patent License 1.0 was not distributed with this source code in the
8## PATENTS file, you can obtain it at www.aomedia.org/license/patent.
John Koleszar94c52e42010-06-18 12:39:21 -04009##
John Koleszar0ea50ce2010-05-18 11:58:33 -040010
Yunqing Wangda924eb2020-05-01 16:34:11 -070011# Doxyfile 1.8.16
John Koleszar0ea50ce2010-05-18 11:58:33 -040012
13# This file describes the settings to be used by the documentation system
Yunqing Wangda924eb2020-05-01 16:34:11 -070014# doxygen (www.doxygen.org) for a project.
John Koleszar0ea50ce2010-05-18 11:58:33 -040015#
Yunqing Wangda924eb2020-05-01 16:34:11 -070016# All text after a double hash (##) is considered a comment and is placed in
17# front of the TAG it is preceding.
18#
19# All text after a single hash (#) is considered a comment and will be ignored.
John Koleszar0ea50ce2010-05-18 11:58:33 -040020# The format is:
Yunqing Wangda924eb2020-05-01 16:34:11 -070021# TAG = value [value, ...]
22# For lists, items can also be appended using:
23# TAG += value [value, ...]
24# Values that contain spaces should be placed between quotes (\" \").
John Koleszar0ea50ce2010-05-18 11:58:33 -040025
26#---------------------------------------------------------------------------
27# Project related configuration options
28#---------------------------------------------------------------------------
29
Yunqing Wangda924eb2020-05-01 16:34:11 -070030# This tag specifies the encoding used for all characters in the configuration
31# file that follow. The default is UTF-8 which is also the encoding used for all
32# text before the first occurrence of this tag. Doxygen uses libiconv (or the
33# iconv built into libc) for the transcoding. See
34# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
35# The default value is: UTF-8.
John Koleszar0ea50ce2010-05-18 11:58:33 -040036
37DOXYFILE_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# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
107# documentation generated by doxygen is written. Doxygen will use this
108# information to generate all generated output in the proper direction.
109# Possible values are: None, LTR, RTL and Context.
110# The default value is: None.
111
112OUTPUT_TEXT_DIRECTION = None
113
114# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
115# descriptions after the members that are listed in the file and class
116# documentation (similar to Javadoc). Set to NO to disable this.
117# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400118
119BRIEF_MEMBER_DESC = YES
120
Yunqing Wangda924eb2020-05-01 16:34:11 -0700121# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
122# description of a member or function before the detailed description
123#
124# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
John Koleszar0ea50ce2010-05-18 11:58:33 -0400125# brief descriptions will be completely suppressed.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700126# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400127
128REPEAT_BRIEF = YES
129
Yunqing Wangda924eb2020-05-01 16:34:11 -0700130# This tag implements a quasi-intelligent brief description abbreviator that is
131# used to form the text in various listings. Each string in this list, if found
132# as the leading text of the brief description, will be stripped from the text
133# and the result, after processing the whole list, is used as the annotated
134# text. Otherwise, the brief description is used as-is. If left blank, the
135# following values are used ($name is automatically replaced with the name of
136# the entity):The $name class, The $name widget, The $name file, is, provides,
137# specifies, contains, represents, a, an and the.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400138
139ABBREVIATE_BRIEF =
140
141# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
Yunqing Wangda924eb2020-05-01 16:34:11 -0700142# doxygen will generate a detailed section even if there is only a brief
John Koleszar0ea50ce2010-05-18 11:58:33 -0400143# description.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700144# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400145
146ALWAYS_DETAILED_SEC = NO
147
148# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
149# inherited members of a class in the documentation of that class as if those
150# members were ordinary class members. Constructors, destructors and assignment
151# operators of the base classes will not be shown.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700152# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400153
154INLINE_INHERITED_MEMB = NO
155
Yunqing Wangda924eb2020-05-01 16:34:11 -0700156# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
157# before files name in the file list and in the header files. If set to NO the
158# shortest path that makes the file name unique will be used
159# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400160
161FULL_PATH_NAMES = YES
162
Yunqing Wangda924eb2020-05-01 16:34:11 -0700163# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
164# Stripping is only done if one of the specified strings matches the left-hand
165# part of the path. The tag can be used to show relative paths in the file list.
166# If left blank the directory from which doxygen is run is used as the path to
167# strip.
168#
169# Note that you can specify absolute paths here, but also relative paths, which
170# will be relative from the directory where doxygen is started.
171# This tag requires that the tag FULL_PATH_NAMES is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400172
173STRIP_FROM_PATH =
174
Yunqing Wangda924eb2020-05-01 16:34:11 -0700175# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
176# path mentioned in the documentation of a class, which tells the reader which
177# header file to include in order to use a class. If left blank only the name of
178# the header file containing the class definition is used. Otherwise one should
179# specify the list of include paths that are normally passed to the compiler
180# using the -I flag.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400181
182STRIP_FROM_INC_PATH =
183
Yunqing Wangda924eb2020-05-01 16:34:11 -0700184# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
185# less readable) file names. This can be useful is your file systems doesn't
186# support long names like on DOS, Mac, or CD-ROM.
187# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400188
189SHORT_NAMES = NO
190
Yunqing Wangda924eb2020-05-01 16:34:11 -0700191# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
192# first line (until the first dot) of a Javadoc-style comment as the brief
193# description. If set to NO, the Javadoc-style will behave just like regular Qt-
194# style comments (thus requiring an explicit @brief command for a brief
195# description.)
196# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400197
198JAVADOC_AUTOBRIEF = NO
199
Yunqing Wangda924eb2020-05-01 16:34:11 -0700200# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
201# such as
202# /***************
203# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
204# Javadoc-style will behave just like regular comments and it will not be
205# interpreted by doxygen.
206# The default value is: NO.
207
208JAVADOC_BANNER = NO
209
210# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
211# line (until the first dot) of a Qt-style comment as the brief description. If
212# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
213# requiring an explicit \brief command for a brief description.)
214# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400215
216QT_AUTOBRIEF = NO
217
Yunqing Wangda924eb2020-05-01 16:34:11 -0700218# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
219# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
220# a brief description. This used to be the default behavior. The new default is
221# to treat a multi-line C++ comment block as a detailed description. Set this
222# tag to YES if you prefer the old behavior instead.
223#
224# Note that setting this tag to YES also means that rational rose comments are
225# not recognized any more.
226# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400227
228MULTILINE_CPP_IS_BRIEF = NO
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
253# "sideeffect=@par Side Effects:\n"
254# will allow you to put the command \sideeffect (or @sideeffect) in the
255# documentation, which will result in a user-defined paragraph with heading
256# "Side Effects:". You can put \n's in the value part of an alias to insert
257# newlines (in the resulting output). You can put ^^ in the value part of an
258# alias to insert a newline as if a physical newline was in the original file.
259# When you need a literal { or } or , in the value part of an alias you have to
260# escape them by means of a backslash (\), this can lead to conflicts with the
261# commands \{ and \} for these it is advised to use the version @{ and @} or use
262# 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
306# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
307# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice,
308# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
309# 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
311# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat
312# .inc files as Fortran files (default is PHP), and .f files as C (default is
313# Fortran), use: inc=Fortran f=C.
314#
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
318# the files are not read by doxygen.
319
320EXTENSION_MAPPING =
321
322# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
323# according to the Markdown format, which allows for more readable
324# documentation. See https://daringfireball.net/projects/markdown/ for details.
325# The output of markdown processing is further processed by doxygen, so you can
326# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
327# case of backward compatibilities issues.
328# The default value is: YES.
329
330MARKDOWN_SUPPORT = YES
331
332# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
333# to that level are automatically included in the table of contents, even if
334# they do not have an id attribute.
335# Note: This feature currently applies only to Markdown headings.
336# Minimum value: 0, maximum value: 99, default value: 5.
337# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
338
339TOC_INCLUDE_HEADINGS = 5
340
341# When enabled doxygen tries to link words that correspond to documented
342# classes, or namespaces to their corresponding documentation. Such a link can
343# be prevented in individual cases by putting a % sign in front of the word or
344# globally by setting AUTOLINK_SUPPORT to NO.
345# The default value is: YES.
346
347AUTOLINK_SUPPORT = YES
348
349# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
350# to include (a tag file for) the STL sources as input, then you should set this
351# tag to YES in order to let doxygen match functions declarations and
352# definitions whose arguments contain STL classes (e.g. func(std::string);
353# versus func(std::string) {}). This also make the inheritance and collaboration
John Koleszar0ea50ce2010-05-18 11:58:33 -0400354# diagrams that involve STL classes more complete and accurate.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700355# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400356
357BUILTIN_STL_SUPPORT = NO
358
359# If you use Microsoft's C++/CLI language, you should set this option to YES to
360# enable parsing support.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700361# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400362
363CPP_CLI_SUPPORT = NO
364
Yunqing Wangda924eb2020-05-01 16:34:11 -0700365# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
366# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
367# will parse them like normal C++ but will assume all classes use public instead
368# of private inheritance when no explicit protection keyword is present.
369# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400370
371SIP_SUPPORT = NO
372
Yunqing Wangda924eb2020-05-01 16:34:11 -0700373# For Microsoft's IDL there are propget and propput attributes to indicate
374# getter and setter methods for a property. Setting this option to YES will make
375# doxygen to replace the get and set methods by a property in the documentation.
376# This will only work if the methods are indeed getting or setting a simple
377# type. If this is not the case, or you want to show the methods anyway, you
378# should set this option to NO.
379# The default value is: YES.
380
381IDL_PROPERTY_SUPPORT = YES
382
John Koleszar0ea50ce2010-05-18 11:58:33 -0400383# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
Yunqing Wangda924eb2020-05-01 16:34:11 -0700384# tag is set to YES then doxygen will reuse the documentation of the first
John Koleszar0ea50ce2010-05-18 11:58:33 -0400385# member in the group (if any) for the other members of the group. By default
386# all members of a group must be documented explicitly.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700387# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400388
389DISTRIBUTE_GROUP_DOC = NO
390
Yunqing Wangda924eb2020-05-01 16:34:11 -0700391# If one adds a struct or class to a group and this option is enabled, then also
392# any nested class or struct is added to the same group. By default this option
393# is disabled and one has to add nested compounds explicitly via \ingroup.
394# The default value is: NO.
395
396GROUP_NESTED_COMPOUNDS = NO
397
398# Set the SUBGROUPING tag to YES to allow class member groups of the same type
399# (for instance a group of public functions) to be put as a subgroup of that
400# type (e.g. under the Public Functions section). Set it to NO to prevent
401# subgrouping. Alternatively, this can be done per class using the
402# \nosubgrouping command.
403# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400404
405SUBGROUPING = YES
406
Yunqing Wangda924eb2020-05-01 16:34:11 -0700407# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
408# are shown inside the group in which they are included (e.g. using \ingroup)
409# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
410# and RTF).
411#
412# Note that this feature does not work in combination with
413# SEPARATE_MEMBER_PAGES.
414# The default value is: NO.
415
416INLINE_GROUPED_CLASSES = NO
417
418# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
419# with only public data fields or simple typedef fields will be shown inline in
420# the documentation of the scope in which they are defined (i.e. file,
421# namespace, or group documentation), provided this scope is documented. If set
422# to NO, structs, classes, and unions are shown on a separate page (for HTML and
423# Man pages) or section (for LaTeX and RTF).
424# The default value is: NO.
425
426INLINE_SIMPLE_STRUCTS = NO
427
428# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
429# enum is documented as struct, union, or enum with the name of the typedef. So
430# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
431# with name TypeT. When disabled the typedef will appear as a member of a file,
432# namespace, or class. And the struct will be named TypeS. This can typically be
433# useful for C code in case the coding convention dictates that all compound
434# types are typedef'ed and only the typedef is referenced, never the tag name.
435# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400436
437TYPEDEF_HIDES_STRUCT = NO
438
Yunqing Wangda924eb2020-05-01 16:34:11 -0700439# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
440# cache is used to resolve symbols given their name and scope. Since this can be
441# an expensive process and often the same symbol appears multiple times in the
442# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
443# doxygen will become slower. If the cache is too large, memory is wasted. The
444# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
445# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
446# symbols. At the end of a run doxygen will report the cache usage and suggest
447# the optimal cache size from a speed point of view.
448# Minimum value: 0, maximum value: 9, default value: 0.
449
450LOOKUP_CACHE_SIZE = 0
451
John Koleszar0ea50ce2010-05-18 11:58:33 -0400452#---------------------------------------------------------------------------
453# Build related configuration options
454#---------------------------------------------------------------------------
455
Yunqing Wangda924eb2020-05-01 16:34:11 -0700456# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
457# documentation are documented, even if no documentation was available. Private
458# class members and static file members will be hidden unless the
459# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
460# Note: This will also disable the warnings about undocumented members that are
461# normally produced when WARNINGS is set to YES.
462# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400463
464EXTRACT_ALL = NO
465
Yunqing Wangda924eb2020-05-01 16:34:11 -0700466# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
467# be included in the documentation.
468# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400469
470EXTRACT_PRIVATE = NO
471
Yunqing Wangda924eb2020-05-01 16:34:11 -0700472# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
473# methods of a class will be included in the documentation.
474# The default value is: NO.
475
476EXTRACT_PRIV_VIRTUAL = NO
477
478# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
479# scope will be included in the documentation.
480# The default value is: NO.
481
482EXTRACT_PACKAGE = NO
483
484# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
485# included in the documentation.
486# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400487
Yue Chen18491742020-06-08 11:54:41 -0700488EXTRACT_STATIC = YES
John Koleszar0ea50ce2010-05-18 11:58:33 -0400489
Yunqing Wangda924eb2020-05-01 16:34:11 -0700490# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
491# locally in source files will be included in the documentation. If set to NO,
492# only classes defined in header files are included. Does not have any effect
493# for Java sources.
494# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400495
496EXTRACT_LOCAL_CLASSES = YES
497
Yunqing Wangda924eb2020-05-01 16:34:11 -0700498# This flag is only useful for Objective-C code. If set to YES, local methods,
499# which are defined in the implementation section but not in the interface are
500# included in the documentation. If set to NO, only methods in the interface are
501# included.
502# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400503
504EXTRACT_LOCAL_METHODS = NO
505
Yunqing Wangda924eb2020-05-01 16:34:11 -0700506# If this flag is set to YES, the members of anonymous namespaces will be
507# extracted and appear in the documentation as a namespace called
508# 'anonymous_namespace{file}', where file will be replaced with the base name of
509# the file that contains the anonymous namespace. By default anonymous namespace
510# are hidden.
511# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400512
513EXTRACT_ANON_NSPACES = NO
514
Yunqing Wangda924eb2020-05-01 16:34:11 -0700515# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
516# undocumented members inside documented classes or files. If set to NO these
517# members will be included in the various overviews, but no documentation
518# section is generated. This option has no effect if EXTRACT_ALL is enabled.
519# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400520
521HIDE_UNDOC_MEMBERS = NO
522
Yunqing Wangda924eb2020-05-01 16:34:11 -0700523# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
524# undocumented classes that are normally visible in the class hierarchy. If set
525# to NO, these classes will be included in the various overviews. This option
526# has no effect if EXTRACT_ALL is enabled.
527# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400528
529HIDE_UNDOC_CLASSES = NO
530
Yunqing Wangda924eb2020-05-01 16:34:11 -0700531# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
532# (class|struct|union) declarations. If set to NO, these declarations will be
533# included in the documentation.
534# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400535
536HIDE_FRIEND_COMPOUNDS = NO
537
Yunqing Wangda924eb2020-05-01 16:34:11 -0700538# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
539# documentation blocks found inside the body of a function. If set to NO, these
540# blocks will be appended to the function's detailed documentation block.
541# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400542
543HIDE_IN_BODY_DOCS = NO
544
Yunqing Wangda924eb2020-05-01 16:34:11 -0700545# The INTERNAL_DOCS tag determines if documentation that is typed after a
546# \internal command is included. If the tag is set to NO then the documentation
547# will be excluded. Set it to YES to include the internal documentation.
548# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400549
550INTERNAL_DOCS = NO
551
Yunqing Wangda924eb2020-05-01 16:34:11 -0700552# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
553# names in lower-case letters. If set to YES, upper-case letters are also
John Koleszar0ea50ce2010-05-18 11:58:33 -0400554# allowed. This is useful if you have classes or files whose names only differ
555# in case and if your file system supports case sensitive file names. Windows
Yunqing Wangda924eb2020-05-01 16:34:11 -0700556# (including Cygwin) ands Mac users are advised to set this option to NO.
557# The default value is: system dependent.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400558
559CASE_SENSE_NAMES = YES
560
Yunqing Wangda924eb2020-05-01 16:34:11 -0700561# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
562# their full class and namespace scopes in the documentation. If set to YES, the
563# scope will be hidden.
564# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400565
566HIDE_SCOPE_NAMES = NO
567
Yunqing Wangda924eb2020-05-01 16:34:11 -0700568# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
569# append additional text to a page's title, such as Class Reference. If set to
570# YES the compound reference will be hidden.
571# The default value is: NO.
572
573HIDE_COMPOUND_REFERENCE= NO
574
575# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
576# the files that are included by a file in the documentation of that file.
577# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400578
579SHOW_INCLUDE_FILES = YES
580
Yunqing Wangda924eb2020-05-01 16:34:11 -0700581# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
582# grouped member an include statement to the documentation, telling the reader
583# which file to include in order to use the member.
584# The default value is: NO.
585
586SHOW_GROUPED_MEMB_INC = NO
587
588# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
589# files with double quotes in the documentation rather than with sharp brackets.
590# The default value is: NO.
591
592FORCE_LOCAL_INCLUDES = NO
593
594# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
595# documentation for inline members.
596# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400597
598INLINE_INFO = YES
599
Yunqing Wangda924eb2020-05-01 16:34:11 -0700600# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
601# (detailed) documentation of file and class members alphabetically by member
602# name. If set to NO, the members will appear in declaration order.
603# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400604
605SORT_MEMBER_DOCS = NO
606
Yunqing Wangda924eb2020-05-01 16:34:11 -0700607# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
608# descriptions of file, namespace and class members alphabetically by member
609# name. If set to NO, the members will appear in declaration order. Note that
610# this will also influence the order of the classes in the class list.
611# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400612
613SORT_BRIEF_DOCS = NO
614
Yunqing Wangda924eb2020-05-01 16:34:11 -0700615# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
616# (brief and detailed) documentation of class members so that constructors and
617# destructors are listed first. If set to NO the constructors will appear in the
618# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
619# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
620# member documentation.
621# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
622# detailed member documentation.
623# The default value is: NO.
624
625SORT_MEMBERS_CTORS_1ST = NO
626
627# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
628# of group names into alphabetical order. If set to NO the group names will
629# appear in their defined order.
630# The default value is: NO.
631
632SORT_GROUP_NAMES = NO
633
634# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
635# fully-qualified names, including namespaces. If set to NO, the class list will
636# be sorted only by class name, not including the namespace part.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400637# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700638# Note: This option applies only to the class list, not to the alphabetical
639# list.
640# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400641
642SORT_BY_SCOPE_NAME = NO
643
Yunqing Wangda924eb2020-05-01 16:34:11 -0700644# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
645# type resolution of all parameters of a function it will reject a match between
646# the prototype and the implementation of a member function even if there is
647# only one candidate or it is obvious which candidate to choose by doing a
648# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
649# accept a match between prototype and implementation in such cases.
650# The default value is: NO.
651
652STRICT_PROTO_MATCHING = NO
653
654# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
655# list. This list is created by putting \todo commands in the documentation.
656# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400657
658GENERATE_TODOLIST = YES
659
Yunqing Wangda924eb2020-05-01 16:34:11 -0700660# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
661# list. This list is created by putting \test commands in the documentation.
662# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400663
664GENERATE_TESTLIST = YES
665
Yunqing Wangda924eb2020-05-01 16:34:11 -0700666# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
667# list. This list is created by putting \bug commands in the documentation.
668# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400669
670GENERATE_BUGLIST = YES
671
Yunqing Wangda924eb2020-05-01 16:34:11 -0700672# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
673# the deprecated list. This list is created by putting \deprecated commands in
674# the documentation.
675# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400676
677GENERATE_DEPRECATEDLIST= YES
678
Yunqing Wangda924eb2020-05-01 16:34:11 -0700679# The ENABLED_SECTIONS tag can be used to enable conditional documentation
680# sections, marked by \if <section_label> ... \endif and \cond <section_label>
681# ... \endcond blocks.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400682
683ENABLED_SECTIONS =
684
Yunqing Wangda924eb2020-05-01 16:34:11 -0700685# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
686# initial value of a variable or macro / define can have for it to appear in the
687# documentation. If the initializer consists of more lines than specified here
688# it will be hidden. Use a value of 0 to hide initializers completely. The
689# appearance of the value of individual variables and macros / defines can be
690# controlled using \showinitializer or \hideinitializer command in the
691# documentation regardless of this setting.
692# Minimum value: 0, maximum value: 10000, default value: 30.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400693
694MAX_INITIALIZER_LINES = 30
695
Yunqing Wangda924eb2020-05-01 16:34:11 -0700696# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
697# the bottom of the documentation of classes and structs. If set to YES, the
John Koleszar0ea50ce2010-05-18 11:58:33 -0400698# list will mention the files that were used to generate the documentation.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700699# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400700
701SHOW_USED_FILES = YES
702
Yunqing Wangda924eb2020-05-01 16:34:11 -0700703# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
704# will remove the Files entry from the Quick Index and from the Folder Tree View
705# (if specified).
706# The default value is: YES.
707
708SHOW_FILES = YES
709
710# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
711# page. This will remove the Namespaces entry from the Quick Index and from the
712# Folder Tree View (if specified).
713# The default value is: YES.
714
715SHOW_NAMESPACES = YES
716
John Koleszar0ea50ce2010-05-18 11:58:33 -0400717# The FILE_VERSION_FILTER tag can be used to specify a program or script that
Yunqing Wangda924eb2020-05-01 16:34:11 -0700718# doxygen should invoke to get the current version for each file (typically from
719# the version control system). Doxygen will invoke the program by executing (via
720# popen()) the command command input-file, where command is the value of the
721# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
722# by doxygen. Whatever the program writes to standard output is used as the file
723# version. For an example see the documentation.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400724
725FILE_VERSION_FILTER =
726
Yunqing Wangda924eb2020-05-01 16:34:11 -0700727# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
728# by doxygen. The layout file controls the global structure of the generated
729# output files in an output format independent way. To create the layout file
730# that represents doxygen's defaults, run doxygen with the -l option. You can
731# optionally specify a file name after the option, if omitted DoxygenLayout.xml
732# will be used as the name of the layout file.
733#
734# Note that if you run doxygen from a directory containing a file called
735# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
736# tag is left empty.
737
738LAYOUT_FILE =
739
740# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
741# the reference definitions. This must be a list of .bib files. The .bib
742# extension is automatically appended if omitted. This requires the bibtex tool
743# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
744# For LaTeX the style of the bibliography can be controlled using
745# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
746# search path. See also \cite for info how to create references.
747
748CITE_BIB_FILES =
749
John Koleszar0ea50ce2010-05-18 11:58:33 -0400750#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -0700751# Configuration options related to warning and progress messages
John Koleszar0ea50ce2010-05-18 11:58:33 -0400752#---------------------------------------------------------------------------
753
Yunqing Wangda924eb2020-05-01 16:34:11 -0700754# The QUIET tag can be used to turn on/off the messages that are generated to
755# standard output by doxygen. If QUIET is set to YES this implies that the
756# messages are off.
757# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400758
759QUIET = YES
760
761# The WARNINGS tag can be used to turn on/off the warning messages that are
Yunqing Wangda924eb2020-05-01 16:34:11 -0700762# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
763# this implies that the warnings are on.
764#
765# Tip: Turn warnings on while writing the documentation.
766# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400767
768WARNINGS = YES
769
Yunqing Wangda924eb2020-05-01 16:34:11 -0700770# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
771# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
772# will automatically be disabled.
773# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400774
775WARN_IF_UNDOCUMENTED = YES
776
Yunqing Wangda924eb2020-05-01 16:34:11 -0700777# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
778# potential errors in the documentation, such as not documenting some parameters
779# in a documented function, or documenting parameters that don't exist or using
780# markup commands wrongly.
781# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400782
783WARN_IF_DOC_ERROR = YES
784
Yunqing Wangda924eb2020-05-01 16:34:11 -0700785# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
786# are documented, but have no documentation for their parameters or return
787# value. If set to NO, doxygen will only warn about wrong or incomplete
788# parameter documentation, but not about the absence of documentation. If
789# EXTRACT_ALL is set to YES then this flag will automatically be disabled.
790# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400791
792WARN_NO_PARAMDOC = NO
793
Yunqing Wangda924eb2020-05-01 16:34:11 -0700794# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
795# a warning is encountered.
796# The default value is: NO.
797
798WARN_AS_ERROR = NO
799
800# The WARN_FORMAT tag determines the format of the warning messages that doxygen
801# can produce. The string should contain the $file, $line, and $text tags, which
802# will be replaced by the file and line number from which the warning originated
803# and the warning text. Optionally the format may contain $version, which will
804# be replaced by the version of the file (if it could be obtained via
805# FILE_VERSION_FILTER)
806# The default value is: $file:$line: $text.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400807
808WARN_FORMAT = "$file:$line: $text"
809
Yunqing Wangda924eb2020-05-01 16:34:11 -0700810# The WARN_LOGFILE tag can be used to specify a file to which warning and error
811# messages should be written. If left blank the output is written to standard
812# error (stderr).
John Koleszar0ea50ce2010-05-18 11:58:33 -0400813
814WARN_LOGFILE =
815
816#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -0700817# Configuration options related to the input files
John Koleszar0ea50ce2010-05-18 11:58:33 -0400818#---------------------------------------------------------------------------
819
Yunqing Wangda924eb2020-05-01 16:34:11 -0700820# The INPUT tag is used to specify the files and/or directories that contain
821# documented source files. You may enter file names like myfile.cpp or
822# directories like /usr/src/myproject. Separate the files or directories with
823# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
824# Note: If this tag is empty the current directory is searched.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400825
Yunqing Wangda924eb2020-05-01 16:34:11 -0700826INPUT =
John Koleszar0ea50ce2010-05-18 11:58:33 -0400827
Yunqing Wangda924eb2020-05-01 16:34:11 -0700828# This tag can be used to specify the character encoding of the source files
829# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
830# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
831# documentation (see: https://www.gnu.org/software/libiconv/) for the list of
832# possible encodings.
833# The default value is: UTF-8.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400834
835INPUT_ENCODING = UTF-8
836
837# If the value of the INPUT tag contains directories, you can use the
Yunqing Wangda924eb2020-05-01 16:34:11 -0700838# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
839# *.h) to filter out the source-files in the directories.
840#
841# Note that for custom extensions or not directly supported extensions you also
842# need to set EXTENSION_MAPPING for the extension otherwise the files are not
843# read by doxygen.
844#
845# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
846# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
847# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
848# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
849# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400850
851FILE_PATTERNS =
852
Yunqing Wangda924eb2020-05-01 16:34:11 -0700853# The RECURSIVE tag can be used to specify whether or not subdirectories should
854# be searched for input files as well.
855# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400856
857RECURSIVE = NO
858
Yunqing Wangda924eb2020-05-01 16:34:11 -0700859# The EXCLUDE tag can be used to specify files and/or directories that should be
John Koleszar0ea50ce2010-05-18 11:58:33 -0400860# excluded from the INPUT source files. This way you can easily exclude a
861# subdirectory from a directory tree whose root is specified with the INPUT tag.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700862#
863# Note that relative paths are relative to the directory from which doxygen is
864# run.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400865
866EXCLUDE =
867
Yunqing Wangda924eb2020-05-01 16:34:11 -0700868# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
869# directories that are symbolic links (a Unix file system feature) are excluded
John Koleszar0ea50ce2010-05-18 11:58:33 -0400870# from the input.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700871# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400872
873EXCLUDE_SYMLINKS = NO
874
875# If the value of the INPUT tag contains directories, you can use the
876# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
Yunqing Wangda924eb2020-05-01 16:34:11 -0700877# certain files from those directories.
878#
879# Note that the wildcards are matched against the file with absolute path, so to
880# exclude all test directories for example use the pattern */test/*
John Koleszar0ea50ce2010-05-18 11:58:33 -0400881
882EXCLUDE_PATTERNS =
883
884# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
Yunqing Wangda924eb2020-05-01 16:34:11 -0700885# (namespaces, classes, functions, etc.) that should be excluded from the
886# output. The symbol name can be a fully qualified name, a word, or if the
887# wildcard * is used, a substring. Examples: ANamespace, AClass,
888# AClass::ANamespace, ANamespace::*Test
889#
890# Note that the wildcards are matched against the file with absolute path, so to
891# exclude all test directories use the pattern */test/*
John Koleszar0ea50ce2010-05-18 11:58:33 -0400892
893EXCLUDE_SYMBOLS =
894
Yunqing Wangda924eb2020-05-01 16:34:11 -0700895# The EXAMPLE_PATH tag can be used to specify one or more files or directories
896# that contain example code fragments that are included (see the \include
897# command).
John Koleszar0ea50ce2010-05-18 11:58:33 -0400898
899EXAMPLE_PATH =
900
901# If the value of the EXAMPLE_PATH tag contains directories, you can use the
Yunqing Wangda924eb2020-05-01 16:34:11 -0700902# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
903# *.h) to filter out the source-files in the directories. If left blank all
904# files are included.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400905
906EXAMPLE_PATTERNS =
907
908# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
Yunqing Wangda924eb2020-05-01 16:34:11 -0700909# searched for input files to be used with the \include or \dontinclude commands
910# irrespective of the value of the RECURSIVE tag.
911# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400912
913EXAMPLE_RECURSIVE = NO
914
Yunqing Wangda924eb2020-05-01 16:34:11 -0700915# The IMAGE_PATH tag can be used to specify one or more files or directories
916# that contain images that are to be included in the documentation (see the
917# \image command).
John Koleszar0ea50ce2010-05-18 11:58:33 -0400918
919IMAGE_PATH =
920
921# The INPUT_FILTER tag can be used to specify a program that doxygen should
922# invoke to filter for each input file. Doxygen will invoke the filter program
Yunqing Wangda924eb2020-05-01 16:34:11 -0700923# by executing (via popen()) the command:
924#
925# <filter> <input-file>
926#
927# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
928# name of an input file. Doxygen will then use the output that the filter
929# program writes to standard output. If FILTER_PATTERNS is specified, this tag
930# will be ignored.
931#
932# Note that the filter must not add or remove lines; it is applied before the
933# code is scanned, but not when the output code is generated. If lines are added
934# or removed, the anchors will not be placed correctly.
935#
936# Note that for custom extensions or not directly supported extensions you also
937# need to set EXTENSION_MAPPING for the extension otherwise the files are not
938# properly processed by doxygen.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400939
940INPUT_FILTER =
941
942# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
Yunqing Wangda924eb2020-05-01 16:34:11 -0700943# basis. Doxygen will compare the file name with each pattern and apply the
944# filter if there is a match. The filters are a list of the form: pattern=filter
945# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
946# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
947# patterns match the file name, INPUT_FILTER is applied.
948#
949# Note that for custom extensions or not directly supported extensions you also
950# need to set EXTENSION_MAPPING for the extension otherwise the files are not
951# properly processed by doxygen.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400952
953FILTER_PATTERNS =
954
955# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
Yunqing Wangda924eb2020-05-01 16:34:11 -0700956# INPUT_FILTER) will also be used to filter the input files that are used for
957# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
958# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400959
960FILTER_SOURCE_FILES = NO
961
Yunqing Wangda924eb2020-05-01 16:34:11 -0700962# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
963# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
964# it is also possible to disable source filtering for a specific pattern using
965# *.ext= (so without naming a filter).
966# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
967
968FILTER_SOURCE_PATTERNS =
969
970# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
971# is part of the input, its contents will be placed on the main page
972# (index.html). This can be useful if you have a project on for instance GitHub
973# and want to reuse the introduction page also for the doxygen output.
974
975USE_MDFILE_AS_MAINPAGE =
976
John Koleszar0ea50ce2010-05-18 11:58:33 -0400977#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -0700978# Configuration options related to source browsing
John Koleszar0ea50ce2010-05-18 11:58:33 -0400979#---------------------------------------------------------------------------
980
Yunqing Wangda924eb2020-05-01 16:34:11 -0700981# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
982# generated. Documented entities will be cross-referenced with these sources.
983#
984# Note: To get rid of all source code in the generated output, make sure that
985# also VERBATIM_HEADERS is set to NO.
986# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400987
988SOURCE_BROWSER = NO
989
Yunqing Wangda924eb2020-05-01 16:34:11 -0700990# Setting the INLINE_SOURCES tag to YES will include the body of functions,
991# classes and enums directly into the documentation.
992# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400993
994INLINE_SOURCES = NO
995
Yunqing Wangda924eb2020-05-01 16:34:11 -0700996# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
997# special comment blocks from generated source code fragments. Normal C, C++ and
998# Fortran comments will always remain visible.
999# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001000
1001STRIP_CODE_COMMENTS = YES
1002
Yunqing Wangda924eb2020-05-01 16:34:11 -07001003# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1004# entity all documented functions referencing it will be listed.
1005# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001006
1007REFERENCED_BY_RELATION = YES
1008
Yunqing Wangda924eb2020-05-01 16:34:11 -07001009# If the REFERENCES_RELATION tag is set to YES then for each documented function
1010# all documented entities called/used by that function will be listed.
1011# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001012
1013REFERENCES_RELATION = YES
1014
Yunqing Wangda924eb2020-05-01 16:34:11 -07001015# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1016# to YES then the hyperlinks from functions in REFERENCES_RELATION and
1017# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1018# link to the documentation.
1019# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001020
1021REFERENCES_LINK_SOURCE = YES
1022
Yunqing Wangda924eb2020-05-01 16:34:11 -07001023# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1024# source code will show a tooltip with additional information such as prototype,
1025# brief description and links to the definition and documentation. Since this
1026# will make the HTML file larger and loading of large files a bit slower, you
1027# can opt to disable this feature.
1028# The default value is: YES.
1029# This tag requires that the tag SOURCE_BROWSER is set to YES.
1030
1031SOURCE_TOOLTIPS = YES
1032
1033# If the USE_HTAGS tag is set to YES then the references to source code will
1034# point to the HTML generated by the htags(1) tool instead of doxygen built-in
1035# source browser. The htags tool is part of GNU's global source tagging system
1036# (see https://www.gnu.org/software/global/global.html). You will need version
1037# 4.8.6 or higher.
1038#
1039# To use it do the following:
1040# - Install the latest version of global
1041# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1042# - Make sure the INPUT points to the root of the source tree
1043# - Run doxygen as normal
1044#
1045# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1046# tools must be available from the command line (i.e. in the search path).
1047#
1048# The result: instead of the source browser generated by doxygen, the links to
1049# source code will now point to the output of htags.
1050# The default value is: NO.
1051# This tag requires that the tag SOURCE_BROWSER is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001052
1053USE_HTAGS = NO
1054
Yunqing Wangda924eb2020-05-01 16:34:11 -07001055# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1056# verbatim copy of the header file for each class for which an include is
1057# specified. Set to NO to disable this.
1058# See also: Section \class.
1059# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001060
1061VERBATIM_HEADERS = YES
1062
Yunqing Wangda924eb2020-05-01 16:34:11 -07001063# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1064# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1065# cost of reduced performance. This can be particularly helpful with template
1066# rich C++ code for which doxygen's built-in parser lacks the necessary type
1067# information.
1068# Note: The availability of this option depends on whether or not doxygen was
1069# generated with the -Duse_libclang=ON option for CMake.
1070# The default value is: NO.
1071
1072CLANG_ASSISTED_PARSING = NO
1073
1074# If clang assisted parsing is enabled you can provide the compiler with command
1075# line options that you would normally use when invoking the compiler. Note that
1076# the include paths will already be set by doxygen for the files and directories
1077# specified with INPUT and INCLUDE_PATH.
1078# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1079
1080CLANG_OPTIONS =
1081
1082# If clang assisted parsing is enabled you can provide the clang parser with the
1083# path to the compilation database (see:
1084# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files
1085# were built. This is equivalent to specifying the "-p" option to a clang tool,
1086# such as clang-check. These options will then be passed to the parser.
1087# Note: The availability of this option depends on whether or not doxygen was
1088# generated with the -Duse_libclang=ON option for CMake.
1089
1090CLANG_DATABASE_PATH =
1091
John Koleszar0ea50ce2010-05-18 11:58:33 -04001092#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -07001093# Configuration options related to the alphabetical class index
John Koleszar0ea50ce2010-05-18 11:58:33 -04001094#---------------------------------------------------------------------------
1095
Yunqing Wangda924eb2020-05-01 16:34:11 -07001096# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1097# compounds will be generated. Enable this if the project contains a lot of
1098# classes, structs, unions or interfaces.
1099# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001100
1101ALPHABETICAL_INDEX = NO
John Koleszar0ea50ce2010-05-18 11:58:33 -04001102
Yunqing Wangda924eb2020-05-01 16:34:11 -07001103# In case all classes in a project start with a common prefix, all classes will
1104# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1105# can be used to specify a prefix (or a list of prefixes) that should be ignored
1106# while generating the index headers.
1107# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001108
1109IGNORE_PREFIX =
1110
1111#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -07001112# Configuration options related to the HTML output
John Koleszar0ea50ce2010-05-18 11:58:33 -04001113#---------------------------------------------------------------------------
1114
Yunqing Wangda924eb2020-05-01 16:34:11 -07001115# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1116# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001117
1118GENERATE_HTML = YES
1119
Yunqing Wangda924eb2020-05-01 16:34:11 -07001120# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1121# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1122# it.
1123# The default directory is: html.
1124# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001125
1126HTML_OUTPUT = html
1127
Yunqing Wangda924eb2020-05-01 16:34:11 -07001128# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1129# generated HTML page (for example: .htm, .php, .asp).
1130# The default value is: .html.
1131# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001132
1133HTML_FILE_EXTENSION = .html
1134
Yunqing Wangda924eb2020-05-01 16:34:11 -07001135# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1136# each generated HTML page. If the tag is left blank doxygen will generate a
John Koleszar0ea50ce2010-05-18 11:58:33 -04001137# standard header.
Yunqing Wangda924eb2020-05-01 16:34:11 -07001138#
1139# To get valid HTML the header file that includes any scripts and style sheets
1140# that doxygen needs, which is dependent on the configuration options used (e.g.
1141# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1142# default header using
1143# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1144# YourConfigFile
1145# and then modify the file new_header.html. See also section "Doxygen usage"
1146# for information on how to generate the default header that doxygen normally
1147# uses.
1148# Note: The header is subject to change so you typically have to regenerate the
1149# default header when upgrading to a newer version of doxygen. For a description
1150# of the possible markers and block names see the documentation.
1151# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001152
1153HTML_HEADER =
1154
Yunqing Wangda924eb2020-05-01 16:34:11 -07001155# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1156# generated HTML page. If the tag is left blank doxygen will generate a standard
1157# footer. See HTML_HEADER for more information on how to generate a default
1158# footer and what special commands can be used inside the footer. See also
1159# section "Doxygen usage" for information on how to generate the default footer
1160# that doxygen normally uses.
1161# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001162
1163HTML_FOOTER =
1164
Yunqing Wangda924eb2020-05-01 16:34:11 -07001165# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1166# sheet that is used by each HTML page. It can be used to fine-tune the look of
1167# the HTML output. If left blank doxygen will generate a default style sheet.
1168# See also section "Doxygen usage" for information on how to generate the style
1169# sheet that doxygen normally uses.
1170# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1171# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1172# obsolete.
1173# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001174
1175HTML_STYLESHEET =
1176
Yunqing Wangda924eb2020-05-01 16:34:11 -07001177# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1178# cascading style sheets that are included after the standard style sheets
1179# created by doxygen. Using this option one can overrule certain style aspects.
1180# This is preferred over using HTML_STYLESHEET since it does not replace the
1181# standard style sheet and is therefore more robust against future updates.
1182# Doxygen will copy the style sheet files to the output directory.
1183# Note: The order of the extra style sheet files is of importance (e.g. the last
1184# style sheet in the list overrules the setting of the previous ones in the
1185# list). For an example see the documentation.
1186# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001187
Yunqing Wangda924eb2020-05-01 16:34:11 -07001188HTML_EXTRA_STYLESHEET =
1189
1190# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1191# other source files which should be copied to the HTML output directory. Note
1192# that these files will be copied to the base HTML output directory. Use the
1193# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1194# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1195# files will be copied as-is; there are no commands or markers available.
1196# This tag requires that the tag GENERATE_HTML is set to YES.
1197
1198HTML_EXTRA_FILES =
1199
1200# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1201# will adjust the colors in the style sheet and background images according to
1202# this color. Hue is specified as an angle on a colorwheel, see
1203# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1204# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1205# purple, and 360 is red again.
1206# Minimum value: 0, maximum value: 359, default value: 220.
1207# This tag requires that the tag GENERATE_HTML is set to YES.
1208
1209HTML_COLORSTYLE_HUE = 220
1210
1211# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1212# in the HTML output. For a value of 0 the output will use grayscales only. A
1213# value of 255 will produce the most vivid colors.
1214# Minimum value: 0, maximum value: 255, default value: 100.
1215# This tag requires that the tag GENERATE_HTML is set to YES.
1216
1217HTML_COLORSTYLE_SAT = 100
1218
1219# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1220# luminance component of the colors in the HTML output. Values below 100
1221# gradually make the output lighter, whereas values above 100 make the output
1222# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1223# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1224# change the gamma.
1225# Minimum value: 40, maximum value: 240, default value: 80.
1226# This tag requires that the tag GENERATE_HTML is set to YES.
1227
1228HTML_COLORSTYLE_GAMMA = 80
1229
1230# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1231# page will contain the date and time when the page was generated. Setting this
1232# to YES can help to show when doxygen was last run and thus if the
1233# documentation is up to date.
1234# The default value is: NO.
1235# This tag requires that the tag GENERATE_HTML is set to YES.
1236
1237HTML_TIMESTAMP = NO
1238
1239# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1240# documentation will contain a main index with vertical navigation menus that
1241# are dynamically created via Javascript. If disabled, the navigation index will
1242# consists of multiple levels of tabs that are statically embedded in every HTML
1243# page. Disable this option to support browsers that do not have Javascript,
1244# like the Qt help browser.
1245# The default value is: YES.
1246# This tag requires that the tag GENERATE_HTML is set to YES.
1247
1248HTML_DYNAMIC_MENUS = YES
John Koleszar0ea50ce2010-05-18 11:58:33 -04001249
1250# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1251# documentation will contain sections that can be hidden and shown after the
Yunqing Wangda924eb2020-05-01 16:34:11 -07001252# page has loaded.
1253# The default value is: NO.
1254# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001255
1256HTML_DYNAMIC_SECTIONS = NO
1257
Yunqing Wangda924eb2020-05-01 16:34:11 -07001258# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1259# shown in the various tree structured indices initially; the user can expand
1260# and collapse entries dynamically later on. Doxygen will expand the tree to
1261# such a level that at most the specified number of entries are visible (unless
1262# a fully collapsed tree already exceeds this amount). So setting the number of
1263# entries 1 will produce a full collapsed tree by default. 0 is a special value
1264# representing an infinite number of entries and will result in a full expanded
1265# tree by default.
1266# Minimum value: 0, maximum value: 9999, default value: 100.
1267# This tag requires that the tag GENERATE_HTML is set to YES.
1268
1269HTML_INDEX_NUM_ENTRIES = 100
1270
1271# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1272# generated that can be used as input for Apple's Xcode 3 integrated development
1273# environment (see: https://developer.apple.com/xcode/), introduced with OSX
1274# 10.5 (Leopard). To create a documentation set, doxygen will generate a
1275# Makefile in the HTML output directory. Running make will produce the docset in
1276# that directory and running make install will install the docset in
1277# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1278# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1279# genXcode/_index.html for more information.
1280# The default value is: NO.
1281# This tag requires that the tag GENERATE_HTML is set to YES.
1282
1283GENERATE_DOCSET = NO
1284
1285# This tag determines the name of the docset feed. A documentation feed provides
1286# an umbrella under which multiple documentation sets from a single provider
1287# (such as a company or product suite) can be grouped.
1288# The default value is: Doxygen generated docs.
1289# This tag requires that the tag GENERATE_DOCSET is set to YES.
1290
1291DOCSET_FEEDNAME = "Doxygen generated docs"
1292
1293# This tag specifies a string that should uniquely identify the documentation
1294# set bundle. This should be a reverse domain-name style string, e.g.
1295# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1296# The default value is: org.doxygen.Project.
1297# This tag requires that the tag GENERATE_DOCSET is set to YES.
1298
1299DOCSET_BUNDLE_ID = org.doxygen.Project
1300
1301# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1302# the documentation publisher. This should be a reverse domain-name style
1303# string, e.g. com.mycompany.MyDocSet.documentation.
1304# The default value is: org.doxygen.Publisher.
1305# This tag requires that the tag GENERATE_DOCSET is set to YES.
1306
1307DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1308
1309# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1310# The default value is: Publisher.
1311# This tag requires that the tag GENERATE_DOCSET is set to YES.
1312
1313DOCSET_PUBLISHER_NAME = Publisher
1314
1315# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1316# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1317# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1318# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1319# Windows.
1320#
1321# The HTML Help Workshop contains a compiler that can convert all HTML output
1322# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1323# files are now used as the Windows 98 help format, and will replace the old
1324# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1325# HTML files also contain an index, a table of contents, and you can search for
1326# words in the documentation. The HTML workshop also contains a viewer for
1327# compressed HTML files.
1328# The default value is: NO.
1329# This tag requires that the tag GENERATE_HTML is set to YES.
1330
1331GENERATE_HTMLHELP = NO
1332
1333# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1334# file. You can add a path in front of the file if the result should not be
John Koleszar0ea50ce2010-05-18 11:58:33 -04001335# written to the html output directory.
Yunqing Wangda924eb2020-05-01 16:34:11 -07001336# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001337
1338CHM_FILE =
1339
Yunqing Wangda924eb2020-05-01 16:34:11 -07001340# The HHC_LOCATION tag can be used to specify the location (absolute path
1341# including file name) of the HTML help compiler (hhc.exe). If non-empty,
1342# doxygen will try to run the HTML help compiler on the generated index.hhp.
1343# The file has to be specified with full path.
1344# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001345
1346HHC_LOCATION =
1347
Yunqing Wangda924eb2020-05-01 16:34:11 -07001348# The GENERATE_CHI flag controls if a separate .chi index file is generated
1349# (YES) or that it should be included in the master .chm file (NO).
1350# The default value is: NO.
1351# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001352
1353GENERATE_CHI = NO
1354
Yunqing Wangda924eb2020-05-01 16:34:11 -07001355# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1356# and project file content.
1357# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1358
1359CHM_INDEX_ENCODING =
1360
1361# The BINARY_TOC flag controls whether a binary table of contents is generated
1362# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1363# enables the Previous and Next buttons.
1364# The default value is: NO.
1365# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001366
1367BINARY_TOC = NO
1368
Yunqing Wangda924eb2020-05-01 16:34:11 -07001369# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1370# the table of contents of the HTML help documentation and to the tree view.
1371# The default value is: NO.
1372# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001373
1374TOC_EXPAND = NO
1375
Yunqing Wangda924eb2020-05-01 16:34:11 -07001376# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1377# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1378# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1379# (.qch) of the generated HTML documentation.
1380# The default value is: NO.
1381# This tag requires that the tag GENERATE_HTML is set to YES.
1382
1383GENERATE_QHP = NO
1384
1385# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1386# the file name of the resulting .qch file. The path specified is relative to
1387# the HTML output folder.
1388# This tag requires that the tag GENERATE_QHP is set to YES.
1389
1390QCH_FILE =
1391
1392# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1393# Project output. For more information please see Qt Help Project / Namespace
1394# (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1395# The default value is: org.doxygen.Project.
1396# This tag requires that the tag GENERATE_QHP is set to YES.
1397
1398QHP_NAMESPACE = org.doxygen.Project
1399
1400# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1401# Help Project output. For more information please see Qt Help Project / Virtual
1402# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-
1403# folders).
1404# The default value is: doc.
1405# This tag requires that the tag GENERATE_QHP is set to YES.
1406
1407QHP_VIRTUAL_FOLDER = doc
1408
1409# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1410# filter to add. For more information please see Qt Help Project / Custom
1411# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
1412# filters).
1413# This tag requires that the tag GENERATE_QHP is set to YES.
1414
1415QHP_CUST_FILTER_NAME =
1416
1417# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1418# custom filter to add. For more information please see Qt Help Project / Custom
1419# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
1420# filters).
1421# This tag requires that the tag GENERATE_QHP is set to YES.
1422
1423QHP_CUST_FILTER_ATTRS =
1424
1425# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1426# project's filter section matches. Qt Help Project / Filter Attributes (see:
1427# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1428# This tag requires that the tag GENERATE_QHP is set to YES.
1429
1430QHP_SECT_FILTER_ATTRS =
1431
1432# The QHG_LOCATION tag can be used to specify the location of Qt's
1433# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1434# generated .qhp file.
1435# This tag requires that the tag GENERATE_QHP is set to YES.
1436
1437QHG_LOCATION =
1438
1439# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1440# generated, together with the HTML files, they form an Eclipse help plugin. To
1441# install this plugin and make it available under the help contents menu in
1442# Eclipse, the contents of the directory containing the HTML and XML files needs
1443# to be copied into the plugins directory of eclipse. The name of the directory
1444# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1445# After copying Eclipse needs to be restarted before the help appears.
1446# The default value is: NO.
1447# This tag requires that the tag GENERATE_HTML is set to YES.
1448
1449GENERATE_ECLIPSEHELP = NO
1450
1451# A unique identifier for the Eclipse help plugin. When installing the plugin
1452# the directory name containing the HTML and XML files should also have this
1453# name. Each documentation set should have its own identifier.
1454# The default value is: org.doxygen.Project.
1455# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1456
1457ECLIPSE_DOC_ID = org.doxygen.Project
1458
1459# If you want full control over the layout of the generated HTML pages it might
1460# be necessary to disable the index and replace it with your own. The
1461# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1462# of each HTML page. A value of NO enables the index and the value YES disables
1463# it. Since the tabs in the index contain the same information as the navigation
1464# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1465# The default value is: NO.
1466# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001467
1468DISABLE_INDEX = NO
1469
Yunqing Wangda924eb2020-05-01 16:34:11 -07001470# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1471# structure should be generated to display hierarchical information. If the tag
1472# value is set to YES, a side panel will be generated containing a tree-like
1473# index structure (just like the one that is generated for HTML Help). For this
1474# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1475# (i.e. any modern browser). Windows users are probably better off using the
1476# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1477# further fine-tune the look of the index. As an example, the default style
1478# sheet generated by doxygen has an example that shows how to put an image at
1479# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1480# the same information as the tab index, you could consider setting
1481# DISABLE_INDEX to YES when enabling this option.
1482# The default value is: NO.
1483# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001484
Yunqing Wangab4ab5a2020-05-04 15:09:35 -07001485GENERATE_TREEVIEW = YES
John Koleszar0ea50ce2010-05-18 11:58:33 -04001486
Yunqing Wangda924eb2020-05-01 16:34:11 -07001487# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1488# doxygen will group on one line in the generated HTML documentation.
1489#
1490# Note that a value of 0 will completely suppress the enum values from appearing
1491# in the overview section.
1492# Minimum value: 0, maximum value: 20, default value: 4.
1493# This tag requires that the tag GENERATE_HTML is set to YES.
1494
1495ENUM_VALUES_PER_LINE = 4
1496
1497# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1498# to set the initial width (in pixels) of the frame in which the tree is shown.
1499# Minimum value: 0, maximum value: 1500, default value: 250.
1500# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001501
1502TREEVIEW_WIDTH = 250
1503
Yunqing Wangda924eb2020-05-01 16:34:11 -07001504# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1505# external symbols imported via tag files in a separate window.
1506# The default value is: NO.
1507# This tag requires that the tag GENERATE_HTML is set to YES.
1508
1509EXT_LINKS_IN_WINDOW = NO
1510
1511# Use this tag to change the font size of LaTeX formulas included as images in
1512# the HTML documentation. When you change the font size after a successful
1513# doxygen run you need to manually remove any form_*.png images from the HTML
1514# output directory to force them to be regenerated.
1515# Minimum value: 8, maximum value: 50, default value: 10.
1516# This tag requires that the tag GENERATE_HTML is set to YES.
1517
1518FORMULA_FONTSIZE = 10
1519
1520# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1521# generated for formulas are transparent PNGs. Transparent PNGs are not
1522# supported properly for IE 6.0, but are supported on all modern browsers.
1523#
1524# Note that when changing this option you need to delete any form_*.png files in
1525# the HTML output directory before the changes have effect.
1526# The default value is: YES.
1527# This tag requires that the tag GENERATE_HTML is set to YES.
1528
1529FORMULA_TRANSPARENT = YES
1530
1531# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1532# https://www.mathjax.org) which uses client side Javascript for the rendering
1533# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1534# installed or if you want to formulas look prettier in the HTML output. When
1535# enabled you may also need to install MathJax separately and configure the path
1536# to it using the MATHJAX_RELPATH option.
1537# The default value is: NO.
1538# This tag requires that the tag GENERATE_HTML is set to YES.
1539
Yunqing Wangc7c0f272020-05-08 14:15:09 -07001540USE_MATHJAX = YES
Yunqing Wangda924eb2020-05-01 16:34:11 -07001541
1542# When MathJax is enabled you can set the default output format to be used for
1543# the MathJax output. See the MathJax site (see:
1544# http://docs.mathjax.org/en/latest/output.html) for more details.
1545# Possible values are: HTML-CSS (which is slower, but has the best
1546# compatibility), NativeMML (i.e. MathML) and SVG.
1547# The default value is: HTML-CSS.
1548# This tag requires that the tag USE_MATHJAX is set to YES.
1549
1550MATHJAX_FORMAT = HTML-CSS
1551
1552# When MathJax is enabled you need to specify the location relative to the HTML
1553# output directory using the MATHJAX_RELPATH option. The destination directory
1554# should contain the MathJax.js script. For instance, if the mathjax directory
1555# is located at the same level as the HTML output directory, then
1556# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1557# Content Delivery Network so you can quickly see the result without installing
1558# MathJax. However, it is strongly recommended to install a local copy of
1559# MathJax from https://www.mathjax.org before deployment.
1560# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/.
1561# This tag requires that the tag USE_MATHJAX is set to YES.
1562
1563MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/
1564
1565# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1566# extension names that should be enabled during MathJax rendering. For example
1567# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1568# This tag requires that the tag USE_MATHJAX is set to YES.
1569
1570MATHJAX_EXTENSIONS =
1571
1572# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1573# of code that will be used on startup of the MathJax code. See the MathJax site
1574# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1575# example see the documentation.
1576# This tag requires that the tag USE_MATHJAX is set to YES.
1577
1578MATHJAX_CODEFILE =
1579
1580# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1581# the HTML output. The underlying search engine uses javascript and DHTML and
1582# should work on any modern browser. Note that when using HTML help
1583# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1584# there is already a search function so this one should typically be disabled.
1585# For large projects the javascript based search engine can be slow, then
1586# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1587# search using the keyboard; to jump to the search box use <access key> + S
1588# (what the <access key> is depends on the OS and browser, but it is typically
1589# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1590# key> to jump into the search results window, the results can be navigated
1591# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1592# the search. The filter options can be selected when the cursor is inside the
1593# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1594# to select a filter and <Enter> or <escape> to activate or cancel the filter
1595# option.
1596# The default value is: YES.
1597# This tag requires that the tag GENERATE_HTML is set to YES.
1598
1599SEARCHENGINE = YES
1600
1601# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1602# implemented using a web server instead of a web client using Javascript. There
1603# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1604# setting. When disabled, doxygen will generate a PHP script for searching and
1605# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1606# and searching needs to be provided by external tools. See the section
1607# "External Indexing and Searching" for details.
1608# The default value is: NO.
1609# This tag requires that the tag SEARCHENGINE is set to YES.
1610
1611SERVER_BASED_SEARCH = NO
1612
1613# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1614# script for searching. Instead the search results are written to an XML file
1615# which needs to be processed by an external indexer. Doxygen will invoke an
1616# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1617# search results.
1618#
1619# Doxygen ships with an example indexer (doxyindexer) and search engine
1620# (doxysearch.cgi) which are based on the open source search engine library
1621# Xapian (see: https://xapian.org/).
1622#
1623# See the section "External Indexing and Searching" for details.
1624# The default value is: NO.
1625# This tag requires that the tag SEARCHENGINE is set to YES.
1626
1627EXTERNAL_SEARCH = NO
1628
1629# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1630# which will return the search results when EXTERNAL_SEARCH is enabled.
1631#
1632# Doxygen ships with an example indexer (doxyindexer) and search engine
1633# (doxysearch.cgi) which are based on the open source search engine library
1634# Xapian (see: https://xapian.org/). See the section "External Indexing and
1635# Searching" for details.
1636# This tag requires that the tag SEARCHENGINE is set to YES.
1637
1638SEARCHENGINE_URL =
1639
1640# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1641# search data is written to a file for indexing by an external tool. With the
1642# SEARCHDATA_FILE tag the name of this file can be specified.
1643# The default file is: searchdata.xml.
1644# This tag requires that the tag SEARCHENGINE is set to YES.
1645
1646SEARCHDATA_FILE = searchdata.xml
1647
1648# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1649# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1650# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1651# projects and redirect the results back to the right project.
1652# This tag requires that the tag SEARCHENGINE is set to YES.
1653
1654EXTERNAL_SEARCH_ID =
1655
1656# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1657# projects other than the one defined by this configuration file, but that are
1658# all added to the same external search index. Each project needs to have a
1659# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1660# to a relative location where the documentation can be found. The format is:
1661# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1662# This tag requires that the tag SEARCHENGINE is set to YES.
1663
1664EXTRA_SEARCH_MAPPINGS =
1665
John Koleszar0ea50ce2010-05-18 11:58:33 -04001666#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -07001667# Configuration options related to the LaTeX output
John Koleszar0ea50ce2010-05-18 11:58:33 -04001668#---------------------------------------------------------------------------
1669
Yunqing Wangda924eb2020-05-01 16:34:11 -07001670# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1671# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001672
1673GENERATE_LATEX = YES
1674
Yunqing Wangda924eb2020-05-01 16:34:11 -07001675# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1676# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1677# it.
1678# The default directory is: latex.
1679# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001680
1681LATEX_OUTPUT = latex
1682
Yunqing Wangda924eb2020-05-01 16:34:11 -07001683# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1684# invoked.
1685#
1686# Note that when not enabling USE_PDFLATEX the default is latex when enabling
1687# USE_PDFLATEX the default is pdflatex and when in the later case latex is
1688# chosen this is overwritten by pdflatex. For specific output languages the
1689# default can have been set differently, this depends on the implementation of
1690# the output language.
1691# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001692
1693LATEX_CMD_NAME = latex
1694
Yunqing Wangda924eb2020-05-01 16:34:11 -07001695# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1696# index for LaTeX.
1697# Note: This tag is used in the Makefile / make.bat.
1698# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
1699# (.tex).
1700# The default file is: makeindex.
1701# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001702
1703MAKEINDEX_CMD_NAME = makeindex
1704
Yunqing Wangda924eb2020-05-01 16:34:11 -07001705# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
1706# generate index for LaTeX. In case there is no backslash (\) as first character
1707# it will be automatically added in the LaTeX code.
1708# Note: This tag is used in the generated output file (.tex).
1709# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
1710# The default value is: makeindex.
1711# This tag requires that the tag GENERATE_LATEX is set to YES.
1712
1713LATEX_MAKEINDEX_CMD = makeindex
1714
1715# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1716# documents. This may be useful for small projects and may help to save some
1717# trees in general.
1718# The default value is: NO.
1719# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001720
1721COMPACT_LATEX = YES
1722
Yunqing Wangda924eb2020-05-01 16:34:11 -07001723# The PAPER_TYPE tag can be used to set the paper type that is used by the
1724# printer.
1725# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1726# 14 inches) and executive (7.25 x 10.5 inches).
1727# The default value is: a4.
1728# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001729
1730PAPER_TYPE = letter
1731
Yunqing Wangda924eb2020-05-01 16:34:11 -07001732# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1733# that should be included in the LaTeX output. The package can be specified just
1734# by its name or with the correct syntax as to be used with the LaTeX
1735# \usepackage command. To get the times font for instance you can specify :
1736# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1737# To use the option intlimits with the amsmath package you can specify:
1738# EXTRA_PACKAGES=[intlimits]{amsmath}
1739# If left blank no extra packages will be included.
1740# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001741
1742EXTRA_PACKAGES =
1743
Yunqing Wangda924eb2020-05-01 16:34:11 -07001744# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1745# generated LaTeX document. The header should contain everything until the first
1746# chapter. If it is left blank doxygen will generate a standard header. See
1747# section "Doxygen usage" for information on how to let doxygen write the
1748# default header to a separate file.
1749#
1750# Note: Only use a user-defined header if you know what you are doing! The
1751# following commands have a special meaning inside the header: $title,
1752# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1753# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1754# string, for the replacement values of the other commands the user is referred
1755# to HTML_HEADER.
1756# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001757
1758LATEX_HEADER =
1759
Yunqing Wangda924eb2020-05-01 16:34:11 -07001760# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1761# generated LaTeX document. The footer should contain everything after the last
1762# chapter. If it is left blank doxygen will generate a standard footer. See
1763# LATEX_HEADER for more information on how to generate a default footer and what
1764# special commands can be used inside the footer.
1765#
1766# Note: Only use a user-defined footer if you know what you are doing!
1767# This tag requires that the tag GENERATE_LATEX is set to YES.
1768
1769LATEX_FOOTER =
1770
1771# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1772# LaTeX style sheets that are included after the standard style sheets created
1773# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1774# will copy the style sheet files to the output directory.
1775# Note: The order of the extra style sheet files is of importance (e.g. the last
1776# style sheet in the list overrules the setting of the previous ones in the
1777# list).
1778# This tag requires that the tag GENERATE_LATEX is set to YES.
1779
1780LATEX_EXTRA_STYLESHEET =
1781
1782# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1783# other source files which should be copied to the LATEX_OUTPUT output
1784# directory. Note that the files will be copied as-is; there are no commands or
1785# markers available.
1786# This tag requires that the tag GENERATE_LATEX is set to YES.
1787
1788LATEX_EXTRA_FILES =
1789
1790# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1791# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1792# contain links (just like the HTML output) instead of page references. This
1793# makes the output suitable for online browsing using a PDF viewer.
1794# The default value is: YES.
1795# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001796
1797PDF_HYPERLINKS = YES
1798
Yunqing Wangda924eb2020-05-01 16:34:11 -07001799# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1800# the PDF file directly from the LaTeX files. Set this option to YES, to get a
John Koleszar0ea50ce2010-05-18 11:58:33 -04001801# higher quality PDF documentation.
Yunqing Wangda924eb2020-05-01 16:34:11 -07001802# The default value is: YES.
1803# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001804
1805USE_PDFLATEX = YES
1806
Yunqing Wangda924eb2020-05-01 16:34:11 -07001807# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1808# command to the generated LaTeX files. This will instruct LaTeX to keep running
1809# if errors occur, instead of asking the user for help. This option is also used
1810# when generating formulas in HTML.
1811# The default value is: NO.
1812# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001813
1814LATEX_BATCHMODE = NO
1815
Yunqing Wangda924eb2020-05-01 16:34:11 -07001816# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1817# index chapters (such as File Index, Compound Index, etc.) in the output.
1818# The default value is: NO.
1819# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001820
1821LATEX_HIDE_INDICES = NO
1822
Yunqing Wangda924eb2020-05-01 16:34:11 -07001823# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1824# code with syntax highlighting in the LaTeX output.
1825#
1826# Note that which sources are shown also depends on other settings such as
1827# SOURCE_BROWSER.
1828# The default value is: NO.
1829# This tag requires that the tag GENERATE_LATEX is set to YES.
1830
1831LATEX_SOURCE_CODE = NO
1832
1833# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1834# bibliography, e.g. plainnat, or ieeetr. See
1835# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1836# The default value is: plain.
1837# This tag requires that the tag GENERATE_LATEX is set to YES.
1838
1839LATEX_BIB_STYLE = plain
1840
1841# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1842# page will contain the date and time when the page was generated. Setting this
1843# to NO can help when comparing the output of multiple runs.
1844# The default value is: NO.
1845# This tag requires that the tag GENERATE_LATEX is set to YES.
1846
1847LATEX_TIMESTAMP = NO
1848
1849# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
1850# path from which the emoji images will be read. If a relative path is entered,
1851# it will be relative to the LATEX_OUTPUT directory. If left blank the
1852# LATEX_OUTPUT directory will be used.
1853# This tag requires that the tag GENERATE_LATEX is set to YES.
1854
1855LATEX_EMOJI_DIRECTORY =
1856
John Koleszar0ea50ce2010-05-18 11:58:33 -04001857#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -07001858# Configuration options related to the RTF output
John Koleszar0ea50ce2010-05-18 11:58:33 -04001859#---------------------------------------------------------------------------
1860
Yunqing Wangda924eb2020-05-01 16:34:11 -07001861# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1862# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1863# readers/editors.
1864# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001865
1866GENERATE_RTF = NO
1867
Yunqing Wangda924eb2020-05-01 16:34:11 -07001868# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1869# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1870# it.
1871# The default directory is: rtf.
1872# This tag requires that the tag GENERATE_RTF is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001873
1874RTF_OUTPUT = rtf
1875
Yunqing Wangda924eb2020-05-01 16:34:11 -07001876# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1877# documents. This may be useful for small projects and may help to save some
1878# trees in general.
1879# The default value is: NO.
1880# This tag requires that the tag GENERATE_RTF is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001881
1882COMPACT_RTF = NO
1883
Yunqing Wangda924eb2020-05-01 16:34:11 -07001884# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1885# contain hyperlink fields. The RTF file will contain links (just like the HTML
1886# output) instead of page references. This makes the output suitable for online
1887# browsing using Word or some other Word compatible readers that support those
1888# fields.
1889#
1890# Note: WordPad (write) and others do not support links.
1891# The default value is: NO.
1892# This tag requires that the tag GENERATE_RTF is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001893
1894RTF_HYPERLINKS = NO
1895
1896# Load stylesheet definitions from file. Syntax is similar to doxygen's
Yunqing Wangda924eb2020-05-01 16:34:11 -07001897# configuration file, i.e. a series of assignments. You only have to provide
John Koleszar0ea50ce2010-05-18 11:58:33 -04001898# replacements, missing definitions are set to their default value.
Yunqing Wangda924eb2020-05-01 16:34:11 -07001899#
1900# See also section "Doxygen usage" for information on how to generate the
1901# default style sheet that doxygen normally uses.
1902# This tag requires that the tag GENERATE_RTF is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001903
1904RTF_STYLESHEET_FILE =
1905
Yunqing Wangda924eb2020-05-01 16:34:11 -07001906# Set optional variables used in the generation of an RTF document. Syntax is
1907# similar to doxygen's configuration file. A template extensions file can be
1908# generated using doxygen -e rtf extensionFile.
1909# This tag requires that the tag GENERATE_RTF is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001910
1911RTF_EXTENSIONS_FILE =
1912
Yunqing Wangda924eb2020-05-01 16:34:11 -07001913# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1914# with syntax highlighting in the RTF output.
1915#
1916# Note that which sources are shown also depends on other settings such as
1917# SOURCE_BROWSER.
1918# The default value is: NO.
1919# This tag requires that the tag GENERATE_RTF is set to YES.
1920
1921RTF_SOURCE_CODE = NO
1922
John Koleszar0ea50ce2010-05-18 11:58:33 -04001923#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -07001924# Configuration options related to the man page output
John Koleszar0ea50ce2010-05-18 11:58:33 -04001925#---------------------------------------------------------------------------
1926
Yunqing Wangda924eb2020-05-01 16:34:11 -07001927# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1928# classes and files.
1929# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001930
1931GENERATE_MAN = NO
1932
Yunqing Wangda924eb2020-05-01 16:34:11 -07001933# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1934# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1935# it. A directory man3 will be created inside the directory specified by
1936# MAN_OUTPUT.
1937# The default directory is: man.
1938# This tag requires that the tag GENERATE_MAN is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001939
1940MAN_OUTPUT = man
1941
Yunqing Wangda924eb2020-05-01 16:34:11 -07001942# The MAN_EXTENSION tag determines the extension that is added to the generated
1943# man pages. In case the manual section does not start with a number, the number
1944# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1945# optional.
1946# The default value is: .3.
1947# This tag requires that the tag GENERATE_MAN is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001948
1949MAN_EXTENSION = .3
1950
Yunqing Wangda924eb2020-05-01 16:34:11 -07001951# The MAN_SUBDIR tag determines the name of the directory created within
1952# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1953# MAN_EXTENSION with the initial . removed.
1954# This tag requires that the tag GENERATE_MAN is set to YES.
1955
1956MAN_SUBDIR =
1957
1958# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1959# will generate one additional man file for each entity documented in the real
1960# man page(s). These additional files only source the real man page, but without
1961# them the man command would be unable to find the correct page.
1962# The default value is: NO.
1963# This tag requires that the tag GENERATE_MAN is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001964
1965MAN_LINKS = YES
1966
1967#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -07001968# Configuration options related to the DOCBOOK output
John Koleszar0ea50ce2010-05-18 11:58:33 -04001969#---------------------------------------------------------------------------
1970
Yunqing Wangda924eb2020-05-01 16:34:11 -07001971# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1972# that can be used to generate PDF.
1973# The default value is: NO.
1974
1975GENERATE_DOCBOOK = NO
1976
1977# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1978# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1979# front of it.
1980# The default directory is: docbook.
1981# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1982
1983DOCBOOK_OUTPUT = docbook
1984
1985# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1986# program listings (including syntax highlighting and cross-referencing
1987# information) to the DOCBOOK output. Note that enabling this will significantly
1988# increase the size of the DOCBOOK output.
1989# The default value is: NO.
1990# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1991
1992DOCBOOK_PROGRAMLISTING = NO
1993
1994#---------------------------------------------------------------------------
1995# Configuration options for the AutoGen Definitions output
1996#---------------------------------------------------------------------------
1997
1998# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1999# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
2000# the structure of the code including all documentation. Note that this feature
2001# is still experimental and incomplete at the moment.
2002# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002003
2004GENERATE_AUTOGEN_DEF = NO
2005
2006#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -07002007# Configuration options related to the Perl module output
John Koleszar0ea50ce2010-05-18 11:58:33 -04002008#---------------------------------------------------------------------------
2009
Yunqing Wangda924eb2020-05-01 16:34:11 -07002010# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2011# file that captures the structure of the code including all documentation.
2012#
2013# Note that this feature is still experimental and incomplete at the moment.
2014# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002015
2016GENERATE_PERLMOD = NO
2017
Yunqing Wangda924eb2020-05-01 16:34:11 -07002018# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2019# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2020# output from the Perl module output.
2021# The default value is: NO.
2022# This tag requires that the tag GENERATE_PERLMOD is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002023
2024PERLMOD_LATEX = NO
2025
Yunqing Wangda924eb2020-05-01 16:34:11 -07002026# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2027# formatted so it can be parsed by a human reader. This is useful if you want to
2028# understand what is going on. On the other hand, if this tag is set to NO, the
2029# size of the Perl module output will be much smaller and Perl will parse it
2030# just the same.
2031# The default value is: YES.
2032# This tag requires that the tag GENERATE_PERLMOD is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002033
2034PERLMOD_PRETTY = YES
2035
Yunqing Wangda924eb2020-05-01 16:34:11 -07002036# The names of the make variables in the generated doxyrules.make file are
2037# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2038# so different doxyrules.make files included by the same Makefile don't
2039# overwrite each other's variables.
2040# This tag requires that the tag GENERATE_PERLMOD is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002041
2042PERLMOD_MAKEVAR_PREFIX =
2043
2044#---------------------------------------------------------------------------
2045# Configuration options related to the preprocessor
2046#---------------------------------------------------------------------------
2047
Yunqing Wangda924eb2020-05-01 16:34:11 -07002048# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2049# C-preprocessor directives found in the sources and include files.
2050# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002051
2052ENABLE_PREPROCESSING = YES
2053
Yunqing Wangda924eb2020-05-01 16:34:11 -07002054# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2055# in the source code. If set to NO, only conditional compilation will be
2056# performed. Macro expansion can be done in a controlled way by setting
2057# EXPAND_ONLY_PREDEF to YES.
2058# The default value is: NO.
2059# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002060
2061MACRO_EXPANSION = YES
2062
Yunqing Wangda924eb2020-05-01 16:34:11 -07002063# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2064# the macro expansion is limited to the macros specified with the PREDEFINED and
2065# EXPAND_AS_DEFINED tags.
2066# The default value is: NO.
2067# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002068
2069EXPAND_ONLY_PREDEF = NO
2070
Yunqing Wangda924eb2020-05-01 16:34:11 -07002071# If the SEARCH_INCLUDES tag is set to YES, the include files in the
2072# INCLUDE_PATH will be searched if a #include is found.
2073# The default value is: YES.
2074# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002075
2076SEARCH_INCLUDES = YES
2077
2078# The INCLUDE_PATH tag can be used to specify one or more directories that
Yunqing Wangda924eb2020-05-01 16:34:11 -07002079# contain include files that are not input files but should be processed by the
2080# preprocessor.
2081# This tag requires that the tag SEARCH_INCLUDES is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002082
2083INCLUDE_PATH =
2084
2085# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2086# patterns (like *.h and *.hpp) to filter out the header-files in the
Yunqing Wangda924eb2020-05-01 16:34:11 -07002087# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2088# used.
2089# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002090
2091INCLUDE_FILE_PATTERNS = *.h
2092
Yunqing Wangda924eb2020-05-01 16:34:11 -07002093# The PREDEFINED tag can be used to specify one or more macro names that are
2094# defined before the preprocessor is started (similar to the -D option of e.g.
2095# gcc). The argument of the tag is a list of macros of the form: name or
2096# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2097# is assumed. To prevent a macro definition from being undefined via #undef or
2098# recursively expanded use the := operator instead of the = operator.
2099# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
Paul Wilkins591f0472020-07-15 15:30:56 +01002100#
Debargha Mukherjee737d6c62020-09-30 09:00:57 -07002101# In builds where CONFIG_REALTIME_ONLY is set some functions are #ifdefed out
2102# which causes reference failures. Hence for doxygen we set that to 0 here.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002103
Debargha Mukherjee737d6c62020-09-30 09:00:57 -07002104PREDEFINED = "CONFIG_REALTIME_ONLY=0"
John Koleszar0ea50ce2010-05-18 11:58:33 -04002105
Yunqing Wangda924eb2020-05-01 16:34:11 -07002106# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2107# tag can be used to specify a list of macro names that should be expanded. The
2108# macro definition that is found in the sources will be used. Use the PREDEFINED
2109# tag if you want to use a different macro definition that overrules the
2110# definition found in the source code.
2111# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002112
2113EXPAND_AS_DEFINED =
2114
Yunqing Wangda924eb2020-05-01 16:34:11 -07002115# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2116# remove all references to function-like macros that are alone on a line, have
2117# an all uppercase name, and do not end with a semicolon. Such function macros
2118# are typically used for boiler-plate code, and will confuse the parser if not
2119# removed.
2120# The default value is: YES.
2121# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002122
2123SKIP_FUNCTION_MACROS = YES
2124
2125#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -07002126# Configuration options related to external references
John Koleszar0ea50ce2010-05-18 11:58:33 -04002127#---------------------------------------------------------------------------
2128
Yunqing Wangda924eb2020-05-01 16:34:11 -07002129# The TAGFILES tag can be used to specify one or more tag files. For each tag
2130# file the location of the external documentation should be added. The format of
2131# a tag file without this location is as follows:
2132# TAGFILES = file1 file2 ...
John Koleszar0ea50ce2010-05-18 11:58:33 -04002133# Adding location for the tag files is done as follows:
Yunqing Wangda924eb2020-05-01 16:34:11 -07002134# TAGFILES = file1=loc1 "file2 = loc2" ...
2135# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2136# section "Linking to external documentation" for more information about the use
2137# of tag files.
2138# Note: Each tag file must have a unique name (where the name does NOT include
2139# the path). If a tag file is not located in the directory in which doxygen is
2140# run, you must also specify the path to the tagfile here.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002141
2142TAGFILES =
2143
Yunqing Wangda924eb2020-05-01 16:34:11 -07002144# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2145# tag file that is based on the input files it reads. See section "Linking to
2146# external documentation" for more information about the usage of tag files.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002147
2148GENERATE_TAGFILE =
2149
Yunqing Wangda924eb2020-05-01 16:34:11 -07002150# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2151# the class index. If set to NO, only the inherited external classes will be
2152# listed.
2153# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002154
2155ALLEXTERNALS = NO
2156
Yunqing Wangda924eb2020-05-01 16:34:11 -07002157# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2158# in the modules index. If set to NO, only the current project's groups will be
2159# listed.
2160# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002161
2162EXTERNAL_GROUPS = YES
2163
Yunqing Wangda924eb2020-05-01 16:34:11 -07002164# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2165# the related pages index. If set to NO, only the current project's pages will
2166# be listed.
2167# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002168
Yunqing Wangda924eb2020-05-01 16:34:11 -07002169EXTERNAL_PAGES = YES
John Koleszar0ea50ce2010-05-18 11:58:33 -04002170
2171#---------------------------------------------------------------------------
2172# Configuration options related to the dot tool
2173#---------------------------------------------------------------------------
2174
Yunqing Wangda924eb2020-05-01 16:34:11 -07002175# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2176# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2177# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2178# disabled, but it is recommended to install and use dot, since it yields more
John Koleszar0ea50ce2010-05-18 11:58:33 -04002179# powerful graphs.
Yunqing Wangda924eb2020-05-01 16:34:11 -07002180# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002181
2182CLASS_DIAGRAMS = YES
2183
Yunqing Wangda924eb2020-05-01 16:34:11 -07002184# You can include diagrams made with dia in doxygen documentation. Doxygen will
2185# then run dia to produce the diagram and insert it in the documentation. The
2186# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2187# If left empty dia is assumed to be found in the default search path.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002188
Yunqing Wangda924eb2020-05-01 16:34:11 -07002189DIA_PATH =
John Koleszar0ea50ce2010-05-18 11:58:33 -04002190
Yunqing Wangda924eb2020-05-01 16:34:11 -07002191# If set to YES the inheritance and collaboration graphs will hide inheritance
2192# and usage relations if the target is undocumented or is not a class.
2193# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002194
2195HIDE_UNDOC_RELATIONS = YES
2196
2197# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
Yunqing Wangda924eb2020-05-01 16:34:11 -07002198# available from the path. This tool is part of Graphviz (see:
2199# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2200# Bell Labs. The other options in this section have no effect if this option is
2201# set to NO
2202# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002203
Yunqing Wanged7d20c2020-05-08 11:46:37 -07002204HAVE_DOT = NO
John Koleszar0ea50ce2010-05-18 11:58:33 -04002205
Yunqing Wangda924eb2020-05-01 16:34:11 -07002206# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2207# to run in parallel. When set to 0 doxygen will base this on the number of
2208# processors available in the system. You can set it explicitly to a value
2209# larger than 0 to get control over the balance between CPU load and processing
2210# speed.
2211# Minimum value: 0, maximum value: 32, default value: 0.
2212# This tag requires that the tag HAVE_DOT is set to YES.
2213
2214DOT_NUM_THREADS = 0
2215
2216# When you want a differently looking font in the dot files that doxygen
2217# generates you can specify the font name using DOT_FONTNAME. You need to make
2218# sure dot is able to find the font, which can be done by putting it in a
2219# standard location or by setting the DOTFONTPATH environment variable or by
2220# setting DOT_FONTPATH to the directory containing the font.
2221# The default value is: Helvetica.
2222# This tag requires that the tag HAVE_DOT is set to YES.
2223
2224DOT_FONTNAME = Helvetica
2225
2226# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2227# dot graphs.
2228# Minimum value: 4, maximum value: 24, default value: 10.
2229# This tag requires that the tag HAVE_DOT is set to YES.
2230
2231DOT_FONTSIZE = 10
2232
2233# By default doxygen will tell dot to use the default font as specified with
2234# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2235# the path where dot can find it using this tag.
2236# This tag requires that the tag HAVE_DOT is set to YES.
2237
2238DOT_FONTPATH =
2239
2240# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2241# each documented class showing the direct and indirect inheritance relations.
2242# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2243# The default value is: YES.
2244# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002245
2246CLASS_GRAPH = YES
2247
Yunqing Wangda924eb2020-05-01 16:34:11 -07002248# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2249# graph for each documented class showing the direct and indirect implementation
2250# dependencies (inheritance, containment, and class references variables) of the
2251# class with other documented classes.
2252# The default value is: YES.
2253# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002254
2255COLLABORATION_GRAPH = YES
2256
Yunqing Wangda924eb2020-05-01 16:34:11 -07002257# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2258# groups, showing the direct groups dependencies.
2259# The default value is: YES.
2260# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002261
2262GROUP_GRAPHS = YES
2263
Yunqing Wangda924eb2020-05-01 16:34:11 -07002264# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
John Koleszar0ea50ce2010-05-18 11:58:33 -04002265# collaboration diagrams in a style similar to the OMG's Unified Modeling
2266# Language.
Yunqing Wangda924eb2020-05-01 16:34:11 -07002267# The default value is: NO.
2268# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002269
2270UML_LOOK = NO
2271
Yunqing Wangda924eb2020-05-01 16:34:11 -07002272# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2273# class node. If there are many fields or methods and many nodes the graph may
2274# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2275# number of items for each type to make the size more manageable. Set this to 0
2276# for no limit. Note that the threshold may be exceeded by 50% before the limit
2277# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2278# but if the number exceeds 15, the total amount of fields shown is limited to
2279# 10.
2280# Minimum value: 0, maximum value: 100, default value: 10.
2281# This tag requires that the tag HAVE_DOT is set to YES.
2282
2283UML_LIMIT_NUM_FIELDS = 10
2284
2285# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2286# collaboration graphs will show the relations between templates and their
2287# instances.
2288# The default value is: NO.
2289# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002290
2291TEMPLATE_RELATIONS = NO
2292
Yunqing Wangda924eb2020-05-01 16:34:11 -07002293# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2294# YES then doxygen will generate a graph for each documented file showing the
2295# direct and indirect include dependencies of the file with other documented
2296# files.
2297# The default value is: YES.
2298# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002299
2300INCLUDE_GRAPH = YES
2301
Yunqing Wangda924eb2020-05-01 16:34:11 -07002302# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2303# set to YES then doxygen will generate a graph for each documented file showing
2304# the direct and indirect include dependencies of the file with other documented
2305# files.
2306# The default value is: YES.
2307# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002308
2309INCLUDED_BY_GRAPH = YES
2310
Yunqing Wangda924eb2020-05-01 16:34:11 -07002311# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2312# dependency graph for every global function or class method.
2313#
John Koleszar0ea50ce2010-05-18 11:58:33 -04002314# Note that enabling this option will significantly increase the time of a run.
2315# So in most cases it will be better to enable call graphs for selected
Yunqing Wangda924eb2020-05-01 16:34:11 -07002316# functions only using the \callgraph command. Disabling a call graph can be
2317# accomplished by means of the command \hidecallgraph.
2318# The default value is: NO.
2319# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002320
2321CALL_GRAPH = NO
2322
Yunqing Wangda924eb2020-05-01 16:34:11 -07002323# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2324# dependency graph for every global function or class method.
2325#
John Koleszar0ea50ce2010-05-18 11:58:33 -04002326# Note that enabling this option will significantly increase the time of a run.
2327# So in most cases it will be better to enable caller graphs for selected
Yunqing Wangda924eb2020-05-01 16:34:11 -07002328# functions only using the \callergraph command. Disabling a caller graph can be
2329# accomplished by means of the command \hidecallergraph.
2330# The default value is: NO.
2331# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002332
2333CALLER_GRAPH = NO
2334
Yunqing Wangda924eb2020-05-01 16:34:11 -07002335# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2336# hierarchy of all classes instead of a textual one.
2337# The default value is: YES.
2338# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002339
2340GRAPHICAL_HIERARCHY = YES
2341
Yunqing Wangda924eb2020-05-01 16:34:11 -07002342# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2343# dependencies a directory has on other directories in a graphical way. The
2344# dependency relations are determined by the #include relations between the
2345# files in the directories.
2346# The default value is: YES.
2347# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002348
2349DIRECTORY_GRAPH = YES
2350
2351# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
Yunqing Wangda924eb2020-05-01 16:34:11 -07002352# generated by dot. For an explanation of the image formats see the section
2353# output formats in the documentation of the dot tool (Graphviz (see:
2354# http://www.graphviz.org/)).
2355# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2356# to make the SVG files visible in IE 9+ (other browsers do not have this
2357# requirement).
2358# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2359# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2360# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
2361# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2362# png:gdiplus:gdiplus.
2363# The default value is: png.
2364# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002365
2366DOT_IMAGE_FORMAT = png
2367
Yunqing Wangda924eb2020-05-01 16:34:11 -07002368# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2369# enable generation of interactive SVG images that allow zooming and panning.
2370#
2371# Note that this requires a modern browser other than Internet Explorer. Tested
2372# and working are Firefox, Chrome, Safari, and Opera.
2373# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2374# the SVG files visible. Older versions of IE do not have SVG support.
2375# The default value is: NO.
2376# This tag requires that the tag HAVE_DOT is set to YES.
2377
2378INTERACTIVE_SVG = NO
2379
2380# The DOT_PATH tag can be used to specify the path where the dot tool can be
John Koleszar0ea50ce2010-05-18 11:58:33 -04002381# found. If left blank, it is assumed the dot tool can be found in the path.
Yunqing Wangda924eb2020-05-01 16:34:11 -07002382# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002383
2384DOT_PATH =
2385
2386# The DOTFILE_DIRS tag can be used to specify one or more directories that
Yunqing Wangda924eb2020-05-01 16:34:11 -07002387# contain dot files that are included in the documentation (see the \dotfile
2388# command).
2389# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002390
2391DOTFILE_DIRS =
2392
Yunqing Wangda924eb2020-05-01 16:34:11 -07002393# The MSCFILE_DIRS tag can be used to specify one or more directories that
2394# contain msc files that are included in the documentation (see the \mscfile
2395# command).
2396
2397MSCFILE_DIRS =
2398
2399# The DIAFILE_DIRS tag can be used to specify one or more directories that
2400# contain dia files that are included in the documentation (see the \diafile
2401# command).
2402
2403DIAFILE_DIRS =
2404
2405# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2406# path where java can find the plantuml.jar file. If left blank, it is assumed
2407# PlantUML is not used or called during a preprocessing step. Doxygen will
2408# generate a warning when it encounters a \startuml command in this case and
2409# will not generate output for the diagram.
2410
2411PLANTUML_JAR_PATH =
2412
2413# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2414# configuration file for plantuml.
2415
2416PLANTUML_CFG_FILE =
2417
2418# When using plantuml, the specified paths are searched for files specified by
2419# the !include statement in a plantuml block.
2420
2421PLANTUML_INCLUDE_PATH =
2422
2423# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2424# that will be shown in the graph. If the number of nodes in a graph becomes
2425# larger than this value, doxygen will truncate the graph, which is visualized
2426# by representing a node as a red box. Note that doxygen if the number of direct
2427# children of the root node in a graph is already larger than
2428# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2429# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2430# Minimum value: 0, maximum value: 10000, default value: 50.
2431# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002432
2433DOT_GRAPH_MAX_NODES = 50
2434
Yunqing Wangda924eb2020-05-01 16:34:11 -07002435# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2436# generated by dot. A depth value of 3 means that only nodes reachable from the
2437# root by following a path via at most 3 edges will be shown. Nodes that lay
2438# further from the root node will be omitted. Note that setting this option to 1
2439# or 2 may greatly reduce the computation time needed for large code bases. Also
2440# note that the size of a graph can be further restricted by
John Koleszar0ea50ce2010-05-18 11:58:33 -04002441# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
Yunqing Wangda924eb2020-05-01 16:34:11 -07002442# Minimum value: 0, maximum value: 1000, default value: 0.
2443# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002444
2445MAX_DOT_GRAPH_DEPTH = 0
2446
2447# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
Yunqing Wangda924eb2020-05-01 16:34:11 -07002448# background. This is disabled by default, because dot on Windows does not seem
2449# to support this out of the box.
2450#
John Koleszar0ea50ce2010-05-18 11:58:33 -04002451# Warning: Depending on the platform used, enabling this option may lead to
2452# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2453# read).
Yunqing Wangda924eb2020-05-01 16:34:11 -07002454# The default value is: NO.
2455# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002456
Yunqing Wangda924eb2020-05-01 16:34:11 -07002457DOT_TRANSPARENT = NO
John Koleszar0ea50ce2010-05-18 11:58:33 -04002458
Yunqing Wangda924eb2020-05-01 16:34:11 -07002459# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
John Koleszar0ea50ce2010-05-18 11:58:33 -04002460# files in one run (i.e. multiple -o and -T options on the command line). This
Yunqing Wangda924eb2020-05-01 16:34:11 -07002461# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2462# this, this feature is disabled by default.
2463# The default value is: NO.
2464# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002465
2466DOT_MULTI_TARGETS = NO
2467
Yunqing Wangda924eb2020-05-01 16:34:11 -07002468# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2469# explaining the meaning of the various boxes and arrows in the dot generated
2470# graphs.
2471# The default value is: YES.
2472# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002473
2474GENERATE_LEGEND = YES
2475
Yunqing Wangda924eb2020-05-01 16:34:11 -07002476# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2477# files that are used to generate the various graphs.
2478# The default value is: YES.
2479# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002480
2481DOT_CLEANUP = YES
2482
2483#---------------------------------------------------------------------------
2484# Configuration::additions related to the search engine
2485#---------------------------------------------------------------------------
2486
2487# The SEARCHENGINE tag specifies whether or not a search engine should be
2488# used. If set to NO the values of all tags below this one will be ignored.
2489
2490SEARCHENGINE = NO