VirtualBox

source: vbox/trunk/src/VBox/Frontends/VirtualBox/Doxyfile@ 83432

Last change on this file since 83432 was 81741, checked in by vboxsync, 5 years ago

minor doxyfile polishing, to avoid a few warnings

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