VirtualBox

source: vbox/trunk/src/VBox/Main/Doxyfile.Main@ 103068

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

Main: Upgraded the doxygen file to 1.9.6. bugref:10442

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

© 2023 Oracle
ContactPrivacy policyTerms of Use