VirtualBox

source: vbox/trunk/src/VBox/Runtime/Doxyfile@ 100594

Last change on this file since 100594 was 99759, checked in by vboxsync, 19 months ago

IPRT/Doxyfile: updated and re-enabled markdown. bugref:10442

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette