VirtualBox

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

Last change on this file since 59527 was 57976, checked in by vboxsync, 9 years ago

Runtime/Doxyfile: updated the file and fixed the missing @endlink in the callback_method_impl{2} alias.

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

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