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