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