3
# This file describes the settings to be used by the documentation system
4
# doxygen (www.doxygen.org) for a project
6
# All text after a hash (#) is considered a comment and will be ignored
8
# TAG = value [value, ...]
9
# For lists items can also be appended using:
10
# TAG += value [value, ...]
11
# Values that contain spaces should be placed between quotes (" ")13
#---------------------------------------------------------------------------
14
# Project related configuration options
15
#---------------------------------------------------------------------------
17
# This tag specifies the encoding used for all characters in the config file
18
# that follow. The default is UTF-8 which is also the encoding used for all
19
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20
# iconv built into libc) for the transcoding. See
21
# http://www.gnu.org/software/libiconv for the list of possible encodings.
23
DOXYFILE_ENCODING = UTF-8
25
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26
# by quotes) that should identify the project.
30
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
31
# This could be handy for archiving the generated documentation or
32
# if some version control system is used.
36
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37
# base path where the generated documentation will be put.
38
# If a relative path is entered, it will be relative to the location
39
# where doxygen was started. If left blank the current directory will be used.
43
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44
# 4096 sub-directories (in 2 levels) under the output directory of each output
45
# format and will distribute the generated files over these directories.
46
# Enabling this option can be useful when feeding doxygen a huge amount of
47
# source files, where putting all generated files in the same directory would
48
# otherwise cause performance problems for the file system.
52
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
53
# documentation generated by doxygen is written. Doxygen will use this
54
# information to generate all constant output in the proper language.
55
# The default language is English, other supported languages are:
56
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
58
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
59
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
60
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
61
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
63
OUTPUT_LANGUAGE = English
65
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66
# include brief member descriptions after the members that are listed in
67
# the file and class documentation (similar to JavaDoc).
68
# Set to NO to disable this.
70
BRIEF_MEMBER_DESC = YES
72
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73
# the brief description of a member or function before the detailed description.
74
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75
# brief descriptions will be completely suppressed.
79
# This tag implements a quasi-intelligent brief description abbreviator
80
# that is used to form the text in various listings. Each string
81
# in this list, if found as the leading text of the brief description, will be
82
# stripped from the text and the result after processing the whole list, is
83
# used as the annotated text. Otherwise, the brief description is used as-is.
84
# If left blank, the following values are used ("$name" is automatically85
# replaced with the name of the entity): "The $name class" "The $name widget"
86
# "The $name file" "is" "provides" "specifies" "contains"
87
# "represents" "a" "an" "the"
91
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
92
# Doxygen will generate a detailed section even if there is only a brief
95
ALWAYS_DETAILED_SEC = YES
97
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
98
# inherited members of a class in the documentation of that class as if those
99
# members were ordinary class members. Constructors, destructors and assignment
100
# operators of the base classes will not be shown.
102
INLINE_INHERITED_MEMB = NO
104
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
105
# path before files name in the file list and in the header files. If set
106
# to NO the shortest path that makes the file name unique will be used.
110
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
111
# can be used to strip a user-defined part of the path. Stripping is
112
# only done if one of the specified strings matches the left-hand part of
113
# the path. The tag can be used to show relative paths in the file list.
114
# If left blank the directory from which doxygen is run is used as the
119
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
120
# the path mentioned in the documentation of a class, which tells
121
# the reader which header file to include in order to use a class.
122
# If left blank only the name of the header file containing the class
123
# definition is used. Otherwise one should specify the include paths that
124
# are normally passed to the compiler using the -I flag.
128
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
129
# (but less readable) file names. This can be useful is your file systems
130
# doesn't support long names like on DOS, Mac, or CD-ROM.
134
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
135
# will interpret the first line (until the first dot) of a JavaDoc-style
136
# comment as the brief description. If set to NO, the JavaDoc
137
# comments will behave just like regular Qt-style comments
138
# (thus requiring an explicit @brief command for a brief description.)
140
JAVADOC_AUTOBRIEF = NO
142
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
143
# interpret the first line (until the first dot) of a Qt-style
144
# comment as the brief description. If set to NO, the comments
145
# will behave just like regular Qt-style comments (thus requiring
146
# an explicit \brief command for a brief description.)
150
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
151
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
152
# comments) as a brief description. This used to be the default behaviour.
153
# The new default is to treat a multi-line C++ comment block as a detailed
154
# description. Set this tag to YES if you prefer the old behaviour instead.
156
MULTILINE_CPP_IS_BRIEF = NO
158
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
159
# member inherits the documentation from any documented member that it
164
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
165
# a new page for each member. If set to NO, the documentation of a member will
166
# be part of the file/class/namespace that contains it.
168
SEPARATE_MEMBER_PAGES = NO
170
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
171
# Doxygen uses this value to replace tabs by spaces in code fragments.
175
# This tag can be used to specify a number of aliases that acts
176
# as commands in the documentation. An alias has the form "name=value".
177
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
178
# put the command \sideeffect (or @sideeffect) in the documentation, which
179
# will result in a user-defined paragraph with heading "Side Effects:".
180
# You can put \n's in the value part of an alias to insert newlines.
184
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
185
# sources only. Doxygen will then generate output that is more tailored for C.
186
# For instance, some of the names that are used will be different. The list
187
# of all members will be omitted, etc.
189
OPTIMIZE_OUTPUT_FOR_C = NO
191
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
192
# sources only. Doxygen will then generate output that is more tailored for
193
# Java. For instance, namespaces will be presented as packages, qualified
194
# scopes will look different, etc.
196
OPTIMIZE_OUTPUT_JAVA = NO
198
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
199
# sources only. Doxygen will then generate output that is more tailored for
202
OPTIMIZE_FOR_FORTRAN = NO
204
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
205
# sources. Doxygen will then generate output that is tailored for
208
OPTIMIZE_OUTPUT_VHDL = NO
210
# Doxygen selects the parser to use depending on the extension of the files it parses.
211
# With this tag you can assign which parser to use for a given extension.
212
# Doxygen has a built-in mapping, but you can override or extend it using this tag.
213
# The format is ext=language, where ext is a file extension, and language is one of
214
# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
215
# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
216
# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
217
# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
221
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
222
# to include (a tag file for) the STL sources as input, then you should
223
# set this tag to YES in order to let doxygen match functions declarations and
224
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
225
# func(std::string) {}). This also make the inheritance and collaboration226
# diagrams that involve STL classes more complete and accurate.
228
BUILTIN_STL_SUPPORT = NO
230
# If you use Microsoft's C++/CLI language, you should set this option to YES to
231
# enable parsing support.
235
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
236
# Doxygen will parse them like normal C++ but will assume all classes use public
237
# instead of private inheritance when no explicit protection keyword is present.
241
# For Microsoft's IDL there are propget and propput attributes to indicate getter
242
# and setter methods for a property. Setting this option to YES (the default)
243
# will make doxygen to replace the get and set methods by a property in the
244
# documentation. This will only work if the methods are indeed getting or
245
# setting a simple type. If this is not the case, or you want to show the
246
# methods anyway, you should set this option to NO.
248
IDL_PROPERTY_SUPPORT = YES
250
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
251
# tag is set to YES, then doxygen will reuse the documentation of the first
252
# member in the group (if any) for the other members of the group. By default
253
# all members of a group must be documented explicitly.
255
DISTRIBUTE_GROUP_DOC = NO
257
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
258
# the same type (for instance a group of public functions) to be put as a
259
# subgroup of that type (e.g. under the Public Functions section). Set it to
260
# NO to prevent subgrouping. Alternatively, this can be done per class using
261
# the \nosubgrouping command.
265
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
266
# is documented as struct, union, or enum with the name of the typedef. So
267
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct268
# with name TypeT. When disabled the typedef will appear as a member of a file,
269
# namespace, or class. And the struct will be named TypeS. This can typically
270
# be useful for C code in case the coding convention dictates that all compound
271
# types are typedef'ed and only the typedef is referenced, never the tag name.
273
TYPEDEF_HIDES_STRUCT = NO
275
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
276
# determine which symbols to keep in memory and which to flush to disk.
277
# When the cache is full, less often used symbols will be written to disk.
278
# For small to medium size projects (<1000 input files) the default value is
279
# probably good enough. For larger projects a too small cache size can cause
280
# doxygen to be busy swapping symbols to and from disk most of the time
281
# causing a significant performance penalty.
282
# If the system has enough physical memory increasing the cache will improve the
283
# performance by keeping more symbols in memory. Note that the value works on
284
# a logarithmic scale so increasing the size by one will rougly double the
285
# memory usage. The cache size is given by this formula:
286
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
287
# corresponding to a cache size of 2^16 = 65536 symbols
291
#---------------------------------------------------------------------------
292
# Build related configuration options
293
#---------------------------------------------------------------------------
295
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
296
# documentation are documented, even if no documentation was available.
297
# Private class members and static file members will be hidden unless
298
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
302
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
303
# will be included in the documentation.
307
# If the EXTRACT_STATIC tag is set to YES all static members of a file
308
# will be included in the documentation.
312
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
313
# defined locally in source files will be included in the documentation.
314
# If set to NO only classes defined in header files are included.
316
EXTRACT_LOCAL_CLASSES = YES
318
# This flag is only useful for Objective-C code. When set to YES local
319
# methods, which are defined in the implementation section but not in
320
# the interface are included in the documentation.
321
# If set to NO (the default) only methods in the interface are included.
323
EXTRACT_LOCAL_METHODS = YES
325
# If this flag is set to YES, the members of anonymous namespaces will be
326
# extracted and appear in the documentation as a namespace called
327
# 'anonymous_namespace{file}', where file will be replaced with the base328
# name of the file that contains the anonymous namespace. By default
329
# anonymous namespace are hidden.
331
EXTRACT_ANON_NSPACES = NO
333
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
334
# undocumented members of documented classes, files or namespaces.
335
# If set to NO (the default) these members will be included in the
336
# various overviews, but no documentation section is generated.
337
# This option has no effect if EXTRACT_ALL is enabled.
339
HIDE_UNDOC_MEMBERS = NO
341
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
342
# undocumented classes that are normally visible in the class hierarchy.
343
# If set to NO (the default) these classes will be included in the various
344
# overviews. This option has no effect if EXTRACT_ALL is enabled.
346
HIDE_UNDOC_CLASSES = YES
348
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
349
# friend (class|struct|union) declarations.
350
# If set to NO (the default) these declarations will be included in the
353
HIDE_FRIEND_COMPOUNDS = NO
355
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
356
# documentation blocks found inside the body of a function.
357
# If set to NO (the default) these blocks will be appended to the
358
# function's detailed documentation block.
360
HIDE_IN_BODY_DOCS = NO
362
# The INTERNAL_DOCS tag determines if documentation
363
# that is typed after a \internal command is included. If the tag is set
364
# to NO (the default) then the documentation will be excluded.
365
# Set it to YES to include the internal documentation.
369
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
370
# file names in lower-case letters. If set to YES upper-case letters are also
371
# allowed. This is useful if you have classes or files whose names only differ
372
# in case and if your file system supports case sensitive file names. Windows
373
# and Mac users are advised to set this option to NO.
375
CASE_SENSE_NAMES = YES
377
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
378
# will show members with their full class and namespace scopes in the
379
# documentation. If set to YES the scope will be hidden.
383
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
384
# will put a list of the files that are included by a file in the documentation
387
SHOW_INCLUDE_FILES = YES
389
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
390
# is inserted in the documentation for inline members.
394
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
395
# will sort the (detailed) documentation of file and class members
396
# alphabetically by member name. If set to NO the members will appear in
399
SORT_MEMBER_DOCS = YES
401
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
402
# brief documentation of file, namespace and class members alphabetically
403
# by member name. If set to NO (the default) the members will appear in
408
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
410
SORT_MEMBERS_CTORS_1ST = NO
412
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
413
# hierarchy of group names into alphabetical order. If set to NO (the default)
414
# the group names will appear in their defined order.
418
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
419
# sorted by fully-qualified names, including namespaces. If set to
420
# NO (the default), the class list will be sorted only by class name,
421
# not including the namespace part.
422
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
423
# Note: This option applies only to the class list, not to the
426
SORT_BY_SCOPE_NAME = NO
428
# The GENERATE_TODOLIST tag can be used to enable (YES) or
429
# disable (NO) the todo list. This list is created by putting \todo
430
# commands in the documentation.
432
GENERATE_TODOLIST = YES
434
# The GENERATE_TESTLIST tag can be used to enable (YES) or
435
# disable (NO) the test list. This list is created by putting \test
436
# commands in the documentation.
438
GENERATE_TESTLIST = YES
440
# The GENERATE_BUGLIST tag can be used to enable (YES) or
441
# disable (NO) the bug list. This list is created by putting \bug
442
# commands in the documentation.
444
GENERATE_BUGLIST = YES
446
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
447
# disable (NO) the deprecated list. This list is created by putting
448
# \deprecated commands in the documentation.
450
GENERATE_DEPRECATEDLIST= YES
452
# The ENABLED_SECTIONS tag can be used to enable conditional
453
# documentation sections, marked by \if sectionname ... \endif.
455
ENABLED_SECTIONS = YES
457
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
458
# the initial value of a variable or define consists of for it to appear in
459
# the documentation. If the initializer consists of more lines than specified
460
# here it will be hidden. Use a value of 0 to hide initializers completely.
461
# The appearance of the initializer of individual variables and defines in the
462
# documentation can be controlled using \showinitializer or \hideinitializer
463
# command in the documentation regardless of this setting.
465
MAX_INITIALIZER_LINES = 30
467
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
468
# at the bottom of the documentation of classes and structs. If set to YES the
469
# list will mention the files that were used to generate the documentation.
473
# If the sources in your project are distributed over multiple directories
474
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
475
# in the documentation. The default is NO.
477
SHOW_DIRECTORIES = YES
479
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
480
# This will remove the Files entry from the Quick Index and from the
481
# Folder Tree View (if specified). The default is YES.
485
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
487
# This will remove the Namespaces entry from the Quick Index
488
# and from the Folder Tree View (if specified). The default is YES.
492
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
493
# doxygen should invoke to get the current version for each file (typically from
494
# the version control system). Doxygen will invoke the program by executing (via
495
# popen()) the command <command> <input-file>, where <command> is the value of
496
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
497
# provided by doxygen. Whatever the program writes to standard output
498
# is used as the file version. See the manual for examples.
502
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
503
# doxygen. The layout file controls the global structure of the generated output files
504
# in an output format independent way. The create the layout file that represents
505
# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
506
# file name after the option, if omitted DoxygenLayout.xml will be used as the name
511
#---------------------------------------------------------------------------
512
# configuration options related to warning and progress messages
513
#---------------------------------------------------------------------------
515
# The QUIET tag can be used to turn on/off the messages that are generated
516
# by doxygen. Possible values are YES and NO. If left blank NO is used.
520
# The WARNINGS tag can be used to turn on/off the warning messages that are
521
# generated by doxygen. Possible values are YES and NO. If left blank
526
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
527
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
528
# automatically be disabled.
530
WARN_IF_UNDOCUMENTED = NO
532
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
533
# potential errors in the documentation, such as not documenting some
534
# parameters in a documented function, or documenting parameters that
535
# don't exist or using markup commands wrongly.
537
WARN_IF_DOC_ERROR = YES
539
# This WARN_NO_PARAMDOC option can be abled to get warnings for
540
# functions that are documented, but have no documentation for their parameters
541
# or return value. If set to NO (the default) doxygen will only warn about
542
# wrong or incomplete parameter documentation, but not about the absence of
547
# The WARN_FORMAT tag determines the format of the warning messages that
548
# doxygen can produce. The string should contain the $file, $line, and $text
549
# tags, which will be replaced by the file and line number from which the
550
# warning originated and the warning text. Optionally the format may contain
551
# $version, which will be replaced by the version of the file (if it could
552
# be obtained via FILE_VERSION_FILTER)
556
# The WARN_LOGFILE tag can be used to specify a file to which warning
557
# and error messages should be written. If left blank the output is written
562
#---------------------------------------------------------------------------
563
# configuration options related to the input files
564
#---------------------------------------------------------------------------
566
# The INPUT tag can be used to specify the files and/or directories that contain
567
# documented source files. You may enter file names like "myfile.cpp" or
568
# directories like "/usr/src/myproject". Separate the files or directories
576
# This tag can be used to specify the character encoding of the source files
577
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
578
# also the default input encoding. Doxygen uses libiconv (or the iconv built
579
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
580
# the list of possible encodings.
582
INPUT_ENCODING = UTF-8
584
# If the value of the INPUT tag contains directories, you can use the
585
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
586
# and *.h) to filter out the source-files in the directories. If left
587
# blank the following patterns are tested:
588
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
589
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
595
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
596
# should be searched for input files as well. Possible values are YES and NO.
597
# If left blank NO is used.
601
# The EXCLUDE tag can be used to specify files and/or directories that should
602
# excluded from the INPUT source files. This way you can easily exclude a
603
# subdirectory from a directory tree whose root is specified with the INPUT tag.
607
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
608
# directories that are symbolic links (a Unix filesystem feature) are excluded
613
# If the value of the INPUT tag contains directories, you can use the
614
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
615
# certain files from those directories. Note that the wildcards are matched
616
# against the file with absolute path, so to exclude all test directories
617
# for example use the pattern */test/*
619
EXCLUDE_PATTERNS = *.moc.* \
623
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
624
# (namespaces, classes, functions, etc.) that should be excluded from the
625
# output. The symbol name can be a fully qualified name, a word, or if the
626
# wildcard * is used, a substring. Examples: ANamespace, AClass,
627
# AClass::ANamespace, ANamespace::*Test
631
# The EXAMPLE_PATH tag can be used to specify one or more files or
632
# directories that contain example code fragments that are included (see
633
# the \include command).
637
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
638
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
639
# and *.h) to filter out the source-files in the directories. If left
640
# blank all files are included.
644
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
645
# searched for input files to be used with the \include or \dontinclude
646
# commands irrespective of the value of the RECURSIVE tag.
647
# Possible values are YES and NO. If left blank NO is used.
649
EXAMPLE_RECURSIVE = NO
651
# The IMAGE_PATH tag can be used to specify one or more files or
652
# directories that contain image that are included in the documentation (see
653
# the \image command).
657
# The INPUT_FILTER tag can be used to specify a program that doxygen should
658
# invoke to filter for each input file. Doxygen will invoke the filter program
659
# by executing (via popen()) the command <filter> <input-file>, where <filter>
660
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
661
# input file. Doxygen will then use the output that the filter program writes
663
# If FILTER_PATTERNS is specified, this tag will be
668
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
670
# Doxygen will compare the file name with each pattern and apply the
671
# filter if there is a match.
672
# The filters are a list of the form:
673
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
674
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
675
# is applied to all files.
679
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
680
# INPUT_FILTER) will be used to filter the input files when producing source
681
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
683
FILTER_SOURCE_FILES = NO
685
#---------------------------------------------------------------------------
686
# configuration options related to source browsing
687
#---------------------------------------------------------------------------
689
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
690
# be generated. Documented entities will be cross-referenced with these sources.
691
# Note: To get rid of all source code in the generated output, make sure also
692
# VERBATIM_HEADERS is set to NO.
696
# Setting the INLINE_SOURCES tag to YES will include the body
697
# of functions and classes directly in the documentation.
701
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
702
# doxygen to hide any special comment blocks from generated source code
703
# fragments. Normal C and C++ comments will always remain visible.
705
STRIP_CODE_COMMENTS = YES
707
# If the REFERENCED_BY_RELATION tag is set to YES
708
# then for each documented function all documented
709
# functions referencing it will be listed.
711
REFERENCED_BY_RELATION = YES
713
# If the REFERENCES_RELATION tag is set to YES
714
# then for each documented function all documented entities
715
# called/used by that function will be listed.
717
REFERENCES_RELATION = YES
719
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
720
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
721
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
722
# link to the source code.
723
# Otherwise they will link to the documentation.
725
REFERENCES_LINK_SOURCE = YES
727
# If the USE_HTAGS tag is set to YES then the references to source code
728
# will point to the HTML generated by the htags(1) tool instead of doxygen
729
# built-in source browser. The htags tool is part of GNU's global source
730
# tagging system (see http://www.gnu.org/software/global/global.html). You
731
# will need version 4.8.6 or higher.
735
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
736
# will generate a verbatim copy of the header file for each class for
737
# which an include is specified. Set to NO to disable this.
741
#---------------------------------------------------------------------------
742
# configuration options related to the alphabetical class index
743
#---------------------------------------------------------------------------
745
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
746
# of all compounds will be generated. Enable this if the project
747
# contains a lot of classes, structs, unions or interfaces.
749
ALPHABETICAL_INDEX = NO
751
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
752
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
753
# in which this list will be split (can be a number in the range [1..20])
755
COLS_IN_ALPHA_INDEX = 5
757
# In case all classes in a project start with a common prefix, all
758
# classes will be put under the same header in the alphabetical index.
759
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
760
# should be ignored while generating the index headers.
764
#---------------------------------------------------------------------------
765
# configuration options related to the HTML output
766
#---------------------------------------------------------------------------
768
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
769
# generate HTML output.
773
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
774
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
775
# put in front of it. If left blank `html' will be used as the default path.
779
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
780
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
781
# doxygen will generate files with .html extension.
783
HTML_FILE_EXTENSION = .html
785
# The HTML_HEADER tag can be used to specify a personal HTML header for
786
# each generated HTML page. If it is left blank doxygen will generate a
791
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
792
# each generated HTML page. If it is left blank doxygen will generate a
797
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
798
# style sheet that is used by each HTML page. It can be used to
799
# fine-tune the look of the HTML output. If the tag is left blank doxygen
800
# will generate a default style sheet. Note that doxygen will try to copy
801
# the style sheet file to the HTML output directory, so don't put your own
802
# stylesheet in the HTML output directory as well, or it will be erased!
806
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
807
# files or namespaces will be aligned in HTML using tables. If set to
808
# NO a bullet list will be used.
810
HTML_ALIGN_MEMBERS = YES
812
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
813
# documentation will contain sections that can be hidden and shown after the
814
# page has loaded. For this to work a browser that supports
815
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
816
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
818
HTML_DYNAMIC_SECTIONS = NO
820
# If the GENERATE_DOCSET tag is set to YES, additional index files
821
# will be generated that can be used as input for Apple's Xcode 3
822
# integrated development environment, introduced with OSX 10.5 (Leopard).
823
# To create a documentation set, doxygen will generate a Makefile in the
824
# HTML output directory. Running make will produce the docset in that
825
# directory and running "make install" will install the docset in
826
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
828
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
832
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
833
# feed. A documentation feed provides an umbrella under which multiple
834
# documentation sets from a single provider (such as a company or product suite)
837
DOCSET_FEEDNAME = "Doxygen generated docs"
839
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
840
# should uniquely identify the documentation set bundle. This should be a
841
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
842
# will append .docset to the name.
844
DOCSET_BUNDLE_ID = org.doxygen.Project
846
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
847
# will be generated that can be used as input for tools like the
848
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
849
# of the generated HTML documentation.
851
GENERATE_HTMLHELP = NO
853
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
854
# be used to specify the file name of the resulting .chm file. You
855
# can add a path in front of the file if the result should not be
856
# written to the html output directory.
860
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
861
# be used to specify the location (absolute path including file name) of
862
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
863
# the HTML help compiler on the generated index.hhp.
867
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
868
# controls if a separate .chi index file is generated (YES) or that
869
# it should be included in the master .chm file (NO).
873
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
874
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
879
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
880
# controls whether a binary table of contents is generated (YES) or a
881
# normal table of contents (NO) in the .chm file.
885
# The TOC_EXPAND flag can be set to YES to add extra items for group members
886
# to the contents of the HTML help documentation and to the tree view.
890
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
891
# are set, an additional index file will be generated that can be used as input for
892
# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
897
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
898
# be used to specify the file name of the resulting .qch file.
899
# The path specified is relative to the HTML output folder.
903
# The QHP_NAMESPACE tag specifies the namespace to use when generating
904
# Qt Help Project output. For more information please see
905
# http://doc.trolltech.com/qthelpproject.html#namespace
907
QHP_NAMESPACE = "FreeCAD"
909
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
910
# Qt Help Project output. For more information please see
911
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
913
QHP_VIRTUAL_FOLDER = doc
915
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
916
# For more information please see
917
# http://doc.trolltech.com/qthelpproject.html#custom-filters
919
QHP_CUST_FILTER_NAME =
921
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
922
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
924
QHP_CUST_FILTER_ATTRS =
926
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
927
# filter section matches.
928
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
930
QHP_SECT_FILTER_ATTRS =
932
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
933
# be used to specify the location of Qt's qhelpgenerator.
934
# If non-empty doxygen will try to run qhelpgenerator on the generated
939
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
940
# top of each HTML page. The value NO (the default) enables the index and
941
# the value YES disables it.
945
# This tag can be used to set the number of enum values (range [1..20])
946
# that doxygen will group on one line in the generated HTML documentation.
948
ENUM_VALUES_PER_LINE = 4
950
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
951
# structure should be generated to display hierarchical information.
952
# If the tag value is set to YES, a side panel will be generated
953
# containing a tree-like index structure (just like the one that
954
# is generated for HTML Help). For this to work a browser that supports
955
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
956
# Windows users are probably better off using the HTML help feature.
958
GENERATE_TREEVIEW = NO
960
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
961
# and Class Hierarchy pages using a tree view instead of an ordered list.
965
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
966
# used to set the initial width (in pixels) of the frame in which the tree
971
# Use this tag to change the font size of Latex formulas included
972
# as images in the HTML documentation. The default is 10. Note that
973
# when you change the font size after a successful doxygen run you need
974
# to manually remove any form_*.png images from the HTML output directory
975
# to force them to be regenerated.
979
# When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
980
# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
981
# there is already a search function so this one should typically
986
#---------------------------------------------------------------------------
987
# configuration options related to the LaTeX output
988
#---------------------------------------------------------------------------
990
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
991
# generate Latex output.
995
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
996
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
997
# put in front of it. If left blank `latex' will be used as the default path.
1001
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1002
# invoked. If left blank `latex' will be used as the default command name.
1004
LATEX_CMD_NAME = latex
1006
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1007
# generate index for LaTeX. If left blank `makeindex' will be used as the
1008
# default command name.
1010
MAKEINDEX_CMD_NAME = makeindex
1012
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1013
# LaTeX documents. This may be useful for small projects and may help to
1014
# save some trees in general.
1018
# The PAPER_TYPE tag can be used to set the paper type that is used
1019
# by the printer. Possible values are: a4, a4wide, letter, legal and
1020
# executive. If left blank a4wide will be used.
1024
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1025
# packages that should be included in the LaTeX output.
1029
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1030
# the generated latex document. The header should contain everything until
1031
# the first chapter. If it is left blank doxygen will generate a
1032
# standard header. Notice: only use this tag if you know what you are doing!
1036
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1037
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1038
# contain links (just like the HTML output) instead of page references
1039
# This makes the output suitable for online browsing using a pdf viewer.
1043
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1044
# plain latex in the generated Makefile. Set this option to YES to get a
1045
# higher quality PDF documentation.
1049
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1050
# command to the generated LaTeX files. This will instruct LaTeX to keep
1051
# running if errors occur, instead of asking the user for help.
1052
# This option is also used when generating formulas in HTML.
1056
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1057
# include the index chapters (such as File Index, Compound Index, etc.)
1060
LATEX_HIDE_INDICES = NO
1062
# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
1064
LATEX_SOURCE_CODE = NO
1066
#---------------------------------------------------------------------------
1067
# configuration options related to the RTF output
1068
#---------------------------------------------------------------------------
1070
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1071
# The RTF output is optimized for Word 97 and may not look very pretty with
1072
# other RTF readers or editors.
1076
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1077
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1078
# put in front of it. If left blank `rtf' will be used as the default path.
1082
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1083
# RTF documents. This may be useful for small projects and may help to
1084
# save some trees in general.
1088
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1089
# will contain hyperlink fields. The RTF file will
1090
# contain links (just like the HTML output) instead of page references.
1091
# This makes the output suitable for online browsing using WORD or other
1092
# programs which support those fields.
1093
# Note: wordpad (write) and others do not support links.
1097
# Load stylesheet definitions from file. Syntax is similar to doxygen's
1098
# config file, i.e. a series of assignments. You only have to provide
1099
# replacements, missing definitions are set to their default value.
1101
RTF_STYLESHEET_FILE =
1103
# Set optional variables used in the generation of an rtf document.
1104
# Syntax is similar to doxygen's config file.
1106
RTF_EXTENSIONS_FILE =
1108
#---------------------------------------------------------------------------
1109
# configuration options related to the man page output
1110
#---------------------------------------------------------------------------
1112
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1117
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1118
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1119
# put in front of it. If left blank `man' will be used as the default path.
1123
# The MAN_EXTENSION tag determines the extension that is added to
1124
# the generated man pages (default is the subroutine's section .3)
1128
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1129
# then it will generate one additional man file for each entity
1130
# documented in the real man page(s). These additional files
1131
# only source the real man page, but without them the man command
1132
# would be unable to find the correct page. The default is NO.
1136
#---------------------------------------------------------------------------
1137
# configuration options related to the XML output
1138
#---------------------------------------------------------------------------
1140
# If the GENERATE_XML tag is set to YES Doxygen will
1141
# generate an XML file that captures the structure of
1142
# the code including all documentation.
1146
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1147
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1148
# put in front of it. If left blank `xml' will be used as the default path.
1152
# The XML_SCHEMA tag can be used to specify an XML schema,
1153
# which can be used by a validating XML parser to check the
1154
# syntax of the XML files.
1158
# The XML_DTD tag can be used to specify an XML DTD,
1159
# which can be used by a validating XML parser to check the
1160
# syntax of the XML files.
1164
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1165
# dump the program listings (including syntax highlighting
1166
# and cross-referencing information) to the XML output. Note that
1167
# enabling this will significantly increase the size of the XML output.
1169
XML_PROGRAMLISTING = YES
1171
#---------------------------------------------------------------------------
1172
# configuration options for the AutoGen Definitions output
1173
#---------------------------------------------------------------------------
1175
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1176
# generate an AutoGen Definitions (see autogen.sf.net) file
1177
# that captures the structure of the code including all
1178
# documentation. Note that this feature is still experimental
1179
# and incomplete at the moment.
1181
GENERATE_AUTOGEN_DEF = NO
1183
#---------------------------------------------------------------------------
1184
# configuration options related to the Perl module output
1185
#---------------------------------------------------------------------------
1187
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1188
# generate a Perl module file that captures the structure of
1189
# the code including all documentation. Note that this
1190
# feature is still experimental and incomplete at the
1193
GENERATE_PERLMOD = NO
1195
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1196
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1197
# to generate PDF and DVI output from the Perl module output.
1201
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1202
# nicely formatted so it can be parsed by a human reader.
1204
# if you want to understand what is going on.
1205
# On the other hand, if this
1206
# tag is set to NO the size of the Perl module output will be much smaller
1207
# and Perl will parse it just the same.
1211
# The names of the make variables in the generated doxyrules.make file
1212
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1213
# This is useful so different doxyrules.make files included by the same
1214
# Makefile don't overwrite each other's variables.
1216
PERLMOD_MAKEVAR_PREFIX =
1218
#---------------------------------------------------------------------------
1219
# Configuration options related to the preprocessor
1220
#---------------------------------------------------------------------------
1222
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1223
# evaluate all C-preprocessor directives found in the sources and include
1226
ENABLE_PREPROCESSING = YES
1228
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1229
# names in the source code. If set to NO (the default) only conditional
1230
# compilation will be performed. Macro expansion can be done in a controlled
1231
# way by setting EXPAND_ONLY_PREDEF to YES.
1233
MACRO_EXPANSION = YES
1235
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1236
# then the macro expansion is limited to the macros specified with the
1237
# PREDEFINED and EXPAND_AS_DEFINED tags.
1239
EXPAND_ONLY_PREDEF = NO
1241
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1242
# in the INCLUDE_PATH (see below) will be search if a #include is found.
1244
SEARCH_INCLUDES = YES
1246
# The INCLUDE_PATH tag can be used to specify one or more directories that
1247
# contain include files that are not input files but should be processed by
1252
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1253
# patterns (like *.h and *.hpp) to filter out the header-files in the
1254
# directories. If left blank, the patterns specified with FILE_PATTERNS will
1257
INCLUDE_FILE_PATTERNS =
1259
# The PREDEFINED tag can be used to specify one or more macro names that
1260
# are defined before the preprocessor is started (similar to the -D option of
1261
# gcc). The argument of the tag is a list of macros of the form: name
1262
# or name=definition (no spaces). If the definition and the = are
1263
# omitted =1 is assumed. To prevent a macro definition from being
1264
# undefined via #undef or recursively expanded use the := operator
1265
# instead of the = operator.
1269
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1270
# this tag can be used to specify a list of macro names that should be expanded.
1271
# The macro definition that is found in the sources will be used.
1272
# Use the PREDEFINED tag if you want to use a different macro definition.
1276
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1277
# doxygen's preprocessor will remove all function-like macros that are alone
1278
# on a line, have an all uppercase name, and do not end with a semicolon. Such
1279
# function macros are typically used for boiler-plate code, and will confuse
1280
# the parser if not removed.
1282
SKIP_FUNCTION_MACROS = YES
1284
#---------------------------------------------------------------------------
1285
# Configuration::additions related to external references
1286
#---------------------------------------------------------------------------
1288
# The TAGFILES option can be used to specify one or more tagfiles.
1289
# Optionally an initial location of the external documentation
1290
# can be added for each tagfile. The format of a tag file without
1291
# this location is as follows:
1293
# TAGFILES = file1 file2 ...
1294
# Adding location for the tag files is done as follows:
1296
# TAGFILES = file1=loc1 "file2 = loc2" ...
1297
# where "loc1" and "loc2" can be relative or absolute paths or
1298
# URLs. If a location is present for each tag, the installdox tool
1299
# does not have to be run to correct the links.
1300
# Note that each tag file must have a unique name
1301
# (where the name does NOT include the path)
1302
# If a tag file is not located in the directory in which doxygen
1303
# is run, you must also specify the path to the tagfile here.
1307
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1308
# a tag file that is based on the input files it reads.
1312
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1313
# in the class index. If set to NO only the inherited external classes
1318
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1319
# in the modules index. If set to NO, only the current project's groups will
1322
EXTERNAL_GROUPS = YES
1324
# The PERL_PATH should be the absolute path and name of the perl script
1325
# interpreter (i.e. the result of `which perl').
1329
#---------------------------------------------------------------------------
1330
# Configuration options related to the dot tool
1331
#---------------------------------------------------------------------------
1333
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1334
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1335
# or super classes. Setting the tag to NO turns the diagrams off. Note that
1336
# this option is superseded by the HAVE_DOT option below. This is only a
1337
# fallback. It is recommended to install and use dot, since it yields more
1342
# You can define message sequence charts within doxygen comments using the \msc
1343
# command. Doxygen will then run the mscgen tool (see
1344
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1345
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1346
# the mscgen tool resides. If left empty the tool is assumed to be found in the
1347
# default search path.
1351
# If set to YES, the inheritance and collaboration graphs will hide
1352
# inheritance and usage relations if the target is undocumented
1355
HIDE_UNDOC_RELATIONS = YES
1357
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1358
# available from the path. This tool is part of Graphviz, a graph visualization
1359
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1360
# have no effect if this option is set to NO (the default)
1364
# By default doxygen will write a font called FreeSans.ttf to the output
1365
# directory and reference it in all dot files that doxygen generates. This
1366
# font does not include all possible unicode characters however, so when you need
1367
# these (or just want a differently looking font) you can specify the font name
1368
# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1369
# which can be done by putting it in a standard location or by setting the
1370
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1371
# containing the font.
1373
DOT_FONTNAME = FreeSans
1375
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1376
# The default size is 10pt.
1380
# By default doxygen will tell dot to use the output directory to look for the
1381
# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1382
# different font using DOT_FONTNAME you can set the path where dot
1383
# can find it using this tag.
1387
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1388
# will generate a graph for each documented class showing the direct and
1389
# indirect inheritance relations. Setting this tag to YES will force the
1390
# the CLASS_DIAGRAMS tag to NO.
1394
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1395
# will generate a graph for each documented class showing the direct and
1396
# indirect implementation dependencies (inheritance, containment, and
1397
# class references variables) of the class with other documented classes.
1399
COLLABORATION_GRAPH = YES
1401
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1402
# will generate a graph for groups, showing the direct groups dependencies
1406
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1407
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1412
# If set to YES, the inheritance and collaboration graphs will show the
1413
# relations between templates and their instances.
1415
TEMPLATE_RELATIONS = YES
1417
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1418
# tags are set to YES then doxygen will generate a graph for each documented
1419
# file showing the direct and indirect include dependencies of the file with
1420
# other documented files.
1424
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1425
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1426
# documented header file showing the documented files that directly or
1427
# indirectly include this file.
1429
INCLUDED_BY_GRAPH = YES
1431
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1432
# doxygen will generate a call dependency graph for every global function
1433
# or class method. Note that enabling this option will significantly increase
1434
# the time of a run. So in most cases it will be better to enable call graphs
1435
# for selected functions only using the \callgraph command.
1439
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1440
# doxygen will generate a caller dependency graph for every global function
1441
# or class method. Note that enabling this option will significantly increase
1442
# the time of a run. So in most cases it will be better to enable caller
1443
# graphs for selected functions only using the \callergraph command.
1447
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1448
# will graphical hierarchy of all classes instead of a textual one.
1450
GRAPHICAL_HIERARCHY = YES
1452
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1453
# then doxygen will show the dependencies a directory has on other directories
1454
# in a graphical way. The dependency relations are determined by the #include
1455
# relations between the files in the directories.
1457
DIRECTORY_GRAPH = YES
1459
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1460
# generated by dot. Possible values are png, jpg, or gif
1461
# If left blank png will be used.
1463
DOT_IMAGE_FORMAT = png
1465
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1466
# found. If left blank, it is assumed the dot tool can be found in the path.
1470
# The DOTFILE_DIRS tag can be used to specify one or more directories that
1471
# contain dot files that are included in the documentation (see the
1476
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1477
# nodes that will be shown in the graph. If the number of nodes in a graph
1478
# becomes larger than this value, doxygen will truncate the graph, which is
1479
# visualized by representing a node as a red box. Note that doxygen if the
1480
# number of direct children of the root node in a graph is already larger than
1481
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1482
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1484
DOT_GRAPH_MAX_NODES = 50
1486
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1487
# graphs generated by dot. A depth value of 3 means that only nodes reachable
1488
# from the root by following a path via at most 3 edges will be shown. Nodes
1489
# that lay further from the root node will be omitted. Note that setting this
1490
# option to 1 or 2 may greatly reduce the computation time needed for large
1491
# code bases. Also note that the size of a graph can be further restricted by
1492
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1494
MAX_DOT_GRAPH_DEPTH = 0
1496
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1497
# background. This is disabled by default, because dot on Windows does not
1498
# seem to support this out of the box. Warning: Depending on the platform used,
1499
# enabling this option may lead to badly anti-aliased labels on the edges of
1500
# a graph (i.e. they become hard to read).
1504
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1505
# files in one run (i.e. multiple -o and -T options on the command line). This
1506
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1507
# support this, this feature is disabled by default.
1509
DOT_MULTI_TARGETS = NO
1511
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1512
# generate a legend page explaining the meaning of the various boxes and
1513
# arrows in the dot generated graphs.
1515
GENERATE_LEGEND = YES
1517
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1518
# remove the intermediate dot files that are used to generate
1519
# the various graphs.