blob: 105c7c0649466f23d4da1f9a3d5d5b3f5dba4e7b [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# This tag can be used to specify a number of word-keyword mappings (TCL only).
267# A mapping has the form "name=value". For example adding "class=itcl::class"
268# will allow you to use the command class in the itcl::class meaning.
269
270TCL_SUBST =
271
272# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
273# only. Doxygen will then generate output that is more tailored for C. For
274# instance, some of the names that are used will be different. The list of all
275# members will be omitted, etc.
276# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400277
278OPTIMIZE_OUTPUT_FOR_C = YES
279
Yunqing Wangda924eb2020-05-01 16:34:11 -0700280# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
281# Python sources only. Doxygen will then generate output that is more tailored
282# for that language. For instance, namespaces will be presented as packages,
283# qualified scopes will look different, etc.
284# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400285
286OPTIMIZE_OUTPUT_JAVA = NO
287
Yunqing Wangda924eb2020-05-01 16:34:11 -0700288# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
289# sources. Doxygen will then generate output that is tailored for Fortran.
290# The default value is: NO.
291
292OPTIMIZE_FOR_FORTRAN = NO
293
294# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
295# sources. Doxygen will then generate output that is tailored for VHDL.
296# The default value is: NO.
297
298OPTIMIZE_OUTPUT_VHDL = NO
299
300# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
301# sources only. Doxygen will then generate output that is more tailored for that
302# language. For instance, namespaces will be presented as modules, types will be
303# separated into more groups, etc.
304# The default value is: NO.
305
306OPTIMIZE_OUTPUT_SLICE = NO
307
308# Doxygen selects the parser to use depending on the extension of the files it
309# parses. With this tag you can assign which parser to use for a given
310# extension. Doxygen has a built-in mapping, but you can override or extend it
311# using this tag. The format is ext=language, where ext is a file extension, and
312# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
313# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice,
314# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
315# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
316# tries to guess whether the code is fixed or free formatted code, this is the
317# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat
318# .inc files as Fortran files (default is PHP), and .f files as C (default is
319# Fortran), use: inc=Fortran f=C.
320#
321# Note: For files without extension you can use no_extension as a placeholder.
322#
323# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
324# the files are not read by doxygen.
325
326EXTENSION_MAPPING =
327
328# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
329# according to the Markdown format, which allows for more readable
330# documentation. See https://daringfireball.net/projects/markdown/ for details.
331# The output of markdown processing is further processed by doxygen, so you can
332# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
333# case of backward compatibilities issues.
334# The default value is: YES.
335
336MARKDOWN_SUPPORT = YES
337
338# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
339# to that level are automatically included in the table of contents, even if
340# they do not have an id attribute.
341# Note: This feature currently applies only to Markdown headings.
342# Minimum value: 0, maximum value: 99, default value: 5.
343# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
344
345TOC_INCLUDE_HEADINGS = 5
346
347# When enabled doxygen tries to link words that correspond to documented
348# classes, or namespaces to their corresponding documentation. Such a link can
349# be prevented in individual cases by putting a % sign in front of the word or
350# globally by setting AUTOLINK_SUPPORT to NO.
351# The default value is: YES.
352
353AUTOLINK_SUPPORT = YES
354
355# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
356# to include (a tag file for) the STL sources as input, then you should set this
357# tag to YES in order to let doxygen match functions declarations and
358# definitions whose arguments contain STL classes (e.g. func(std::string);
359# versus func(std::string) {}). This also make the inheritance and collaboration
John Koleszar0ea50ce2010-05-18 11:58:33 -0400360# diagrams that involve STL classes more complete and accurate.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700361# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400362
363BUILTIN_STL_SUPPORT = NO
364
365# If you use Microsoft's C++/CLI language, you should set this option to YES to
366# enable parsing support.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700367# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400368
369CPP_CLI_SUPPORT = NO
370
Yunqing Wangda924eb2020-05-01 16:34:11 -0700371# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
372# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
373# will parse them like normal C++ but will assume all classes use public instead
374# of private inheritance when no explicit protection keyword is present.
375# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400376
377SIP_SUPPORT = NO
378
Yunqing Wangda924eb2020-05-01 16:34:11 -0700379# For Microsoft's IDL there are propget and propput attributes to indicate
380# getter and setter methods for a property. Setting this option to YES will make
381# doxygen to replace the get and set methods by a property in the documentation.
382# This will only work if the methods are indeed getting or setting a simple
383# type. If this is not the case, or you want to show the methods anyway, you
384# should set this option to NO.
385# The default value is: YES.
386
387IDL_PROPERTY_SUPPORT = YES
388
John Koleszar0ea50ce2010-05-18 11:58:33 -0400389# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
Yunqing Wangda924eb2020-05-01 16:34:11 -0700390# tag is set to YES then doxygen will reuse the documentation of the first
John Koleszar0ea50ce2010-05-18 11:58:33 -0400391# member in the group (if any) for the other members of the group. By default
392# all members of a group must be documented explicitly.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700393# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400394
395DISTRIBUTE_GROUP_DOC = NO
396
Yunqing Wangda924eb2020-05-01 16:34:11 -0700397# If one adds a struct or class to a group and this option is enabled, then also
398# any nested class or struct is added to the same group. By default this option
399# is disabled and one has to add nested compounds explicitly via \ingroup.
400# The default value is: NO.
401
402GROUP_NESTED_COMPOUNDS = NO
403
404# Set the SUBGROUPING tag to YES to allow class member groups of the same type
405# (for instance a group of public functions) to be put as a subgroup of that
406# type (e.g. under the Public Functions section). Set it to NO to prevent
407# subgrouping. Alternatively, this can be done per class using the
408# \nosubgrouping command.
409# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400410
411SUBGROUPING = YES
412
Yunqing Wangda924eb2020-05-01 16:34:11 -0700413# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
414# are shown inside the group in which they are included (e.g. using \ingroup)
415# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
416# and RTF).
417#
418# Note that this feature does not work in combination with
419# SEPARATE_MEMBER_PAGES.
420# The default value is: NO.
421
422INLINE_GROUPED_CLASSES = NO
423
424# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
425# with only public data fields or simple typedef fields will be shown inline in
426# the documentation of the scope in which they are defined (i.e. file,
427# namespace, or group documentation), provided this scope is documented. If set
428# to NO, structs, classes, and unions are shown on a separate page (for HTML and
429# Man pages) or section (for LaTeX and RTF).
430# The default value is: NO.
431
432INLINE_SIMPLE_STRUCTS = NO
433
434# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
435# enum is documented as struct, union, or enum with the name of the typedef. So
436# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
437# with name TypeT. When disabled the typedef will appear as a member of a file,
438# namespace, or class. And the struct will be named TypeS. This can typically be
439# useful for C code in case the coding convention dictates that all compound
440# types are typedef'ed and only the typedef is referenced, never the tag name.
441# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400442
443TYPEDEF_HIDES_STRUCT = NO
444
Yunqing Wangda924eb2020-05-01 16:34:11 -0700445# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
446# cache is used to resolve symbols given their name and scope. Since this can be
447# an expensive process and often the same symbol appears multiple times in the
448# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
449# doxygen will become slower. If the cache is too large, memory is wasted. The
450# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
451# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
452# symbols. At the end of a run doxygen will report the cache usage and suggest
453# the optimal cache size from a speed point of view.
454# Minimum value: 0, maximum value: 9, default value: 0.
455
456LOOKUP_CACHE_SIZE = 0
457
John Koleszar0ea50ce2010-05-18 11:58:33 -0400458#---------------------------------------------------------------------------
459# Build related configuration options
460#---------------------------------------------------------------------------
461
Yunqing Wangda924eb2020-05-01 16:34:11 -0700462# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
463# documentation are documented, even if no documentation was available. Private
464# class members and static file members will be hidden unless the
465# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
466# Note: This will also disable the warnings about undocumented members that are
467# normally produced when WARNINGS is set to YES.
468# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400469
470EXTRACT_ALL = NO
471
Yunqing Wangda924eb2020-05-01 16:34:11 -0700472# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
473# be included in the documentation.
474# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400475
476EXTRACT_PRIVATE = NO
477
Yunqing Wangda924eb2020-05-01 16:34:11 -0700478# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
479# methods of a class will be included in the documentation.
480# The default value is: NO.
481
482EXTRACT_PRIV_VIRTUAL = NO
483
484# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
485# scope will be included in the documentation.
486# The default value is: NO.
487
488EXTRACT_PACKAGE = NO
489
490# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
491# included in the documentation.
492# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400493
494EXTRACT_STATIC = NO
495
Yunqing Wangda924eb2020-05-01 16:34:11 -0700496# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
497# locally in source files will be included in the documentation. If set to NO,
498# only classes defined in header files are included. Does not have any effect
499# for Java sources.
500# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400501
502EXTRACT_LOCAL_CLASSES = YES
503
Yunqing Wangda924eb2020-05-01 16:34:11 -0700504# This flag is only useful for Objective-C code. If set to YES, local methods,
505# which are defined in the implementation section but not in the interface are
506# included in the documentation. If set to NO, only methods in the interface are
507# included.
508# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400509
510EXTRACT_LOCAL_METHODS = NO
511
Yunqing Wangda924eb2020-05-01 16:34:11 -0700512# If this flag is set to YES, the members of anonymous namespaces will be
513# extracted and appear in the documentation as a namespace called
514# 'anonymous_namespace{file}', where file will be replaced with the base name of
515# the file that contains the anonymous namespace. By default anonymous namespace
516# are hidden.
517# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400518
519EXTRACT_ANON_NSPACES = NO
520
Yunqing Wangda924eb2020-05-01 16:34:11 -0700521# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
522# undocumented members inside documented classes or files. If set to NO these
523# members will be included in the various overviews, but no documentation
524# section is generated. This option has no effect if EXTRACT_ALL is enabled.
525# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400526
527HIDE_UNDOC_MEMBERS = NO
528
Yunqing Wangda924eb2020-05-01 16:34:11 -0700529# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
530# undocumented classes that are normally visible in the class hierarchy. If set
531# to NO, these classes will be included in the various overviews. This option
532# has no effect if EXTRACT_ALL is enabled.
533# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400534
535HIDE_UNDOC_CLASSES = NO
536
Yunqing Wangda924eb2020-05-01 16:34:11 -0700537# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
538# (class|struct|union) declarations. If set to NO, these declarations will be
539# included in the documentation.
540# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400541
542HIDE_FRIEND_COMPOUNDS = NO
543
Yunqing Wangda924eb2020-05-01 16:34:11 -0700544# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
545# documentation blocks found inside the body of a function. If set to NO, these
546# blocks will be appended to the function's detailed documentation block.
547# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400548
549HIDE_IN_BODY_DOCS = NO
550
Yunqing Wangda924eb2020-05-01 16:34:11 -0700551# The INTERNAL_DOCS tag determines if documentation that is typed after a
552# \internal command is included. If the tag is set to NO then the documentation
553# will be excluded. Set it to YES to include the internal documentation.
554# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400555
556INTERNAL_DOCS = NO
557
Yunqing Wangda924eb2020-05-01 16:34:11 -0700558# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
559# names in lower-case letters. If set to YES, upper-case letters are also
John Koleszar0ea50ce2010-05-18 11:58:33 -0400560# allowed. This is useful if you have classes or files whose names only differ
561# in case and if your file system supports case sensitive file names. Windows
Yunqing Wangda924eb2020-05-01 16:34:11 -0700562# (including Cygwin) ands Mac users are advised to set this option to NO.
563# The default value is: system dependent.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400564
565CASE_SENSE_NAMES = YES
566
Yunqing Wangda924eb2020-05-01 16:34:11 -0700567# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
568# their full class and namespace scopes in the documentation. If set to YES, the
569# scope will be hidden.
570# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400571
572HIDE_SCOPE_NAMES = NO
573
Yunqing Wangda924eb2020-05-01 16:34:11 -0700574# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
575# append additional text to a page's title, such as Class Reference. If set to
576# YES the compound reference will be hidden.
577# The default value is: NO.
578
579HIDE_COMPOUND_REFERENCE= NO
580
581# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
582# the files that are included by a file in the documentation of that file.
583# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400584
585SHOW_INCLUDE_FILES = YES
586
Yunqing Wangda924eb2020-05-01 16:34:11 -0700587# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
588# grouped member an include statement to the documentation, telling the reader
589# which file to include in order to use the member.
590# The default value is: NO.
591
592SHOW_GROUPED_MEMB_INC = NO
593
594# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
595# files with double quotes in the documentation rather than with sharp brackets.
596# The default value is: NO.
597
598FORCE_LOCAL_INCLUDES = NO
599
600# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
601# documentation for inline members.
602# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400603
604INLINE_INFO = YES
605
Yunqing Wangda924eb2020-05-01 16:34:11 -0700606# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
607# (detailed) documentation of file and class members alphabetically by member
608# name. If set to NO, the members will appear in declaration order.
609# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400610
611SORT_MEMBER_DOCS = NO
612
Yunqing Wangda924eb2020-05-01 16:34:11 -0700613# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
614# descriptions of file, namespace and class members alphabetically by member
615# name. If set to NO, the members will appear in declaration order. Note that
616# this will also influence the order of the classes in the class list.
617# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400618
619SORT_BRIEF_DOCS = NO
620
Yunqing Wangda924eb2020-05-01 16:34:11 -0700621# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
622# (brief and detailed) documentation of class members so that constructors and
623# destructors are listed first. If set to NO the constructors will appear in the
624# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
625# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
626# member documentation.
627# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
628# detailed member documentation.
629# The default value is: NO.
630
631SORT_MEMBERS_CTORS_1ST = NO
632
633# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
634# of group names into alphabetical order. If set to NO the group names will
635# appear in their defined order.
636# The default value is: NO.
637
638SORT_GROUP_NAMES = NO
639
640# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
641# fully-qualified names, including namespaces. If set to NO, the class list will
642# be sorted only by class name, not including the namespace part.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400643# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700644# Note: This option applies only to the class list, not to the alphabetical
645# list.
646# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400647
648SORT_BY_SCOPE_NAME = NO
649
Yunqing Wangda924eb2020-05-01 16:34:11 -0700650# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
651# type resolution of all parameters of a function it will reject a match between
652# the prototype and the implementation of a member function even if there is
653# only one candidate or it is obvious which candidate to choose by doing a
654# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
655# accept a match between prototype and implementation in such cases.
656# The default value is: NO.
657
658STRICT_PROTO_MATCHING = NO
659
660# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
661# list. This list is created by putting \todo commands in the documentation.
662# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400663
664GENERATE_TODOLIST = YES
665
Yunqing Wangda924eb2020-05-01 16:34:11 -0700666# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
667# list. This list is created by putting \test commands in the documentation.
668# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400669
670GENERATE_TESTLIST = YES
671
Yunqing Wangda924eb2020-05-01 16:34:11 -0700672# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
673# list. This list is created by putting \bug commands in the documentation.
674# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400675
676GENERATE_BUGLIST = YES
677
Yunqing Wangda924eb2020-05-01 16:34:11 -0700678# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
679# the deprecated list. This list is created by putting \deprecated commands in
680# the documentation.
681# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400682
683GENERATE_DEPRECATEDLIST= YES
684
Yunqing Wangda924eb2020-05-01 16:34:11 -0700685# The ENABLED_SECTIONS tag can be used to enable conditional documentation
686# sections, marked by \if <section_label> ... \endif and \cond <section_label>
687# ... \endcond blocks.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400688
689ENABLED_SECTIONS =
690
Yunqing Wangda924eb2020-05-01 16:34:11 -0700691# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
692# initial value of a variable or macro / define can have for it to appear in the
693# documentation. If the initializer consists of more lines than specified here
694# it will be hidden. Use a value of 0 to hide initializers completely. The
695# appearance of the value of individual variables and macros / defines can be
696# controlled using \showinitializer or \hideinitializer command in the
697# documentation regardless of this setting.
698# Minimum value: 0, maximum value: 10000, default value: 30.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400699
700MAX_INITIALIZER_LINES = 30
701
Yunqing Wangda924eb2020-05-01 16:34:11 -0700702# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
703# the bottom of the documentation of classes and structs. If set to YES, the
John Koleszar0ea50ce2010-05-18 11:58:33 -0400704# list will mention the files that were used to generate the documentation.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700705# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400706
707SHOW_USED_FILES = YES
708
Yunqing Wangda924eb2020-05-01 16:34:11 -0700709# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
710# will remove the Files entry from the Quick Index and from the Folder Tree View
711# (if specified).
712# The default value is: YES.
713
714SHOW_FILES = YES
715
716# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
717# page. This will remove the Namespaces entry from the Quick Index and from the
718# Folder Tree View (if specified).
719# The default value is: YES.
720
721SHOW_NAMESPACES = YES
722
John Koleszar0ea50ce2010-05-18 11:58:33 -0400723# The FILE_VERSION_FILTER tag can be used to specify a program or script that
Yunqing Wangda924eb2020-05-01 16:34:11 -0700724# doxygen should invoke to get the current version for each file (typically from
725# the version control system). Doxygen will invoke the program by executing (via
726# popen()) the command command input-file, where command is the value of the
727# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
728# by doxygen. Whatever the program writes to standard output is used as the file
729# version. For an example see the documentation.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400730
731FILE_VERSION_FILTER =
732
Yunqing Wangda924eb2020-05-01 16:34:11 -0700733# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
734# by doxygen. The layout file controls the global structure of the generated
735# output files in an output format independent way. To create the layout file
736# that represents doxygen's defaults, run doxygen with the -l option. You can
737# optionally specify a file name after the option, if omitted DoxygenLayout.xml
738# will be used as the name of the layout file.
739#
740# Note that if you run doxygen from a directory containing a file called
741# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
742# tag is left empty.
743
744LAYOUT_FILE =
745
746# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
747# the reference definitions. This must be a list of .bib files. The .bib
748# extension is automatically appended if omitted. This requires the bibtex tool
749# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
750# For LaTeX the style of the bibliography can be controlled using
751# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
752# search path. See also \cite for info how to create references.
753
754CITE_BIB_FILES =
755
John Koleszar0ea50ce2010-05-18 11:58:33 -0400756#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -0700757# Configuration options related to warning and progress messages
John Koleszar0ea50ce2010-05-18 11:58:33 -0400758#---------------------------------------------------------------------------
759
Yunqing Wangda924eb2020-05-01 16:34:11 -0700760# The QUIET tag can be used to turn on/off the messages that are generated to
761# standard output by doxygen. If QUIET is set to YES this implies that the
762# messages are off.
763# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400764
765QUIET = YES
766
767# The WARNINGS tag can be used to turn on/off the warning messages that are
Yunqing Wangda924eb2020-05-01 16:34:11 -0700768# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
769# this implies that the warnings are on.
770#
771# Tip: Turn warnings on while writing the documentation.
772# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400773
774WARNINGS = YES
775
Yunqing Wangda924eb2020-05-01 16:34:11 -0700776# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
777# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
778# will automatically be disabled.
779# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400780
781WARN_IF_UNDOCUMENTED = YES
782
Yunqing Wangda924eb2020-05-01 16:34:11 -0700783# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
784# potential errors in the documentation, such as not documenting some parameters
785# in a documented function, or documenting parameters that don't exist or using
786# markup commands wrongly.
787# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400788
789WARN_IF_DOC_ERROR = YES
790
Yunqing Wangda924eb2020-05-01 16:34:11 -0700791# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
792# are documented, but have no documentation for their parameters or return
793# value. If set to NO, doxygen will only warn about wrong or incomplete
794# parameter documentation, but not about the absence of documentation. If
795# EXTRACT_ALL is set to YES then this flag will automatically be disabled.
796# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400797
798WARN_NO_PARAMDOC = NO
799
Yunqing Wangda924eb2020-05-01 16:34:11 -0700800# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
801# a warning is encountered.
802# The default value is: NO.
803
804WARN_AS_ERROR = NO
805
806# The WARN_FORMAT tag determines the format of the warning messages that doxygen
807# can produce. The string should contain the $file, $line, and $text tags, which
808# will be replaced by the file and line number from which the warning originated
809# and the warning text. Optionally the format may contain $version, which will
810# be replaced by the version of the file (if it could be obtained via
811# FILE_VERSION_FILTER)
812# The default value is: $file:$line: $text.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400813
814WARN_FORMAT = "$file:$line: $text"
815
Yunqing Wangda924eb2020-05-01 16:34:11 -0700816# The WARN_LOGFILE tag can be used to specify a file to which warning and error
817# messages should be written. If left blank the output is written to standard
818# error (stderr).
John Koleszar0ea50ce2010-05-18 11:58:33 -0400819
820WARN_LOGFILE =
821
822#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -0700823# Configuration options related to the input files
John Koleszar0ea50ce2010-05-18 11:58:33 -0400824#---------------------------------------------------------------------------
825
Yunqing Wangda924eb2020-05-01 16:34:11 -0700826# The INPUT tag is used to specify the files and/or directories that contain
827# documented source files. You may enter file names like myfile.cpp or
828# directories like /usr/src/myproject. Separate the files or directories with
829# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
830# Note: If this tag is empty the current directory is searched.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400831
Yunqing Wangda924eb2020-05-01 16:34:11 -0700832INPUT =
John Koleszar0ea50ce2010-05-18 11:58:33 -0400833
Yunqing Wangda924eb2020-05-01 16:34:11 -0700834# This tag can be used to specify the character encoding of the source files
835# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
836# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
837# documentation (see: https://www.gnu.org/software/libiconv/) for the list of
838# possible encodings.
839# The default value is: UTF-8.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400840
841INPUT_ENCODING = UTF-8
842
843# If the value of the INPUT tag contains directories, you can use the
Yunqing Wangda924eb2020-05-01 16:34:11 -0700844# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
845# *.h) to filter out the source-files in the directories.
846#
847# Note that for custom extensions or not directly supported extensions you also
848# need to set EXTENSION_MAPPING for the extension otherwise the files are not
849# read by doxygen.
850#
851# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
852# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
853# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
854# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
855# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400856
857FILE_PATTERNS =
858
Yunqing Wangda924eb2020-05-01 16:34:11 -0700859# The RECURSIVE tag can be used to specify whether or not subdirectories should
860# be searched for input files as well.
861# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400862
863RECURSIVE = NO
864
Yunqing Wangda924eb2020-05-01 16:34:11 -0700865# The EXCLUDE tag can be used to specify files and/or directories that should be
John Koleszar0ea50ce2010-05-18 11:58:33 -0400866# excluded from the INPUT source files. This way you can easily exclude a
867# subdirectory from a directory tree whose root is specified with the INPUT tag.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700868#
869# Note that relative paths are relative to the directory from which doxygen is
870# run.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400871
872EXCLUDE =
873
Yunqing Wangda924eb2020-05-01 16:34:11 -0700874# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
875# directories that are symbolic links (a Unix file system feature) are excluded
John Koleszar0ea50ce2010-05-18 11:58:33 -0400876# from the input.
Yunqing Wangda924eb2020-05-01 16:34:11 -0700877# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400878
879EXCLUDE_SYMLINKS = NO
880
881# If the value of the INPUT tag contains directories, you can use the
882# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
Yunqing Wangda924eb2020-05-01 16:34:11 -0700883# certain files from those directories.
884#
885# Note that the wildcards are matched against the file with absolute path, so to
886# exclude all test directories for example use the pattern */test/*
John Koleszar0ea50ce2010-05-18 11:58:33 -0400887
888EXCLUDE_PATTERNS =
889
890# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
Yunqing Wangda924eb2020-05-01 16:34:11 -0700891# (namespaces, classes, functions, etc.) that should be excluded from the
892# output. The symbol name can be a fully qualified name, a word, or if the
893# wildcard * is used, a substring. Examples: ANamespace, AClass,
894# AClass::ANamespace, ANamespace::*Test
895#
896# Note that the wildcards are matched against the file with absolute path, so to
897# exclude all test directories use the pattern */test/*
John Koleszar0ea50ce2010-05-18 11:58:33 -0400898
899EXCLUDE_SYMBOLS =
900
Yunqing Wangda924eb2020-05-01 16:34:11 -0700901# The EXAMPLE_PATH tag can be used to specify one or more files or directories
902# that contain example code fragments that are included (see the \include
903# command).
John Koleszar0ea50ce2010-05-18 11:58:33 -0400904
905EXAMPLE_PATH =
906
907# If the value of the EXAMPLE_PATH tag contains directories, you can use the
Yunqing Wangda924eb2020-05-01 16:34:11 -0700908# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
909# *.h) to filter out the source-files in the directories. If left blank all
910# files are included.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400911
912EXAMPLE_PATTERNS =
913
914# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
Yunqing Wangda924eb2020-05-01 16:34:11 -0700915# searched for input files to be used with the \include or \dontinclude commands
916# irrespective of the value of the RECURSIVE tag.
917# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400918
919EXAMPLE_RECURSIVE = NO
920
Yunqing Wangda924eb2020-05-01 16:34:11 -0700921# The IMAGE_PATH tag can be used to specify one or more files or directories
922# that contain images that are to be included in the documentation (see the
923# \image command).
John Koleszar0ea50ce2010-05-18 11:58:33 -0400924
925IMAGE_PATH =
926
927# The INPUT_FILTER tag can be used to specify a program that doxygen should
928# invoke to filter for each input file. Doxygen will invoke the filter program
Yunqing Wangda924eb2020-05-01 16:34:11 -0700929# by executing (via popen()) the command:
930#
931# <filter> <input-file>
932#
933# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
934# name of an input file. Doxygen will then use the output that the filter
935# program writes to standard output. If FILTER_PATTERNS is specified, this tag
936# will be ignored.
937#
938# Note that the filter must not add or remove lines; it is applied before the
939# code is scanned, but not when the output code is generated. If lines are added
940# or removed, the anchors will not be placed correctly.
941#
942# Note that for custom extensions or not directly supported extensions you also
943# need to set EXTENSION_MAPPING for the extension otherwise the files are not
944# properly processed by doxygen.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400945
946INPUT_FILTER =
947
948# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
Yunqing Wangda924eb2020-05-01 16:34:11 -0700949# basis. Doxygen will compare the file name with each pattern and apply the
950# filter if there is a match. The filters are a list of the form: pattern=filter
951# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
952# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
953# patterns match the file name, INPUT_FILTER is applied.
954#
955# Note that for custom extensions or not directly supported extensions you also
956# need to set EXTENSION_MAPPING for the extension otherwise the files are not
957# properly processed by doxygen.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400958
959FILTER_PATTERNS =
960
961# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
Yunqing Wangda924eb2020-05-01 16:34:11 -0700962# INPUT_FILTER) will also be used to filter the input files that are used for
963# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
964# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400965
966FILTER_SOURCE_FILES = NO
967
Yunqing Wangda924eb2020-05-01 16:34:11 -0700968# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
969# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
970# it is also possible to disable source filtering for a specific pattern using
971# *.ext= (so without naming a filter).
972# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
973
974FILTER_SOURCE_PATTERNS =
975
976# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
977# is part of the input, its contents will be placed on the main page
978# (index.html). This can be useful if you have a project on for instance GitHub
979# and want to reuse the introduction page also for the doxygen output.
980
981USE_MDFILE_AS_MAINPAGE =
982
John Koleszar0ea50ce2010-05-18 11:58:33 -0400983#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -0700984# Configuration options related to source browsing
John Koleszar0ea50ce2010-05-18 11:58:33 -0400985#---------------------------------------------------------------------------
986
Yunqing Wangda924eb2020-05-01 16:34:11 -0700987# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
988# generated. Documented entities will be cross-referenced with these sources.
989#
990# Note: To get rid of all source code in the generated output, make sure that
991# also VERBATIM_HEADERS is set to NO.
992# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400993
994SOURCE_BROWSER = NO
995
Yunqing Wangda924eb2020-05-01 16:34:11 -0700996# Setting the INLINE_SOURCES tag to YES will include the body of functions,
997# classes and enums directly into the documentation.
998# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -0400999
1000INLINE_SOURCES = NO
1001
Yunqing Wangda924eb2020-05-01 16:34:11 -07001002# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1003# special comment blocks from generated source code fragments. Normal C, C++ and
1004# Fortran comments will always remain visible.
1005# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001006
1007STRIP_CODE_COMMENTS = YES
1008
Yunqing Wangda924eb2020-05-01 16:34:11 -07001009# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1010# entity all documented functions referencing it will be listed.
1011# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001012
1013REFERENCED_BY_RELATION = YES
1014
Yunqing Wangda924eb2020-05-01 16:34:11 -07001015# If the REFERENCES_RELATION tag is set to YES then for each documented function
1016# all documented entities called/used by that function will be listed.
1017# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001018
1019REFERENCES_RELATION = YES
1020
Yunqing Wangda924eb2020-05-01 16:34:11 -07001021# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1022# to YES then the hyperlinks from functions in REFERENCES_RELATION and
1023# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1024# link to the documentation.
1025# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001026
1027REFERENCES_LINK_SOURCE = YES
1028
Yunqing Wangda924eb2020-05-01 16:34:11 -07001029# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1030# source code will show a tooltip with additional information such as prototype,
1031# brief description and links to the definition and documentation. Since this
1032# will make the HTML file larger and loading of large files a bit slower, you
1033# can opt to disable this feature.
1034# The default value is: YES.
1035# This tag requires that the tag SOURCE_BROWSER is set to YES.
1036
1037SOURCE_TOOLTIPS = YES
1038
1039# If the USE_HTAGS tag is set to YES then the references to source code will
1040# point to the HTML generated by the htags(1) tool instead of doxygen built-in
1041# source browser. The htags tool is part of GNU's global source tagging system
1042# (see https://www.gnu.org/software/global/global.html). You will need version
1043# 4.8.6 or higher.
1044#
1045# To use it do the following:
1046# - Install the latest version of global
1047# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1048# - Make sure the INPUT points to the root of the source tree
1049# - Run doxygen as normal
1050#
1051# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1052# tools must be available from the command line (i.e. in the search path).
1053#
1054# The result: instead of the source browser generated by doxygen, the links to
1055# source code will now point to the output of htags.
1056# The default value is: NO.
1057# This tag requires that the tag SOURCE_BROWSER is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001058
1059USE_HTAGS = NO
1060
Yunqing Wangda924eb2020-05-01 16:34:11 -07001061# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1062# verbatim copy of the header file for each class for which an include is
1063# specified. Set to NO to disable this.
1064# See also: Section \class.
1065# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001066
1067VERBATIM_HEADERS = YES
1068
Yunqing Wangda924eb2020-05-01 16:34:11 -07001069# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1070# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1071# cost of reduced performance. This can be particularly helpful with template
1072# rich C++ code for which doxygen's built-in parser lacks the necessary type
1073# information.
1074# Note: The availability of this option depends on whether or not doxygen was
1075# generated with the -Duse_libclang=ON option for CMake.
1076# The default value is: NO.
1077
1078CLANG_ASSISTED_PARSING = NO
1079
1080# If clang assisted parsing is enabled you can provide the compiler with command
1081# line options that you would normally use when invoking the compiler. Note that
1082# the include paths will already be set by doxygen for the files and directories
1083# specified with INPUT and INCLUDE_PATH.
1084# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1085
1086CLANG_OPTIONS =
1087
1088# If clang assisted parsing is enabled you can provide the clang parser with the
1089# path to the compilation database (see:
1090# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files
1091# were built. This is equivalent to specifying the "-p" option to a clang tool,
1092# such as clang-check. These options will then be passed to the parser.
1093# Note: The availability of this option depends on whether or not doxygen was
1094# generated with the -Duse_libclang=ON option for CMake.
1095
1096CLANG_DATABASE_PATH =
1097
John Koleszar0ea50ce2010-05-18 11:58:33 -04001098#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -07001099# Configuration options related to the alphabetical class index
John Koleszar0ea50ce2010-05-18 11:58:33 -04001100#---------------------------------------------------------------------------
1101
Yunqing Wangda924eb2020-05-01 16:34:11 -07001102# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1103# compounds will be generated. Enable this if the project contains a lot of
1104# classes, structs, unions or interfaces.
1105# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001106
1107ALPHABETICAL_INDEX = NO
Yunqing Wangda924eb2020-05-01 16:34:11 -07001108# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1109# which the alphabetical index list will be split.
1110# Minimum value: 1, maximum value: 20, default value: 5.
1111# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001112
1113COLS_IN_ALPHA_INDEX = 5
1114
Yunqing Wangda924eb2020-05-01 16:34:11 -07001115# In case all classes in a project start with a common prefix, all classes will
1116# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1117# can be used to specify a prefix (or a list of prefixes) that should be ignored
1118# while generating the index headers.
1119# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001120
1121IGNORE_PREFIX =
1122
1123#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -07001124# Configuration options related to the HTML output
John Koleszar0ea50ce2010-05-18 11:58:33 -04001125#---------------------------------------------------------------------------
1126
Yunqing Wangda924eb2020-05-01 16:34:11 -07001127# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1128# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001129
1130GENERATE_HTML = YES
1131
Yunqing Wangda924eb2020-05-01 16:34:11 -07001132# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1133# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1134# it.
1135# The default directory is: html.
1136# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001137
1138HTML_OUTPUT = html
1139
Yunqing Wangda924eb2020-05-01 16:34:11 -07001140# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1141# generated HTML page (for example: .htm, .php, .asp).
1142# The default value is: .html.
1143# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001144
1145HTML_FILE_EXTENSION = .html
1146
Yunqing Wangda924eb2020-05-01 16:34:11 -07001147# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1148# each generated HTML page. If the tag is left blank doxygen will generate a
John Koleszar0ea50ce2010-05-18 11:58:33 -04001149# standard header.
Yunqing Wangda924eb2020-05-01 16:34:11 -07001150#
1151# To get valid HTML the header file that includes any scripts and style sheets
1152# that doxygen needs, which is dependent on the configuration options used (e.g.
1153# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1154# default header using
1155# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1156# YourConfigFile
1157# and then modify the file new_header.html. See also section "Doxygen usage"
1158# for information on how to generate the default header that doxygen normally
1159# uses.
1160# Note: The header is subject to change so you typically have to regenerate the
1161# default header when upgrading to a newer version of doxygen. For a description
1162# of the possible markers and block names see the documentation.
1163# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001164
1165HTML_HEADER =
1166
Yunqing Wangda924eb2020-05-01 16:34:11 -07001167# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1168# generated HTML page. If the tag is left blank doxygen will generate a standard
1169# footer. See HTML_HEADER for more information on how to generate a default
1170# footer and what special commands can be used inside the footer. See also
1171# section "Doxygen usage" for information on how to generate the default footer
1172# that doxygen normally uses.
1173# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001174
1175HTML_FOOTER =
1176
Yunqing Wangda924eb2020-05-01 16:34:11 -07001177# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1178# sheet that is used by each HTML page. It can be used to fine-tune the look of
1179# the HTML output. If left blank doxygen will generate a default style sheet.
1180# See also section "Doxygen usage" for information on how to generate the style
1181# sheet that doxygen normally uses.
1182# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1183# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1184# obsolete.
1185# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001186
1187HTML_STYLESHEET =
1188
Yunqing Wangda924eb2020-05-01 16:34:11 -07001189# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1190# cascading style sheets that are included after the standard style sheets
1191# created by doxygen. Using this option one can overrule certain style aspects.
1192# This is preferred over using HTML_STYLESHEET since it does not replace the
1193# standard style sheet and is therefore more robust against future updates.
1194# Doxygen will copy the style sheet files to the output directory.
1195# Note: The order of the extra style sheet files is of importance (e.g. the last
1196# style sheet in the list overrules the setting of the previous ones in the
1197# list). For an example see the documentation.
1198# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001199
Yunqing Wangda924eb2020-05-01 16:34:11 -07001200HTML_EXTRA_STYLESHEET =
1201
1202# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1203# other source files which should be copied to the HTML output directory. Note
1204# that these files will be copied to the base HTML output directory. Use the
1205# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1206# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1207# files will be copied as-is; there are no commands or markers available.
1208# This tag requires that the tag GENERATE_HTML is set to YES.
1209
1210HTML_EXTRA_FILES =
1211
1212# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1213# will adjust the colors in the style sheet and background images according to
1214# this color. Hue is specified as an angle on a colorwheel, see
1215# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1216# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1217# purple, and 360 is red again.
1218# Minimum value: 0, maximum value: 359, default value: 220.
1219# This tag requires that the tag GENERATE_HTML is set to YES.
1220
1221HTML_COLORSTYLE_HUE = 220
1222
1223# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1224# in the HTML output. For a value of 0 the output will use grayscales only. A
1225# value of 255 will produce the most vivid colors.
1226# Minimum value: 0, maximum value: 255, default value: 100.
1227# This tag requires that the tag GENERATE_HTML is set to YES.
1228
1229HTML_COLORSTYLE_SAT = 100
1230
1231# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1232# luminance component of the colors in the HTML output. Values below 100
1233# gradually make the output lighter, whereas values above 100 make the output
1234# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1235# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1236# change the gamma.
1237# Minimum value: 40, maximum value: 240, default value: 80.
1238# This tag requires that the tag GENERATE_HTML is set to YES.
1239
1240HTML_COLORSTYLE_GAMMA = 80
1241
1242# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1243# page will contain the date and time when the page was generated. Setting this
1244# to YES can help to show when doxygen was last run and thus if the
1245# documentation is up to date.
1246# The default value is: NO.
1247# This tag requires that the tag GENERATE_HTML is set to YES.
1248
1249HTML_TIMESTAMP = NO
1250
1251# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1252# documentation will contain a main index with vertical navigation menus that
1253# are dynamically created via Javascript. If disabled, the navigation index will
1254# consists of multiple levels of tabs that are statically embedded in every HTML
1255# page. Disable this option to support browsers that do not have Javascript,
1256# like the Qt help browser.
1257# The default value is: YES.
1258# This tag requires that the tag GENERATE_HTML is set to YES.
1259
1260HTML_DYNAMIC_MENUS = YES
John Koleszar0ea50ce2010-05-18 11:58:33 -04001261
1262# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1263# documentation will contain sections that can be hidden and shown after the
Yunqing Wangda924eb2020-05-01 16:34:11 -07001264# page has loaded.
1265# The default value is: NO.
1266# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001267
1268HTML_DYNAMIC_SECTIONS = NO
1269
Yunqing Wangda924eb2020-05-01 16:34:11 -07001270# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1271# shown in the various tree structured indices initially; the user can expand
1272# and collapse entries dynamically later on. Doxygen will expand the tree to
1273# such a level that at most the specified number of entries are visible (unless
1274# a fully collapsed tree already exceeds this amount). So setting the number of
1275# entries 1 will produce a full collapsed tree by default. 0 is a special value
1276# representing an infinite number of entries and will result in a full expanded
1277# tree by default.
1278# Minimum value: 0, maximum value: 9999, default value: 100.
1279# This tag requires that the tag GENERATE_HTML is set to YES.
1280
1281HTML_INDEX_NUM_ENTRIES = 100
1282
1283# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1284# generated that can be used as input for Apple's Xcode 3 integrated development
1285# environment (see: https://developer.apple.com/xcode/), introduced with OSX
1286# 10.5 (Leopard). To create a documentation set, doxygen will generate a
1287# Makefile in the HTML output directory. Running make will produce the docset in
1288# that directory and running make install will install the docset in
1289# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1290# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1291# genXcode/_index.html for more information.
1292# The default value is: NO.
1293# This tag requires that the tag GENERATE_HTML is set to YES.
1294
1295GENERATE_DOCSET = NO
1296
1297# This tag determines the name of the docset feed. A documentation feed provides
1298# an umbrella under which multiple documentation sets from a single provider
1299# (such as a company or product suite) can be grouped.
1300# The default value is: Doxygen generated docs.
1301# This tag requires that the tag GENERATE_DOCSET is set to YES.
1302
1303DOCSET_FEEDNAME = "Doxygen generated docs"
1304
1305# This tag specifies a string that should uniquely identify the documentation
1306# set bundle. This should be a reverse domain-name style string, e.g.
1307# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1308# The default value is: org.doxygen.Project.
1309# This tag requires that the tag GENERATE_DOCSET is set to YES.
1310
1311DOCSET_BUNDLE_ID = org.doxygen.Project
1312
1313# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1314# the documentation publisher. This should be a reverse domain-name style
1315# string, e.g. com.mycompany.MyDocSet.documentation.
1316# The default value is: org.doxygen.Publisher.
1317# This tag requires that the tag GENERATE_DOCSET is set to YES.
1318
1319DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1320
1321# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1322# The default value is: Publisher.
1323# This tag requires that the tag GENERATE_DOCSET is set to YES.
1324
1325DOCSET_PUBLISHER_NAME = Publisher
1326
1327# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1328# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1329# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1330# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1331# Windows.
1332#
1333# The HTML Help Workshop contains a compiler that can convert all HTML output
1334# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1335# files are now used as the Windows 98 help format, and will replace the old
1336# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1337# HTML files also contain an index, a table of contents, and you can search for
1338# words in the documentation. The HTML workshop also contains a viewer for
1339# compressed HTML files.
1340# The default value is: NO.
1341# This tag requires that the tag GENERATE_HTML is set to YES.
1342
1343GENERATE_HTMLHELP = NO
1344
1345# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1346# file. You can add a path in front of the file if the result should not be
John Koleszar0ea50ce2010-05-18 11:58:33 -04001347# written to the html output directory.
Yunqing Wangda924eb2020-05-01 16:34:11 -07001348# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001349
1350CHM_FILE =
1351
Yunqing Wangda924eb2020-05-01 16:34:11 -07001352# The HHC_LOCATION tag can be used to specify the location (absolute path
1353# including file name) of the HTML help compiler (hhc.exe). If non-empty,
1354# doxygen will try to run the HTML help compiler on the generated index.hhp.
1355# The file has to be specified with full path.
1356# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001357
1358HHC_LOCATION =
1359
Yunqing Wangda924eb2020-05-01 16:34:11 -07001360# The GENERATE_CHI flag controls if a separate .chi index file is generated
1361# (YES) or that it should be included in the master .chm file (NO).
1362# The default value is: NO.
1363# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001364
1365GENERATE_CHI = NO
1366
Yunqing Wangda924eb2020-05-01 16:34:11 -07001367# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1368# and project file content.
1369# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1370
1371CHM_INDEX_ENCODING =
1372
1373# The BINARY_TOC flag controls whether a binary table of contents is generated
1374# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1375# enables the Previous and Next buttons.
1376# The default value is: NO.
1377# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001378
1379BINARY_TOC = NO
1380
Yunqing Wangda924eb2020-05-01 16:34:11 -07001381# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1382# the table of contents of the HTML help documentation and to the tree view.
1383# The default value is: NO.
1384# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001385
1386TOC_EXPAND = NO
1387
Yunqing Wangda924eb2020-05-01 16:34:11 -07001388# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1389# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1390# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1391# (.qch) of the generated HTML documentation.
1392# The default value is: NO.
1393# This tag requires that the tag GENERATE_HTML is set to YES.
1394
1395GENERATE_QHP = NO
1396
1397# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1398# the file name of the resulting .qch file. The path specified is relative to
1399# the HTML output folder.
1400# This tag requires that the tag GENERATE_QHP is set to YES.
1401
1402QCH_FILE =
1403
1404# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1405# Project output. For more information please see Qt Help Project / Namespace
1406# (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1407# The default value is: org.doxygen.Project.
1408# This tag requires that the tag GENERATE_QHP is set to YES.
1409
1410QHP_NAMESPACE = org.doxygen.Project
1411
1412# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1413# Help Project output. For more information please see Qt Help Project / Virtual
1414# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-
1415# folders).
1416# The default value is: doc.
1417# This tag requires that the tag GENERATE_QHP is set to YES.
1418
1419QHP_VIRTUAL_FOLDER = doc
1420
1421# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1422# filter to add. For more information please see Qt Help Project / Custom
1423# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
1424# filters).
1425# This tag requires that the tag GENERATE_QHP is set to YES.
1426
1427QHP_CUST_FILTER_NAME =
1428
1429# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1430# custom filter to add. For more information please see Qt Help Project / Custom
1431# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
1432# filters).
1433# This tag requires that the tag GENERATE_QHP is set to YES.
1434
1435QHP_CUST_FILTER_ATTRS =
1436
1437# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1438# project's filter section matches. Qt Help Project / Filter Attributes (see:
1439# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1440# This tag requires that the tag GENERATE_QHP is set to YES.
1441
1442QHP_SECT_FILTER_ATTRS =
1443
1444# The QHG_LOCATION tag can be used to specify the location of Qt's
1445# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1446# generated .qhp file.
1447# This tag requires that the tag GENERATE_QHP is set to YES.
1448
1449QHG_LOCATION =
1450
1451# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1452# generated, together with the HTML files, they form an Eclipse help plugin. To
1453# install this plugin and make it available under the help contents menu in
1454# Eclipse, the contents of the directory containing the HTML and XML files needs
1455# to be copied into the plugins directory of eclipse. The name of the directory
1456# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1457# After copying Eclipse needs to be restarted before the help appears.
1458# The default value is: NO.
1459# This tag requires that the tag GENERATE_HTML is set to YES.
1460
1461GENERATE_ECLIPSEHELP = NO
1462
1463# A unique identifier for the Eclipse help plugin. When installing the plugin
1464# the directory name containing the HTML and XML files should also have this
1465# name. Each documentation set should have its own identifier.
1466# The default value is: org.doxygen.Project.
1467# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1468
1469ECLIPSE_DOC_ID = org.doxygen.Project
1470
1471# If you want full control over the layout of the generated HTML pages it might
1472# be necessary to disable the index and replace it with your own. The
1473# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1474# of each HTML page. A value of NO enables the index and the value YES disables
1475# it. Since the tabs in the index contain the same information as the navigation
1476# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1477# The default value is: NO.
1478# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001479
1480DISABLE_INDEX = NO
1481
Yunqing Wangda924eb2020-05-01 16:34:11 -07001482# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1483# structure should be generated to display hierarchical information. If the tag
1484# value is set to YES, a side panel will be generated containing a tree-like
1485# index structure (just like the one that is generated for HTML Help). For this
1486# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1487# (i.e. any modern browser). Windows users are probably better off using the
1488# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1489# further fine-tune the look of the index. As an example, the default style
1490# sheet generated by doxygen has an example that shows how to put an image at
1491# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1492# the same information as the tab index, you could consider setting
1493# DISABLE_INDEX to YES when enabling this option.
1494# The default value is: NO.
1495# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001496
Yunqing Wangab4ab5a2020-05-04 15:09:35 -07001497GENERATE_TREEVIEW = YES
John Koleszar0ea50ce2010-05-18 11:58:33 -04001498
Yunqing Wangda924eb2020-05-01 16:34:11 -07001499# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1500# doxygen will group on one line in the generated HTML documentation.
1501#
1502# Note that a value of 0 will completely suppress the enum values from appearing
1503# in the overview section.
1504# Minimum value: 0, maximum value: 20, default value: 4.
1505# This tag requires that the tag GENERATE_HTML is set to YES.
1506
1507ENUM_VALUES_PER_LINE = 4
1508
1509# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1510# to set the initial width (in pixels) of the frame in which the tree is shown.
1511# Minimum value: 0, maximum value: 1500, default value: 250.
1512# This tag requires that the tag GENERATE_HTML is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001513
1514TREEVIEW_WIDTH = 250
1515
Yunqing Wangda924eb2020-05-01 16:34:11 -07001516# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1517# external symbols imported via tag files in a separate window.
1518# The default value is: NO.
1519# This tag requires that the tag GENERATE_HTML is set to YES.
1520
1521EXT_LINKS_IN_WINDOW = NO
1522
1523# Use this tag to change the font size of LaTeX formulas included as images in
1524# the HTML documentation. When you change the font size after a successful
1525# doxygen run you need to manually remove any form_*.png images from the HTML
1526# output directory to force them to be regenerated.
1527# Minimum value: 8, maximum value: 50, default value: 10.
1528# This tag requires that the tag GENERATE_HTML is set to YES.
1529
1530FORMULA_FONTSIZE = 10
1531
1532# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1533# generated for formulas are transparent PNGs. Transparent PNGs are not
1534# supported properly for IE 6.0, but are supported on all modern browsers.
1535#
1536# Note that when changing this option you need to delete any form_*.png files in
1537# the HTML output directory before the changes have effect.
1538# The default value is: YES.
1539# This tag requires that the tag GENERATE_HTML is set to YES.
1540
1541FORMULA_TRANSPARENT = YES
1542
1543# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1544# https://www.mathjax.org) which uses client side Javascript for the rendering
1545# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1546# installed or if you want to formulas look prettier in the HTML output. When
1547# enabled you may also need to install MathJax separately and configure the path
1548# to it using the MATHJAX_RELPATH option.
1549# The default value is: NO.
1550# This tag requires that the tag GENERATE_HTML is set to YES.
1551
1552USE_MATHJAX = NO
1553
1554# When MathJax is enabled you can set the default output format to be used for
1555# the MathJax output. See the MathJax site (see:
1556# http://docs.mathjax.org/en/latest/output.html) for more details.
1557# Possible values are: HTML-CSS (which is slower, but has the best
1558# compatibility), NativeMML (i.e. MathML) and SVG.
1559# The default value is: HTML-CSS.
1560# This tag requires that the tag USE_MATHJAX is set to YES.
1561
1562MATHJAX_FORMAT = HTML-CSS
1563
1564# When MathJax is enabled you need to specify the location relative to the HTML
1565# output directory using the MATHJAX_RELPATH option. The destination directory
1566# should contain the MathJax.js script. For instance, if the mathjax directory
1567# is located at the same level as the HTML output directory, then
1568# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1569# Content Delivery Network so you can quickly see the result without installing
1570# MathJax. However, it is strongly recommended to install a local copy of
1571# MathJax from https://www.mathjax.org before deployment.
1572# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/.
1573# This tag requires that the tag USE_MATHJAX is set to YES.
1574
1575MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/
1576
1577# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1578# extension names that should be enabled during MathJax rendering. For example
1579# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1580# This tag requires that the tag USE_MATHJAX is set to YES.
1581
1582MATHJAX_EXTENSIONS =
1583
1584# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1585# of code that will be used on startup of the MathJax code. See the MathJax site
1586# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1587# example see the documentation.
1588# This tag requires that the tag USE_MATHJAX is set to YES.
1589
1590MATHJAX_CODEFILE =
1591
1592# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1593# the HTML output. The underlying search engine uses javascript and DHTML and
1594# should work on any modern browser. Note that when using HTML help
1595# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1596# there is already a search function so this one should typically be disabled.
1597# For large projects the javascript based search engine can be slow, then
1598# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1599# search using the keyboard; to jump to the search box use <access key> + S
1600# (what the <access key> is depends on the OS and browser, but it is typically
1601# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1602# key> to jump into the search results window, the results can be navigated
1603# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1604# the search. The filter options can be selected when the cursor is inside the
1605# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1606# to select a filter and <Enter> or <escape> to activate or cancel the filter
1607# option.
1608# The default value is: YES.
1609# This tag requires that the tag GENERATE_HTML is set to YES.
1610
1611SEARCHENGINE = YES
1612
1613# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1614# implemented using a web server instead of a web client using Javascript. There
1615# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1616# setting. When disabled, doxygen will generate a PHP script for searching and
1617# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1618# and searching needs to be provided by external tools. See the section
1619# "External Indexing and Searching" for details.
1620# The default value is: NO.
1621# This tag requires that the tag SEARCHENGINE is set to YES.
1622
1623SERVER_BASED_SEARCH = NO
1624
1625# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1626# script for searching. Instead the search results are written to an XML file
1627# which needs to be processed by an external indexer. Doxygen will invoke an
1628# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1629# search results.
1630#
1631# Doxygen ships with an example indexer (doxyindexer) and search engine
1632# (doxysearch.cgi) which are based on the open source search engine library
1633# Xapian (see: https://xapian.org/).
1634#
1635# See the section "External Indexing and Searching" for details.
1636# The default value is: NO.
1637# This tag requires that the tag SEARCHENGINE is set to YES.
1638
1639EXTERNAL_SEARCH = NO
1640
1641# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1642# which will return the search results when EXTERNAL_SEARCH is enabled.
1643#
1644# Doxygen ships with an example indexer (doxyindexer) and search engine
1645# (doxysearch.cgi) which are based on the open source search engine library
1646# Xapian (see: https://xapian.org/). See the section "External Indexing and
1647# Searching" for details.
1648# This tag requires that the tag SEARCHENGINE is set to YES.
1649
1650SEARCHENGINE_URL =
1651
1652# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1653# search data is written to a file for indexing by an external tool. With the
1654# SEARCHDATA_FILE tag the name of this file can be specified.
1655# The default file is: searchdata.xml.
1656# This tag requires that the tag SEARCHENGINE is set to YES.
1657
1658SEARCHDATA_FILE = searchdata.xml
1659
1660# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1661# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1662# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1663# projects and redirect the results back to the right project.
1664# This tag requires that the tag SEARCHENGINE is set to YES.
1665
1666EXTERNAL_SEARCH_ID =
1667
1668# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1669# projects other than the one defined by this configuration file, but that are
1670# all added to the same external search index. Each project needs to have a
1671# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1672# to a relative location where the documentation can be found. The format is:
1673# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1674# This tag requires that the tag SEARCHENGINE is set to YES.
1675
1676EXTRA_SEARCH_MAPPINGS =
1677
John Koleszar0ea50ce2010-05-18 11:58:33 -04001678#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -07001679# Configuration options related to the LaTeX output
John Koleszar0ea50ce2010-05-18 11:58:33 -04001680#---------------------------------------------------------------------------
1681
Yunqing Wangda924eb2020-05-01 16:34:11 -07001682# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1683# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001684
1685GENERATE_LATEX = YES
1686
Yunqing Wangda924eb2020-05-01 16:34:11 -07001687# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1688# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1689# it.
1690# The default directory is: latex.
1691# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001692
1693LATEX_OUTPUT = latex
1694
Yunqing Wangda924eb2020-05-01 16:34:11 -07001695# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1696# invoked.
1697#
1698# Note that when not enabling USE_PDFLATEX the default is latex when enabling
1699# USE_PDFLATEX the default is pdflatex and when in the later case latex is
1700# chosen this is overwritten by pdflatex. For specific output languages the
1701# default can have been set differently, this depends on the implementation of
1702# the output language.
1703# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001704
1705LATEX_CMD_NAME = latex
1706
Yunqing Wangda924eb2020-05-01 16:34:11 -07001707# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1708# index for LaTeX.
1709# Note: This tag is used in the Makefile / make.bat.
1710# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
1711# (.tex).
1712# The default file is: makeindex.
1713# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001714
1715MAKEINDEX_CMD_NAME = makeindex
1716
Yunqing Wangda924eb2020-05-01 16:34:11 -07001717# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
1718# generate index for LaTeX. In case there is no backslash (\) as first character
1719# it will be automatically added in the LaTeX code.
1720# Note: This tag is used in the generated output file (.tex).
1721# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
1722# The default value is: makeindex.
1723# This tag requires that the tag GENERATE_LATEX is set to YES.
1724
1725LATEX_MAKEINDEX_CMD = makeindex
1726
1727# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1728# documents. This may be useful for small projects and may help to save some
1729# trees in general.
1730# The default value is: NO.
1731# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001732
1733COMPACT_LATEX = YES
1734
Yunqing Wangda924eb2020-05-01 16:34:11 -07001735# The PAPER_TYPE tag can be used to set the paper type that is used by the
1736# printer.
1737# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1738# 14 inches) and executive (7.25 x 10.5 inches).
1739# The default value is: a4.
1740# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001741
1742PAPER_TYPE = letter
1743
Yunqing Wangda924eb2020-05-01 16:34:11 -07001744# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1745# that should be included in the LaTeX output. The package can be specified just
1746# by its name or with the correct syntax as to be used with the LaTeX
1747# \usepackage command. To get the times font for instance you can specify :
1748# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1749# To use the option intlimits with the amsmath package you can specify:
1750# EXTRA_PACKAGES=[intlimits]{amsmath}
1751# If left blank no extra packages will be included.
1752# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001753
1754EXTRA_PACKAGES =
1755
Yunqing Wangda924eb2020-05-01 16:34:11 -07001756# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1757# generated LaTeX document. The header should contain everything until the first
1758# chapter. If it is left blank doxygen will generate a standard header. See
1759# section "Doxygen usage" for information on how to let doxygen write the
1760# default header to a separate file.
1761#
1762# Note: Only use a user-defined header if you know what you are doing! The
1763# following commands have a special meaning inside the header: $title,
1764# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1765# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1766# string, for the replacement values of the other commands the user is referred
1767# to HTML_HEADER.
1768# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001769
1770LATEX_HEADER =
1771
Yunqing Wangda924eb2020-05-01 16:34:11 -07001772# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1773# generated LaTeX document. The footer should contain everything after the last
1774# chapter. If it is left blank doxygen will generate a standard footer. See
1775# LATEX_HEADER for more information on how to generate a default footer and what
1776# special commands can be used inside the footer.
1777#
1778# Note: Only use a user-defined footer if you know what you are doing!
1779# This tag requires that the tag GENERATE_LATEX is set to YES.
1780
1781LATEX_FOOTER =
1782
1783# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1784# LaTeX style sheets that are included after the standard style sheets created
1785# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1786# will copy the style sheet files to the output directory.
1787# Note: The order of the extra style sheet files is of importance (e.g. the last
1788# style sheet in the list overrules the setting of the previous ones in the
1789# list).
1790# This tag requires that the tag GENERATE_LATEX is set to YES.
1791
1792LATEX_EXTRA_STYLESHEET =
1793
1794# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1795# other source files which should be copied to the LATEX_OUTPUT output
1796# directory. Note that the files will be copied as-is; there are no commands or
1797# markers available.
1798# This tag requires that the tag GENERATE_LATEX is set to YES.
1799
1800LATEX_EXTRA_FILES =
1801
1802# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1803# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1804# contain links (just like the HTML output) instead of page references. This
1805# makes the output suitable for online browsing using a PDF viewer.
1806# The default value is: YES.
1807# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001808
1809PDF_HYPERLINKS = YES
1810
Yunqing Wangda924eb2020-05-01 16:34:11 -07001811# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1812# the PDF file directly from the LaTeX files. Set this option to YES, to get a
John Koleszar0ea50ce2010-05-18 11:58:33 -04001813# higher quality PDF documentation.
Yunqing Wangda924eb2020-05-01 16:34:11 -07001814# The default value is: YES.
1815# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001816
1817USE_PDFLATEX = YES
1818
Yunqing Wangda924eb2020-05-01 16:34:11 -07001819# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1820# command to the generated LaTeX files. This will instruct LaTeX to keep running
1821# if errors occur, instead of asking the user for help. This option is also used
1822# when generating formulas in HTML.
1823# The default value is: NO.
1824# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001825
1826LATEX_BATCHMODE = NO
1827
Yunqing Wangda924eb2020-05-01 16:34:11 -07001828# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1829# index chapters (such as File Index, Compound Index, etc.) in the output.
1830# The default value is: NO.
1831# This tag requires that the tag GENERATE_LATEX is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001832
1833LATEX_HIDE_INDICES = NO
1834
Yunqing Wangda924eb2020-05-01 16:34:11 -07001835# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1836# code with syntax highlighting in the LaTeX output.
1837#
1838# Note that which sources are shown also depends on other settings such as
1839# SOURCE_BROWSER.
1840# The default value is: NO.
1841# This tag requires that the tag GENERATE_LATEX is set to YES.
1842
1843LATEX_SOURCE_CODE = NO
1844
1845# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1846# bibliography, e.g. plainnat, or ieeetr. See
1847# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1848# The default value is: plain.
1849# This tag requires that the tag GENERATE_LATEX is set to YES.
1850
1851LATEX_BIB_STYLE = plain
1852
1853# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1854# page will contain the date and time when the page was generated. Setting this
1855# to NO can help when comparing the output of multiple runs.
1856# The default value is: NO.
1857# This tag requires that the tag GENERATE_LATEX is set to YES.
1858
1859LATEX_TIMESTAMP = NO
1860
1861# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
1862# path from which the emoji images will be read. If a relative path is entered,
1863# it will be relative to the LATEX_OUTPUT directory. If left blank the
1864# LATEX_OUTPUT directory will be used.
1865# This tag requires that the tag GENERATE_LATEX is set to YES.
1866
1867LATEX_EMOJI_DIRECTORY =
1868
John Koleszar0ea50ce2010-05-18 11:58:33 -04001869#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -07001870# Configuration options related to the RTF output
John Koleszar0ea50ce2010-05-18 11:58:33 -04001871#---------------------------------------------------------------------------
1872
Yunqing Wangda924eb2020-05-01 16:34:11 -07001873# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1874# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1875# readers/editors.
1876# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001877
1878GENERATE_RTF = NO
1879
Yunqing Wangda924eb2020-05-01 16:34:11 -07001880# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1881# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1882# it.
1883# The default directory is: rtf.
1884# This tag requires that the tag GENERATE_RTF is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001885
1886RTF_OUTPUT = rtf
1887
Yunqing Wangda924eb2020-05-01 16:34:11 -07001888# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1889# documents. This may be useful for small projects and may help to save some
1890# trees in general.
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
1894COMPACT_RTF = NO
1895
Yunqing Wangda924eb2020-05-01 16:34:11 -07001896# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1897# contain hyperlink fields. The RTF file will contain links (just like the HTML
1898# output) instead of page references. This makes the output suitable for online
1899# browsing using Word or some other Word compatible readers that support those
1900# fields.
1901#
1902# Note: WordPad (write) and others do not support links.
1903# The default value is: NO.
1904# This tag requires that the tag GENERATE_RTF is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001905
1906RTF_HYPERLINKS = NO
1907
1908# Load stylesheet definitions from file. Syntax is similar to doxygen's
Yunqing Wangda924eb2020-05-01 16:34:11 -07001909# configuration file, i.e. a series of assignments. You only have to provide
John Koleszar0ea50ce2010-05-18 11:58:33 -04001910# replacements, missing definitions are set to their default value.
Yunqing Wangda924eb2020-05-01 16:34:11 -07001911#
1912# See also section "Doxygen usage" for information on how to generate the
1913# default style sheet that doxygen normally uses.
1914# This tag requires that the tag GENERATE_RTF is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001915
1916RTF_STYLESHEET_FILE =
1917
Yunqing Wangda924eb2020-05-01 16:34:11 -07001918# Set optional variables used in the generation of an RTF document. Syntax is
1919# similar to doxygen's configuration file. A template extensions file can be
1920# generated using doxygen -e rtf extensionFile.
1921# This tag requires that the tag GENERATE_RTF is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001922
1923RTF_EXTENSIONS_FILE =
1924
Yunqing Wangda924eb2020-05-01 16:34:11 -07001925# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1926# with syntax highlighting in the RTF output.
1927#
1928# Note that which sources are shown also depends on other settings such as
1929# SOURCE_BROWSER.
1930# The default value is: NO.
1931# This tag requires that the tag GENERATE_RTF is set to YES.
1932
1933RTF_SOURCE_CODE = NO
1934
John Koleszar0ea50ce2010-05-18 11:58:33 -04001935#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -07001936# Configuration options related to the man page output
John Koleszar0ea50ce2010-05-18 11:58:33 -04001937#---------------------------------------------------------------------------
1938
Yunqing Wangda924eb2020-05-01 16:34:11 -07001939# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1940# classes and files.
1941# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001942
1943GENERATE_MAN = NO
1944
Yunqing Wangda924eb2020-05-01 16:34:11 -07001945# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1946# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1947# it. A directory man3 will be created inside the directory specified by
1948# MAN_OUTPUT.
1949# The default directory is: man.
1950# This tag requires that the tag GENERATE_MAN is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001951
1952MAN_OUTPUT = man
1953
Yunqing Wangda924eb2020-05-01 16:34:11 -07001954# The MAN_EXTENSION tag determines the extension that is added to the generated
1955# man pages. In case the manual section does not start with a number, the number
1956# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1957# optional.
1958# The default value is: .3.
1959# This tag requires that the tag GENERATE_MAN is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001960
1961MAN_EXTENSION = .3
1962
Yunqing Wangda924eb2020-05-01 16:34:11 -07001963# The MAN_SUBDIR tag determines the name of the directory created within
1964# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1965# MAN_EXTENSION with the initial . removed.
1966# This tag requires that the tag GENERATE_MAN is set to YES.
1967
1968MAN_SUBDIR =
1969
1970# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1971# will generate one additional man file for each entity documented in the real
1972# man page(s). These additional files only source the real man page, but without
1973# them the man command would be unable to find the correct page.
1974# The default value is: NO.
1975# This tag requires that the tag GENERATE_MAN is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04001976
1977MAN_LINKS = YES
1978
1979#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -07001980# Configuration options related to the DOCBOOK output
John Koleszar0ea50ce2010-05-18 11:58:33 -04001981#---------------------------------------------------------------------------
1982
Yunqing Wangda924eb2020-05-01 16:34:11 -07001983# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1984# that can be used to generate PDF.
1985# The default value is: NO.
1986
1987GENERATE_DOCBOOK = NO
1988
1989# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1990# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1991# front of it.
1992# The default directory is: docbook.
1993# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1994
1995DOCBOOK_OUTPUT = docbook
1996
1997# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1998# program listings (including syntax highlighting and cross-referencing
1999# information) to the DOCBOOK output. Note that enabling this will significantly
2000# increase the size of the DOCBOOK output.
2001# The default value is: NO.
2002# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2003
2004DOCBOOK_PROGRAMLISTING = NO
2005
2006#---------------------------------------------------------------------------
2007# Configuration options for the AutoGen Definitions output
2008#---------------------------------------------------------------------------
2009
2010# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2011# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
2012# the structure of the code including all documentation. Note that this feature
2013# is still experimental and incomplete at the moment.
2014# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002015
2016GENERATE_AUTOGEN_DEF = NO
2017
2018#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -07002019# Configuration options related to the Perl module output
John Koleszar0ea50ce2010-05-18 11:58:33 -04002020#---------------------------------------------------------------------------
2021
Yunqing Wangda924eb2020-05-01 16:34:11 -07002022# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2023# file that captures the structure of the code including all documentation.
2024#
2025# Note that this feature is still experimental and incomplete at the moment.
2026# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002027
2028GENERATE_PERLMOD = NO
2029
Yunqing Wangda924eb2020-05-01 16:34:11 -07002030# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2031# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2032# output from the Perl module output.
2033# The default value is: NO.
2034# This tag requires that the tag GENERATE_PERLMOD is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002035
2036PERLMOD_LATEX = NO
2037
Yunqing Wangda924eb2020-05-01 16:34:11 -07002038# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2039# formatted so it can be parsed by a human reader. This is useful if you want to
2040# understand what is going on. On the other hand, if this tag is set to NO, the
2041# size of the Perl module output will be much smaller and Perl will parse it
2042# just the same.
2043# The default value is: YES.
2044# This tag requires that the tag GENERATE_PERLMOD is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002045
2046PERLMOD_PRETTY = YES
2047
Yunqing Wangda924eb2020-05-01 16:34:11 -07002048# The names of the make variables in the generated doxyrules.make file are
2049# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2050# so different doxyrules.make files included by the same Makefile don't
2051# overwrite each other's variables.
2052# This tag requires that the tag GENERATE_PERLMOD is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002053
2054PERLMOD_MAKEVAR_PREFIX =
2055
2056#---------------------------------------------------------------------------
2057# Configuration options related to the preprocessor
2058#---------------------------------------------------------------------------
2059
Yunqing Wangda924eb2020-05-01 16:34:11 -07002060# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2061# C-preprocessor directives found in the sources and include files.
2062# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002063
2064ENABLE_PREPROCESSING = YES
2065
Yunqing Wangda924eb2020-05-01 16:34:11 -07002066# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2067# in the source code. If set to NO, only conditional compilation will be
2068# performed. Macro expansion can be done in a controlled way by setting
2069# EXPAND_ONLY_PREDEF to YES.
2070# The default value is: NO.
2071# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002072
2073MACRO_EXPANSION = YES
2074
Yunqing Wangda924eb2020-05-01 16:34:11 -07002075# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2076# the macro expansion is limited to the macros specified with the PREDEFINED and
2077# EXPAND_AS_DEFINED tags.
2078# The default value is: NO.
2079# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002080
2081EXPAND_ONLY_PREDEF = NO
2082
Yunqing Wangda924eb2020-05-01 16:34:11 -07002083# If the SEARCH_INCLUDES tag is set to YES, the include files in the
2084# INCLUDE_PATH will be searched if a #include is found.
2085# The default value is: YES.
2086# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002087
2088SEARCH_INCLUDES = YES
2089
2090# The INCLUDE_PATH tag can be used to specify one or more directories that
Yunqing Wangda924eb2020-05-01 16:34:11 -07002091# contain include files that are not input files but should be processed by the
2092# preprocessor.
2093# This tag requires that the tag SEARCH_INCLUDES is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002094
2095INCLUDE_PATH =
2096
2097# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2098# patterns (like *.h and *.hpp) to filter out the header-files in the
Yunqing Wangda924eb2020-05-01 16:34:11 -07002099# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2100# used.
2101# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002102
2103INCLUDE_FILE_PATTERNS = *.h
2104
Yunqing Wangda924eb2020-05-01 16:34:11 -07002105# The PREDEFINED tag can be used to specify one or more macro names that are
2106# defined before the preprocessor is started (similar to the -D option of e.g.
2107# gcc). The argument of the tag is a list of macros of the form: name or
2108# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2109# is assumed. To prevent a macro definition from being undefined via #undef or
2110# recursively expanded use the := operator instead of the = operator.
2111# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002112
2113PREDEFINED =
2114
Yunqing Wangda924eb2020-05-01 16:34:11 -07002115# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2116# tag can be used to specify a list of macro names that should be expanded. The
2117# macro definition that is found in the sources will be used. Use the PREDEFINED
2118# tag if you want to use a different macro definition that overrules the
2119# definition found in the source code.
2120# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002121
2122EXPAND_AS_DEFINED =
2123
Yunqing Wangda924eb2020-05-01 16:34:11 -07002124# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2125# remove all references to function-like macros that are alone on a line, have
2126# an all uppercase name, and do not end with a semicolon. Such function macros
2127# are typically used for boiler-plate code, and will confuse the parser if not
2128# removed.
2129# The default value is: YES.
2130# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002131
2132SKIP_FUNCTION_MACROS = YES
2133
2134#---------------------------------------------------------------------------
Yunqing Wangda924eb2020-05-01 16:34:11 -07002135# Configuration options related to external references
John Koleszar0ea50ce2010-05-18 11:58:33 -04002136#---------------------------------------------------------------------------
2137
Yunqing Wangda924eb2020-05-01 16:34:11 -07002138# The TAGFILES tag can be used to specify one or more tag files. For each tag
2139# file the location of the external documentation should be added. The format of
2140# a tag file without this location is as follows:
2141# TAGFILES = file1 file2 ...
John Koleszar0ea50ce2010-05-18 11:58:33 -04002142# Adding location for the tag files is done as follows:
Yunqing Wangda924eb2020-05-01 16:34:11 -07002143# TAGFILES = file1=loc1 "file2 = loc2" ...
2144# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2145# section "Linking to external documentation" for more information about the use
2146# of tag files.
2147# Note: Each tag file must have a unique name (where the name does NOT include
2148# the path). If a tag file is not located in the directory in which doxygen is
2149# run, you must also specify the path to the tagfile here.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002150
2151TAGFILES =
2152
Yunqing Wangda924eb2020-05-01 16:34:11 -07002153# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2154# tag file that is based on the input files it reads. See section "Linking to
2155# external documentation" for more information about the usage of tag files.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002156
2157GENERATE_TAGFILE =
2158
Yunqing Wangda924eb2020-05-01 16:34:11 -07002159# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2160# the class index. If set to NO, only the inherited external classes will be
2161# listed.
2162# The default value is: NO.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002163
2164ALLEXTERNALS = NO
2165
Yunqing Wangda924eb2020-05-01 16:34:11 -07002166# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2167# in the modules index. If set to NO, only the current project's groups will be
2168# listed.
2169# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002170
2171EXTERNAL_GROUPS = YES
2172
Yunqing Wangda924eb2020-05-01 16:34:11 -07002173# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2174# the related pages index. If set to NO, only the current project's pages will
2175# be listed.
2176# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002177
Yunqing Wangda924eb2020-05-01 16:34:11 -07002178EXTERNAL_PAGES = YES
John Koleszar0ea50ce2010-05-18 11:58:33 -04002179
2180#---------------------------------------------------------------------------
2181# Configuration options related to the dot tool
2182#---------------------------------------------------------------------------
2183
Yunqing Wangda924eb2020-05-01 16:34:11 -07002184# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2185# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2186# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2187# disabled, but it is recommended to install and use dot, since it yields more
John Koleszar0ea50ce2010-05-18 11:58:33 -04002188# powerful graphs.
Yunqing Wangda924eb2020-05-01 16:34:11 -07002189# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002190
2191CLASS_DIAGRAMS = YES
2192
Yunqing Wangda924eb2020-05-01 16:34:11 -07002193# You can include diagrams made with dia in doxygen documentation. Doxygen will
2194# then run dia to produce the diagram and insert it in the documentation. The
2195# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2196# If left empty dia is assumed to be found in the default search path.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002197
Yunqing Wangda924eb2020-05-01 16:34:11 -07002198DIA_PATH =
John Koleszar0ea50ce2010-05-18 11:58:33 -04002199
Yunqing Wangda924eb2020-05-01 16:34:11 -07002200# If set to YES the inheritance and collaboration graphs will hide inheritance
2201# and usage relations if the target is undocumented or is not a class.
2202# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002203
2204HIDE_UNDOC_RELATIONS = YES
2205
2206# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
Yunqing Wangda924eb2020-05-01 16:34:11 -07002207# available from the path. This tool is part of Graphviz (see:
2208# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2209# Bell Labs. The other options in this section have no effect if this option is
2210# set to NO
2211# The default value is: YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002212
Yunqing Wangda924eb2020-05-01 16:34:11 -07002213HAVE_DOT = YES
John Koleszar0ea50ce2010-05-18 11:58:33 -04002214
Yunqing Wangda924eb2020-05-01 16:34:11 -07002215# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2216# to run in parallel. When set to 0 doxygen will base this on the number of
2217# processors available in the system. You can set it explicitly to a value
2218# larger than 0 to get control over the balance between CPU load and processing
2219# speed.
2220# Minimum value: 0, maximum value: 32, default value: 0.
2221# This tag requires that the tag HAVE_DOT is set to YES.
2222
2223DOT_NUM_THREADS = 0
2224
2225# When you want a differently looking font in the dot files that doxygen
2226# generates you can specify the font name using DOT_FONTNAME. You need to make
2227# sure dot is able to find the font, which can be done by putting it in a
2228# standard location or by setting the DOTFONTPATH environment variable or by
2229# setting DOT_FONTPATH to the directory containing the font.
2230# The default value is: Helvetica.
2231# This tag requires that the tag HAVE_DOT is set to YES.
2232
2233DOT_FONTNAME = Helvetica
2234
2235# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2236# dot graphs.
2237# Minimum value: 4, maximum value: 24, default value: 10.
2238# This tag requires that the tag HAVE_DOT is set to YES.
2239
2240DOT_FONTSIZE = 10
2241
2242# By default doxygen will tell dot to use the default font as specified with
2243# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2244# the path where dot can find it using this tag.
2245# This tag requires that the tag HAVE_DOT is set to YES.
2246
2247DOT_FONTPATH =
2248
2249# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2250# each documented class showing the direct and indirect inheritance relations.
2251# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
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
2255CLASS_GRAPH = YES
2256
Yunqing Wangda924eb2020-05-01 16:34:11 -07002257# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2258# graph for each documented class showing the direct and indirect implementation
2259# dependencies (inheritance, containment, and class references variables) of the
2260# class with other documented classes.
2261# The default value is: YES.
2262# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002263
2264COLLABORATION_GRAPH = YES
2265
Yunqing Wangda924eb2020-05-01 16:34:11 -07002266# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2267# groups, showing the direct groups dependencies.
2268# The default value is: YES.
2269# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002270
2271GROUP_GRAPHS = YES
2272
Yunqing Wangda924eb2020-05-01 16:34:11 -07002273# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
John Koleszar0ea50ce2010-05-18 11:58:33 -04002274# collaboration diagrams in a style similar to the OMG's Unified Modeling
2275# Language.
Yunqing Wangda924eb2020-05-01 16:34:11 -07002276# The default value is: NO.
2277# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002278
2279UML_LOOK = NO
2280
Yunqing Wangda924eb2020-05-01 16:34:11 -07002281# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2282# class node. If there are many fields or methods and many nodes the graph may
2283# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2284# number of items for each type to make the size more manageable. Set this to 0
2285# for no limit. Note that the threshold may be exceeded by 50% before the limit
2286# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2287# but if the number exceeds 15, the total amount of fields shown is limited to
2288# 10.
2289# Minimum value: 0, maximum value: 100, default value: 10.
2290# This tag requires that the tag HAVE_DOT is set to YES.
2291
2292UML_LIMIT_NUM_FIELDS = 10
2293
2294# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2295# collaboration graphs will show the relations between templates and their
2296# instances.
2297# The default value is: NO.
2298# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002299
2300TEMPLATE_RELATIONS = NO
2301
Yunqing Wangda924eb2020-05-01 16:34:11 -07002302# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2303# YES then doxygen will generate a graph for each documented file showing the
2304# 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
2309INCLUDE_GRAPH = YES
2310
Yunqing Wangda924eb2020-05-01 16:34:11 -07002311# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2312# set to YES then doxygen will generate a graph for each documented file showing
2313# the direct and indirect include dependencies of the file with other documented
2314# files.
2315# The default value is: YES.
2316# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002317
2318INCLUDED_BY_GRAPH = YES
2319
Yunqing Wangda924eb2020-05-01 16:34:11 -07002320# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2321# dependency graph for every global function or class method.
2322#
John Koleszar0ea50ce2010-05-18 11:58:33 -04002323# Note that enabling this option will significantly increase the time of a run.
2324# So in most cases it will be better to enable call graphs for selected
Yunqing Wangda924eb2020-05-01 16:34:11 -07002325# functions only using the \callgraph command. Disabling a call graph can be
2326# accomplished by means of the command \hidecallgraph.
2327# The default value is: NO.
2328# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002329
2330CALL_GRAPH = NO
2331
Yunqing Wangda924eb2020-05-01 16:34:11 -07002332# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2333# dependency graph for every global function or class method.
2334#
John Koleszar0ea50ce2010-05-18 11:58:33 -04002335# Note that enabling this option will significantly increase the time of a run.
2336# So in most cases it will be better to enable caller graphs for selected
Yunqing Wangda924eb2020-05-01 16:34:11 -07002337# functions only using the \callergraph command. Disabling a caller graph can be
2338# accomplished by means of the command \hidecallergraph.
2339# The default value is: NO.
2340# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002341
2342CALLER_GRAPH = NO
2343
Yunqing Wangda924eb2020-05-01 16:34:11 -07002344# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2345# hierarchy of all classes instead of a textual one.
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
2349GRAPHICAL_HIERARCHY = YES
2350
Yunqing Wangda924eb2020-05-01 16:34:11 -07002351# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2352# dependencies a directory has on other directories in a graphical way. The
2353# dependency relations are determined by the #include relations between the
2354# files in the directories.
2355# The default value is: YES.
2356# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002357
2358DIRECTORY_GRAPH = YES
2359
2360# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
Yunqing Wangda924eb2020-05-01 16:34:11 -07002361# generated by dot. For an explanation of the image formats see the section
2362# output formats in the documentation of the dot tool (Graphviz (see:
2363# http://www.graphviz.org/)).
2364# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2365# to make the SVG files visible in IE 9+ (other browsers do not have this
2366# requirement).
2367# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2368# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2369# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
2370# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2371# png:gdiplus:gdiplus.
2372# The default value is: png.
2373# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002374
2375DOT_IMAGE_FORMAT = png
2376
Yunqing Wangda924eb2020-05-01 16:34:11 -07002377# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2378# enable generation of interactive SVG images that allow zooming and panning.
2379#
2380# Note that this requires a modern browser other than Internet Explorer. Tested
2381# and working are Firefox, Chrome, Safari, and Opera.
2382# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2383# the SVG files visible. Older versions of IE do not have SVG support.
2384# The default value is: NO.
2385# This tag requires that the tag HAVE_DOT is set to YES.
2386
2387INTERACTIVE_SVG = NO
2388
2389# The DOT_PATH tag can be used to specify the path where the dot tool can be
John Koleszar0ea50ce2010-05-18 11:58:33 -04002390# found. If left blank, it is assumed the dot tool can be found in the path.
Yunqing Wangda924eb2020-05-01 16:34:11 -07002391# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002392
2393DOT_PATH =
2394
2395# The DOTFILE_DIRS tag can be used to specify one or more directories that
Yunqing Wangda924eb2020-05-01 16:34:11 -07002396# contain dot files that are included in the documentation (see the \dotfile
2397# command).
2398# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002399
2400DOTFILE_DIRS =
2401
Yunqing Wangda924eb2020-05-01 16:34:11 -07002402# The MSCFILE_DIRS tag can be used to specify one or more directories that
2403# contain msc files that are included in the documentation (see the \mscfile
2404# command).
2405
2406MSCFILE_DIRS =
2407
2408# The DIAFILE_DIRS tag can be used to specify one or more directories that
2409# contain dia files that are included in the documentation (see the \diafile
2410# command).
2411
2412DIAFILE_DIRS =
2413
2414# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2415# path where java can find the plantuml.jar file. If left blank, it is assumed
2416# PlantUML is not used or called during a preprocessing step. Doxygen will
2417# generate a warning when it encounters a \startuml command in this case and
2418# will not generate output for the diagram.
2419
2420PLANTUML_JAR_PATH =
2421
2422# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2423# configuration file for plantuml.
2424
2425PLANTUML_CFG_FILE =
2426
2427# When using plantuml, the specified paths are searched for files specified by
2428# the !include statement in a plantuml block.
2429
2430PLANTUML_INCLUDE_PATH =
2431
2432# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2433# that will be shown in the graph. If the number of nodes in a graph becomes
2434# larger than this value, doxygen will truncate the graph, which is visualized
2435# by representing a node as a red box. Note that doxygen if the number of direct
2436# children of the root node in a graph is already larger than
2437# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2438# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2439# Minimum value: 0, maximum value: 10000, default value: 50.
2440# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002441
2442DOT_GRAPH_MAX_NODES = 50
2443
Yunqing Wangda924eb2020-05-01 16:34:11 -07002444# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2445# generated by dot. A depth value of 3 means that only nodes reachable from the
2446# root by following a path via at most 3 edges will be shown. Nodes that lay
2447# further from the root node will be omitted. Note that setting this option to 1
2448# or 2 may greatly reduce the computation time needed for large code bases. Also
2449# note that the size of a graph can be further restricted by
John Koleszar0ea50ce2010-05-18 11:58:33 -04002450# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
Yunqing Wangda924eb2020-05-01 16:34:11 -07002451# Minimum value: 0, maximum value: 1000, default value: 0.
2452# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002453
2454MAX_DOT_GRAPH_DEPTH = 0
2455
2456# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
Yunqing Wangda924eb2020-05-01 16:34:11 -07002457# background. This is disabled by default, because dot on Windows does not seem
2458# to support this out of the box.
2459#
John Koleszar0ea50ce2010-05-18 11:58:33 -04002460# Warning: Depending on the platform used, enabling this option may lead to
2461# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2462# read).
Yunqing Wangda924eb2020-05-01 16:34:11 -07002463# 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
Yunqing Wangda924eb2020-05-01 16:34:11 -07002466DOT_TRANSPARENT = NO
John Koleszar0ea50ce2010-05-18 11:58:33 -04002467
Yunqing Wangda924eb2020-05-01 16:34:11 -07002468# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
John Koleszar0ea50ce2010-05-18 11:58:33 -04002469# files in one run (i.e. multiple -o and -T options on the command line). This
Yunqing Wangda924eb2020-05-01 16:34:11 -07002470# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2471# this, this feature is disabled by default.
2472# The default value is: NO.
2473# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002474
2475DOT_MULTI_TARGETS = NO
2476
Yunqing Wangda924eb2020-05-01 16:34:11 -07002477# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2478# explaining the meaning of the various boxes and arrows in the dot generated
2479# graphs.
2480# The default value is: YES.
2481# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002482
2483GENERATE_LEGEND = YES
2484
Yunqing Wangda924eb2020-05-01 16:34:11 -07002485# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2486# files that are used to generate the various graphs.
2487# The default value is: YES.
2488# This tag requires that the tag HAVE_DOT is set to YES.
John Koleszar0ea50ce2010-05-18 11:58:33 -04002489
2490DOT_CLEANUP = YES
2491
2492#---------------------------------------------------------------------------
2493# Configuration::additions related to the search engine
2494#---------------------------------------------------------------------------
2495
2496# The SEARCHENGINE tag specifies whether or not a search engine should be
2497# used. If set to NO the values of all tags below this one will be ignored.
2498
2499SEARCHENGINE = NO