VirtualBox

source: vbox/trunk/src/VBox/Frontends/VirtualBox/Doxyfile@ 103068

Last change on this file since 103068 was 99763, checked in by vboxsync, 14 months ago

VirtualBox/Doxyfile: updated to 1.9.6. bugref:10442

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

© 2023 Oracle
ContactPrivacy policyTerms of Use