VirtualBox

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

Last change on this file since 98188 was 92153, checked in by vboxsync, 3 years ago

Main/doxygen: Remove the attempt to produce a .chm file with the doxygen generated API documentation. HTML is good enough. In doxygen.xsl handle input in <tt> specially, which currently means quoting :: to avoid annoying error messages from doxygen. Additionally switch to the string processing templates from doc/manual/string.xsl, phasing out the home grown ones (too much work to write another string replace template, and too inconsistent to keep using the self-written uppercasing). Finally no more doxygen complaint about the MAC address example in the API documentation.

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