VirtualBox

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

Last change on this file was 105381, checked in by vboxsync, 4 months ago

Doxyfile*,gen-slickedit-workspace.sh: Treat RT_IPRT_CALLREQ_ATTR as a no-op here. bugref:10725

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