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.
41
OUTPUT_DIRECTORY = doc
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 automatically
85
# 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"
89
ABBREVIATE_BRIEF = "The $name class" \
101
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
102
# Doxygen will generate a detailed section even if there is only a brief
105
ALWAYS_DETAILED_SEC = NO
107
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
108
# inherited members of a class in the documentation of that class as if those
109
# members were ordinary class members. Constructors, destructors and assignment
110
# operators of the base classes will not be shown.
112
INLINE_INHERITED_MEMB = NO
114
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
115
# path before files name in the file list and in the header files. If set
116
# to NO the shortest path that makes the file name unique will be used.
118
FULL_PATH_NAMES = YES
120
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
121
# can be used to strip a user-defined part of the path. Stripping is
122
# only done if one of the specified strings matches the left-hand part of
123
# the path. The tag can be used to show relative paths in the file list.
124
# If left blank the directory from which doxygen is run is used as the
129
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
130
# the path mentioned in the documentation of a class, which tells
131
# the reader which header file to include in order to use a class.
132
# If left blank only the name of the header file containing the class
133
# definition is used. Otherwise one should specify the include paths that
134
# are normally passed to the compiler using the -I flag.
136
STRIP_FROM_INC_PATH =
138
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
139
# (but less readable) file names. This can be useful is your file systems
140
# doesn't support long names like on DOS, Mac, or CD-ROM.
144
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
145
# will interpret the first line (until the first dot) of a JavaDoc-style
146
# comment as the brief description. If set to NO, the JavaDoc
147
# comments will behave just like regular Qt-style comments
148
# (thus requiring an explicit @brief command for a brief description.)
150
JAVADOC_AUTOBRIEF = YES
152
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
153
# interpret the first line (until the first dot) of a Qt-style
154
# comment as the brief description. If set to NO, the comments
155
# will behave just like regular Qt-style comments (thus requiring
156
# an explicit \brief command for a brief description.)
160
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
161
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
162
# comments) as a brief description. This used to be the default behaviour.
163
# The new default is to treat a multi-line C++ comment block as a detailed
164
# description. Set this tag to YES if you prefer the old behaviour instead.
166
MULTILINE_CPP_IS_BRIEF = NO
168
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
169
# member inherits the documentation from any documented member that it
174
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
175
# a new page for each member. If set to NO, the documentation of a member will
176
# be part of the file/class/namespace that contains it.
178
SEPARATE_MEMBER_PAGES = NO
180
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
181
# Doxygen uses this value to replace tabs by spaces in code fragments.
185
# This tag can be used to specify a number of aliases that acts
186
# as commands in the documentation. An alias has the form "name=value".
187
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
188
# put the command \sideeffect (or @sideeffect) in the documentation, which
189
# will result in a user-defined paragraph with heading "Side Effects:".
190
# You can put \n's in the value part of an alias to insert newlines.
194
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
195
# sources only. Doxygen will then generate output that is more tailored for C.
196
# For instance, some of the names that are used will be different. The list
197
# of all members will be omitted, etc.
199
OPTIMIZE_OUTPUT_FOR_C = YES
201
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
202
# sources only. Doxygen will then generate output that is more tailored for
203
# Java. For instance, namespaces will be presented as packages, qualified
204
# scopes will look different, etc.
206
OPTIMIZE_OUTPUT_JAVA = NO
208
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
209
# sources only. Doxygen will then generate output that is more tailored for
212
OPTIMIZE_FOR_FORTRAN = NO
214
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
215
# sources. Doxygen will then generate output that is tailored for
218
OPTIMIZE_OUTPUT_VHDL = NO
220
# Doxygen selects the parser to use depending on the extension of the files it parses.
221
# With this tag you can assign which parser to use for a given extension.
222
# Doxygen has a built-in mapping, but you can override or extend it using this tag.
223
# The format is ext=language, where ext is a file extension, and language is one of
224
# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
225
# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
226
# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
227
# 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.
231
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
232
# to include (a tag file for) the STL sources as input, then you should
233
# set this tag to YES in order to let doxygen match functions declarations and
234
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
235
# func(std::string) {}). This also make the inheritance and collaboration
236
# diagrams that involve STL classes more complete and accurate.
238
BUILTIN_STL_SUPPORT = NO
240
# If you use Microsoft's C++/CLI language, you should set this option to YES to
241
# enable parsing support.
245
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
246
# Doxygen will parse them like normal C++ but will assume all classes use public
247
# instead of private inheritance when no explicit protection keyword is present.
251
# For Microsoft's IDL there are propget and propput attributes to indicate getter
252
# and setter methods for a property. Setting this option to YES (the default)
253
# will make doxygen to replace the get and set methods by a property in the
254
# documentation. This will only work if the methods are indeed getting or
255
# setting a simple type. If this is not the case, or you want to show the
256
# methods anyway, you should set this option to NO.
258
IDL_PROPERTY_SUPPORT = YES
260
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
261
# tag is set to YES, then doxygen will reuse the documentation of the first
262
# member in the group (if any) for the other members of the group. By default
263
# all members of a group must be documented explicitly.
265
DISTRIBUTE_GROUP_DOC = NO
267
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
268
# the same type (for instance a group of public functions) to be put as a
269
# subgroup of that type (e.g. under the Public Functions section). Set it to
270
# NO to prevent subgrouping. Alternatively, this can be done per class using
271
# the \nosubgrouping command.
275
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
276
# is documented as struct, union, or enum with the name of the typedef. So
277
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
278
# with name TypeT. When disabled the typedef will appear as a member of a file,
279
# namespace, or class. And the struct will be named TypeS. This can typically
280
# be useful for C code in case the coding convention dictates that all compound
281
# types are typedef'ed and only the typedef is referenced, never the tag name.
283
TYPEDEF_HIDES_STRUCT = NO
285
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
286
# determine which symbols to keep in memory and which to flush to disk.
287
# When the cache is full, less often used symbols will be written to disk.
288
# For small to medium size projects (<1000 input files) the default value is
289
# probably good enough. For larger projects a too small cache size can cause
290
# doxygen to be busy swapping symbols to and from disk most of the time
291
# causing a significant performance penality.
292
# If the system has enough physical memory increasing the cache will improve the
293
# performance by keeping more symbols in memory. Note that the value works on
294
# a logarithmic scale so increasing the size by one will rougly double the
295
# memory usage. The cache size is given by this formula:
296
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
297
# corresponding to a cache size of 2^16 = 65536 symbols
299
SYMBOL_CACHE_SIZE = 0
301
#---------------------------------------------------------------------------
302
# Build related configuration options
303
#---------------------------------------------------------------------------
305
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
306
# documentation are documented, even if no documentation was available.
307
# Private class members and static file members will be hidden unless
308
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
312
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
313
# will be included in the documentation.
317
# If the EXTRACT_STATIC tag is set to YES all static members of a file
318
# will be included in the documentation.
322
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
323
# defined locally in source files will be included in the documentation.
324
# If set to NO only classes defined in header files are included.
326
EXTRACT_LOCAL_CLASSES = NO
328
# This flag is only useful for Objective-C code. When set to YES local
329
# methods, which are defined in the implementation section but not in
330
# the interface are included in the documentation.
331
# If set to NO (the default) only methods in the interface are included.
333
EXTRACT_LOCAL_METHODS = NO
335
# If this flag is set to YES, the members of anonymous namespaces will be
336
# extracted and appear in the documentation as a namespace called
337
# 'anonymous_namespace{file}', where file will be replaced with the base
338
# name of the file that contains the anonymous namespace. By default
339
# anonymous namespace are hidden.
341
EXTRACT_ANON_NSPACES = NO
343
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
344
# undocumented members of documented classes, files or namespaces.
345
# If set to NO (the default) these members will be included in the
346
# various overviews, but no documentation section is generated.
347
# This option has no effect if EXTRACT_ALL is enabled.
349
HIDE_UNDOC_MEMBERS = YES
351
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
352
# undocumented classes that are normally visible in the class hierarchy.
353
# If set to NO (the default) these classes will be included in the various
354
# overviews. This option has no effect if EXTRACT_ALL is enabled.
356
HIDE_UNDOC_CLASSES = YES
358
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
359
# friend (class|struct|union) declarations.
360
# If set to NO (the default) these declarations will be included in the
363
HIDE_FRIEND_COMPOUNDS = NO
365
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
366
# documentation blocks found inside the body of a function.
367
# If set to NO (the default) these blocks will be appended to the
368
# function's detailed documentation block.
370
HIDE_IN_BODY_DOCS = NO
372
# The INTERNAL_DOCS tag determines if documentation
373
# that is typed after a \internal command is included. If the tag is set
374
# to NO (the default) then the documentation will be excluded.
375
# Set it to YES to include the internal documentation.
379
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
380
# file names in lower-case letters. If set to YES upper-case letters are also
381
# allowed. This is useful if you have classes or files whose names only differ
382
# in case and if your file system supports case sensitive file names. Windows
383
# and Mac users are advised to set this option to NO.
385
CASE_SENSE_NAMES = YES
387
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
388
# will show members with their full class and namespace scopes in the
389
# documentation. If set to YES the scope will be hidden.
391
HIDE_SCOPE_NAMES = NO
393
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
394
# will put a list of the files that are included by a file in the documentation
397
SHOW_INCLUDE_FILES = YES
399
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
400
# is inserted in the documentation for inline members.
404
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
405
# will sort the (detailed) documentation of file and class members
406
# alphabetically by member name. If set to NO the members will appear in
409
SORT_MEMBER_DOCS = YES
411
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
412
# brief documentation of file, namespace and class members alphabetically
413
# by member name. If set to NO (the default) the members will appear in
418
# 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.
420
SORT_MEMBERS_CTORS_1ST = NO
422
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
423
# hierarchy of group names into alphabetical order. If set to NO (the default)
424
# the group names will appear in their defined order.
426
SORT_GROUP_NAMES = NO
428
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
429
# sorted by fully-qualified names, including namespaces. If set to
430
# NO (the default), the class list will be sorted only by class name,
431
# not including the namespace part.
432
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
433
# Note: This option applies only to the class list, not to the
436
SORT_BY_SCOPE_NAME = NO
438
# The GENERATE_TODOLIST tag can be used to enable (YES) or
439
# disable (NO) the todo list. This list is created by putting \todo
440
# commands in the documentation.
442
GENERATE_TODOLIST = YES
444
# The GENERATE_TESTLIST tag can be used to enable (YES) or
445
# disable (NO) the test list. This list is created by putting \test
446
# commands in the documentation.
448
GENERATE_TESTLIST = YES
450
# The GENERATE_BUGLIST tag can be used to enable (YES) or
451
# disable (NO) the bug list. This list is created by putting \bug
452
# commands in the documentation.
454
GENERATE_BUGLIST = YES
456
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
457
# disable (NO) the deprecated list. This list is created by putting
458
# \deprecated commands in the documentation.
460
GENERATE_DEPRECATEDLIST= YES
462
# The ENABLED_SECTIONS tag can be used to enable conditional
463
# documentation sections, marked by \if sectionname ... \endif.
467
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
468
# the initial value of a variable or define consists of for it to appear in
469
# the documentation. If the initializer consists of more lines than specified
470
# here it will be hidden. Use a value of 0 to hide initializers completely.
471
# The appearance of the initializer of individual variables and defines in the
472
# documentation can be controlled using \showinitializer or \hideinitializer
473
# command in the documentation regardless of this setting.
475
MAX_INITIALIZER_LINES = 30
477
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
478
# at the bottom of the documentation of classes and structs. If set to YES the
479
# list will mention the files that were used to generate the documentation.
481
SHOW_USED_FILES = YES
483
# If the sources in your project are distributed over multiple directories
484
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
485
# in the documentation. The default is NO.
487
SHOW_DIRECTORIES = NO
489
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
490
# This will remove the Files entry from the Quick Index and from the
491
# Folder Tree View (if specified). The default is YES.
495
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
497
# This will remove the Namespaces entry from the Quick Index
498
# and from the Folder Tree View (if specified). The default is YES.
500
SHOW_NAMESPACES = YES
502
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
503
# doxygen should invoke to get the current version for each file (typically from
504
# the version control system). Doxygen will invoke the program by executing (via
505
# popen()) the command <command> <input-file>, where <command> is the value of
506
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
507
# provided by doxygen. Whatever the program writes to standard output
508
# is used as the file version. See the manual for examples.
510
FILE_VERSION_FILTER =
512
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
513
# doxygen. The layout file controls the global structure of the generated output files
514
# in an output format independent way. The create the layout file that represents
515
# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
516
# file name after the option, if omitted DoxygenLayout.xml will be used as the name
517
# of the layout file.
521
#---------------------------------------------------------------------------
522
# configuration options related to warning and progress messages
523
#---------------------------------------------------------------------------
525
# The QUIET tag can be used to turn on/off the messages that are generated
526
# by doxygen. Possible values are YES and NO. If left blank NO is used.
530
# The WARNINGS tag can be used to turn on/off the warning messages that are
531
# generated by doxygen. Possible values are YES and NO. If left blank
536
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
537
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
538
# automatically be disabled.
540
WARN_IF_UNDOCUMENTED = YES
542
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
543
# potential errors in the documentation, such as not documenting some
544
# parameters in a documented function, or documenting parameters that
545
# don't exist or using markup commands wrongly.
547
WARN_IF_DOC_ERROR = YES
549
# This WARN_NO_PARAMDOC option can be abled to get warnings for
550
# functions that are documented, but have no documentation for their parameters
551
# or return value. If set to NO (the default) doxygen will only warn about
552
# wrong or incomplete parameter documentation, but not about the absence of
555
WARN_NO_PARAMDOC = NO
557
# The WARN_FORMAT tag determines the format of the warning messages that
558
# doxygen can produce. The string should contain the $file, $line, and $text
559
# tags, which will be replaced by the file and line number from which the
560
# warning originated and the warning text. Optionally the format may contain
561
# $version, which will be replaced by the version of the file (if it could
562
# be obtained via FILE_VERSION_FILTER)
564
WARN_FORMAT = "$file:$line: $text"
566
# The WARN_LOGFILE tag can be used to specify a file to which warning
567
# and error messages should be written. If left blank the output is written
572
#---------------------------------------------------------------------------
573
# configuration options related to the input files
574
#---------------------------------------------------------------------------
576
# The INPUT tag can be used to specify the files and/or directories that contain
577
# documented source files. You may enter file names like "myfile.cpp" or
578
# directories like "/usr/src/myproject". Separate the files or directories
583
# This tag can be used to specify the character encoding of the source files
584
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
585
# also the default input encoding. Doxygen uses libiconv (or the iconv built
586
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
587
# the list of possible encodings.
589
INPUT_ENCODING = UTF-8
591
# If the value of the INPUT tag contains directories, you can use the
592
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
593
# and *.h) to filter out the source-files in the directories. If left
594
# blank the following patterns are tested:
595
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
596
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
598
FILE_PATTERNS = *.cpp \
606
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
607
# should be searched for input files as well. Possible values are YES and NO.
608
# If left blank NO is used.
612
# The EXCLUDE tag can be used to specify files and/or directories that should
613
# excluded from the INPUT source files. This way you can easily exclude a
614
# subdirectory from a directory tree whose root is specified with the INPUT tag.
618
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
619
# directories that are symbolic links (a Unix filesystem feature) are excluded
622
EXCLUDE_SYMLINKS = NO
624
# If the value of the INPUT tag contains directories, you can use the
625
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
626
# certain files from those directories. Note that the wildcards are matched
627
# against the file with absolute path, so to exclude all test directories
628
# for example use the pattern */test/*
630
EXCLUDE_PATTERNS = */.git/* \
635
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
636
# (namespaces, classes, functions, etc.) that should be excluded from the
637
# output. The symbol name can be a fully qualified name, a word, or if the
638
# wildcard * is used, a substring. Examples: ANamespace, AClass,
639
# AClass::ANamespace, ANamespace::*Test
643
# The EXAMPLE_PATH tag can be used to specify one or more files or
644
# directories that contain example code fragments that are included (see
645
# the \include command).
649
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
650
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
651
# and *.h) to filter out the source-files in the directories. If left
652
# blank all files are included.
656
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
657
# searched for input files to be used with the \include or \dontinclude
658
# commands irrespective of the value of the RECURSIVE tag.
659
# Possible values are YES and NO. If left blank NO is used.
661
EXAMPLE_RECURSIVE = NO
663
# The IMAGE_PATH tag can be used to specify one or more files or
664
# directories that contain image that are included in the documentation (see
665
# the \image command).
669
# The INPUT_FILTER tag can be used to specify a program that doxygen should
670
# invoke to filter for each input file. Doxygen will invoke the filter program
671
# by executing (via popen()) the command <filter> <input-file>, where <filter>
672
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
673
# input file. Doxygen will then use the output that the filter program writes
674
# to standard output.
675
# If FILTER_PATTERNS is specified, this tag will be
680
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
682
# Doxygen will compare the file name with each pattern and apply the
683
# filter if there is a match.
684
# The filters are a list of the form:
685
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
686
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
687
# is applied to all files.
691
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
692
# INPUT_FILTER) will be used to filter the input files when producing source
693
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
695
FILTER_SOURCE_FILES = NO
697
#---------------------------------------------------------------------------
698
# configuration options related to source browsing
699
#---------------------------------------------------------------------------
701
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
702
# be generated. Documented entities will be cross-referenced with these sources.
703
# Note: To get rid of all source code in the generated output, make sure also
704
# VERBATIM_HEADERS is set to NO.
708
# Setting the INLINE_SOURCES tag to YES will include the body
709
# of functions and classes directly in the documentation.
713
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
714
# doxygen to hide any special comment blocks from generated source code
715
# fragments. Normal C and C++ comments will always remain visible.
717
STRIP_CODE_COMMENTS = YES
719
# If the REFERENCED_BY_RELATION tag is set to YES
720
# then for each documented function all documented
721
# functions referencing it will be listed.
723
REFERENCED_BY_RELATION = NO
725
# If the REFERENCES_RELATION tag is set to YES
726
# then for each documented function all documented entities
727
# called/used by that function will be listed.
729
REFERENCES_RELATION = NO
731
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
732
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
733
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
734
# link to the source code.
735
# Otherwise they will link to the documentation.
737
REFERENCES_LINK_SOURCE = YES
739
# If the USE_HTAGS tag is set to YES then the references to source code
740
# will point to the HTML generated by the htags(1) tool instead of doxygen
741
# built-in source browser. The htags tool is part of GNU's global source
742
# tagging system (see http://www.gnu.org/software/global/global.html). You
743
# will need version 4.8.6 or higher.
747
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
748
# will generate a verbatim copy of the header file for each class for
749
# which an include is specified. Set to NO to disable this.
751
VERBATIM_HEADERS = YES
753
#---------------------------------------------------------------------------
754
# configuration options related to the alphabetical class index
755
#---------------------------------------------------------------------------
757
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
758
# of all compounds will be generated. Enable this if the project
759
# contains a lot of classes, structs, unions or interfaces.
761
ALPHABETICAL_INDEX = NO
763
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
764
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
765
# in which this list will be split (can be a number in the range [1..20])
767
COLS_IN_ALPHA_INDEX = 5
769
# In case all classes in a project start with a common prefix, all
770
# classes will be put under the same header in the alphabetical index.
771
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
772
# should be ignored while generating the index headers.
776
#---------------------------------------------------------------------------
777
# configuration options related to the HTML output
778
#---------------------------------------------------------------------------
780
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
781
# generate HTML output.
785
# If the HTML_FOOTER_DESCRIPTION tag is set to YES, Doxygen will
786
# add generated date, project name and doxygen version to HTML footer.
788
HTML_FOOTER_DESCRIPTION= NO
790
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
791
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
792
# put in front of it. If left blank `html' will be used as the default path.
796
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
797
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
798
# doxygen will generate files with .html extension.
800
HTML_FILE_EXTENSION = .html
802
# The HTML_HEADER tag can be used to specify a personal HTML header for
803
# each generated HTML page. If it is left blank doxygen will generate a
808
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
809
# each generated HTML page. If it is left blank doxygen will generate a
814
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
815
# style sheet that is used by each HTML page. It can be used to
816
# fine-tune the look of the HTML output. If the tag is left blank doxygen
817
# will generate a default style sheet. Note that doxygen will try to copy
818
# the style sheet file to the HTML output directory, so don't put your own
819
# stylesheet in the HTML output directory as well, or it will be erased!
823
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
824
# files or namespaces will be aligned in HTML using tables. If set to
825
# NO a bullet list will be used.
827
HTML_ALIGN_MEMBERS = YES
829
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
830
# documentation will contain sections that can be hidden and shown after the
831
# page has loaded. For this to work a browser that supports
832
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
833
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
835
HTML_DYNAMIC_SECTIONS = NO
837
# If the GENERATE_DOCSET tag is set to YES, additional index files
838
# will be generated that can be used as input for Apple's Xcode 3
839
# integrated development environment, introduced with OSX 10.5 (Leopard).
840
# To create a documentation set, doxygen will generate a Makefile in the
841
# HTML output directory. Running make will produce the docset in that
842
# directory and running "make install" will install the docset in
843
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
845
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
849
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
850
# feed. A documentation feed provides an umbrella under which multiple
851
# documentation sets from a single provider (such as a company or product suite)
854
DOCSET_FEEDNAME = "Doxygen generated docs"
856
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
857
# should uniquely identify the documentation set bundle. This should be a
858
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
859
# will append .docset to the name.
861
DOCSET_BUNDLE_ID = org.doxygen.Project
863
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
864
# will be generated that can be used as input for tools like the
865
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
866
# of the generated HTML documentation.
868
GENERATE_HTMLHELP = NO
870
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
871
# be used to specify the file name of the resulting .chm file. You
872
# can add a path in front of the file if the result should not be
873
# written to the html output directory.
877
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
878
# be used to specify the location (absolute path including file name) of
879
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
880
# the HTML help compiler on the generated index.hhp.
884
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
885
# controls if a separate .chi index file is generated (YES) or that
886
# it should be included in the master .chm file (NO).
890
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
891
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
896
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
897
# controls whether a binary table of contents is generated (YES) or a
898
# normal table of contents (NO) in the .chm file.
902
# The TOC_EXPAND flag can be set to YES to add extra items for group members
903
# to the contents of the HTML help documentation and to the tree view.
907
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
908
# are set, an additional index file will be generated that can be used as input for
909
# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
910
# HTML documentation.
914
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
915
# be used to specify the file name of the resulting .qch file.
916
# The path specified is relative to the HTML output folder.
920
# The QHP_NAMESPACE tag specifies the namespace to use when generating
921
# Qt Help Project output. For more information please see
922
# http://doc.trolltech.com/qthelpproject.html#namespace
926
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
927
# Qt Help Project output. For more information please see
928
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
930
QHP_VIRTUAL_FOLDER = doc
932
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
933
# For more information please see
934
# http://doc.trolltech.com/qthelpproject.html#custom-filters
936
QHP_CUST_FILTER_NAME =
938
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
939
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
941
QHP_CUST_FILTER_ATTRS =
943
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
944
# filter section matches.
945
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
947
QHP_SECT_FILTER_ATTRS =
949
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
950
# be used to specify the location of Qt's qhelpgenerator.
951
# If non-empty doxygen will try to run qhelpgenerator on the generated
956
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
957
# top of each HTML page. The value NO (the default) enables the index and
958
# the value YES disables it.
962
# This tag can be used to set the number of enum values (range [1..20])
963
# that doxygen will group on one line in the generated HTML documentation.
965
ENUM_VALUES_PER_LINE = 4
967
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
968
# structure should be generated to display hierarchical information.
969
# If the tag value is set to YES, a side panel will be generated
970
# containing a tree-like index structure (just like the one that
971
# is generated for HTML Help). For this to work a browser that supports
972
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
973
# Windows users are probably better off using the HTML help feature.
975
GENERATE_TREEVIEW = NONE
977
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
978
# and Class Hierarchy pages using a tree view instead of an ordered list.
980
USE_INLINE_TREES = NO
982
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
983
# used to set the initial width (in pixels) of the frame in which the tree
988
# Use this tag to change the font size of Latex formulas included
989
# as images in the HTML documentation. The default is 10. Note that
990
# when you change the font size after a successful doxygen run you need
991
# to manually remove any form_*.png images from the HTML output directory
992
# to force them to be regenerated.
994
FORMULA_FONTSIZE = 10
996
# When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
997
# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
998
# there is already a search function so this one should typically
1003
#---------------------------------------------------------------------------
1004
# configuration options related to the LaTeX output
1005
#---------------------------------------------------------------------------
1007
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1008
# generate Latex output.
1010
GENERATE_LATEX = YES
1012
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1013
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1014
# put in front of it. If left blank `latex' will be used as the default path.
1016
LATEX_OUTPUT = latex
1018
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1019
# invoked. If left blank `latex' will be used as the default command name.
1021
LATEX_CMD_NAME = latex
1023
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1024
# generate index for LaTeX. If left blank `makeindex' will be used as the
1025
# default command name.
1027
MAKEINDEX_CMD_NAME = makeindex
1029
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1030
# LaTeX documents. This may be useful for small projects and may help to
1031
# save some trees in general.
1035
# The PAPER_TYPE tag can be used to set the paper type that is used
1036
# by the printer. Possible values are: a4, a4wide, letter, legal and
1037
# executive. If left blank a4wide will be used.
1041
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1042
# packages that should be included in the LaTeX output.
1046
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1047
# the generated latex document. The header should contain everything until
1048
# the first chapter. If it is left blank doxygen will generate a
1049
# standard header. Notice: only use this tag if you know what you are doing!
1053
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1054
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1055
# contain links (just like the HTML output) instead of page references
1056
# This makes the output suitable for online browsing using a pdf viewer.
1058
PDF_HYPERLINKS = YES
1060
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1061
# plain latex in the generated Makefile. Set this option to YES to get a
1062
# higher quality PDF documentation.
1066
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1067
# command to the generated LaTeX files. This will instruct LaTeX to keep
1068
# running if errors occur, instead of asking the user for help.
1069
# This option is also used when generating formulas in HTML.
1071
LATEX_BATCHMODE = NO
1073
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1074
# include the index chapters (such as File Index, Compound Index, etc.)
1077
LATEX_HIDE_INDICES = NO
1079
# 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.
1081
LATEX_SOURCE_CODE = NO
1083
#---------------------------------------------------------------------------
1084
# configuration options related to the RTF output
1085
#---------------------------------------------------------------------------
1087
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1088
# The RTF output is optimized for Word 97 and may not look very pretty with
1089
# other RTF readers or editors.
1093
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1094
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1095
# put in front of it. If left blank `rtf' will be used as the default path.
1099
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1100
# RTF documents. This may be useful for small projects and may help to
1101
# save some trees in general.
1105
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1106
# will contain hyperlink fields. The RTF file will
1107
# contain links (just like the HTML output) instead of page references.
1108
# This makes the output suitable for online browsing using WORD or other
1109
# programs which support those fields.
1110
# Note: wordpad (write) and others do not support links.
1114
# Load stylesheet definitions from file. Syntax is similar to doxygen's
1115
# config file, i.e. a series of assignments. You only have to provide
1116
# replacements, missing definitions are set to their default value.
1118
RTF_STYLESHEET_FILE =
1120
# Set optional variables used in the generation of an rtf document.
1121
# Syntax is similar to doxygen's config file.
1123
RTF_EXTENSIONS_FILE =
1125
#---------------------------------------------------------------------------
1126
# configuration options related to the man page output
1127
#---------------------------------------------------------------------------
1129
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1130
# generate man pages
1134
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1135
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1136
# put in front of it. If left blank `man' will be used as the default path.
1140
# The MAN_EXTENSION tag determines the extension that is added to
1141
# the generated man pages (default is the subroutine's section .3)
1145
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1146
# then it will generate one additional man file for each entity
1147
# documented in the real man page(s). These additional files
1148
# only source the real man page, but without them the man command
1149
# would be unable to find the correct page. The default is NO.
1153
#---------------------------------------------------------------------------
1154
# configuration options related to the XML output
1155
#---------------------------------------------------------------------------
1157
# If the GENERATE_XML tag is set to YES Doxygen will
1158
# generate an XML file that captures the structure of
1159
# the code including all documentation.
1163
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1164
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1165
# put in front of it. If left blank `xml' will be used as the default path.
1169
# The XML_SCHEMA tag can be used to specify an XML schema,
1170
# which can be used by a validating XML parser to check the
1171
# syntax of the XML files.
1175
# The XML_DTD tag can be used to specify an XML DTD,
1176
# which can be used by a validating XML parser to check the
1177
# syntax of the XML files.
1181
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1182
# dump the program listings (including syntax highlighting
1183
# and cross-referencing information) to the XML output. Note that
1184
# enabling this will significantly increase the size of the XML output.
1186
XML_PROGRAMLISTING = YES
1188
#---------------------------------------------------------------------------
1189
# configuration options for the AutoGen Definitions output
1190
#---------------------------------------------------------------------------
1192
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1193
# generate an AutoGen Definitions (see autogen.sf.net) file
1194
# that captures the structure of the code including all
1195
# documentation. Note that this feature is still experimental
1196
# and incomplete at the moment.
1198
GENERATE_AUTOGEN_DEF = NO
1200
#---------------------------------------------------------------------------
1201
# configuration options related to the Perl module output
1202
#---------------------------------------------------------------------------
1204
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1205
# generate a Perl module file that captures the structure of
1206
# the code including all documentation. Note that this
1207
# feature is still experimental and incomplete at the
1210
GENERATE_PERLMOD = NO
1212
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1213
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1214
# to generate PDF and DVI output from the Perl module output.
1218
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1219
# nicely formatted so it can be parsed by a human reader.
1221
# if you want to understand what is going on.
1222
# On the other hand, if this
1223
# tag is set to NO the size of the Perl module output will be much smaller
1224
# and Perl will parse it just the same.
1226
PERLMOD_PRETTY = YES
1228
# The names of the make variables in the generated doxyrules.make file
1229
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1230
# This is useful so different doxyrules.make files included by the same
1231
# Makefile don't overwrite each other's variables.
1233
PERLMOD_MAKEVAR_PREFIX =
1235
#---------------------------------------------------------------------------
1236
# Configuration options related to the preprocessor
1237
#---------------------------------------------------------------------------
1239
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1240
# evaluate all C-preprocessor directives found in the sources and include
1243
ENABLE_PREPROCESSING = YES
1245
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1246
# names in the source code. If set to NO (the default) only conditional
1247
# compilation will be performed. Macro expansion can be done in a controlled
1248
# way by setting EXPAND_ONLY_PREDEF to YES.
1250
MACRO_EXPANSION = YES
1252
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1253
# then the macro expansion is limited to the macros specified with the
1254
# PREDEFINED and EXPAND_AS_DEFINED tags.
1256
EXPAND_ONLY_PREDEF = YES
1258
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1259
# in the INCLUDE_PATH (see below) will be search if a #include is found.
1261
SEARCH_INCLUDES = YES
1263
# The INCLUDE_PATH tag can be used to specify one or more directories that
1264
# contain include files that are not input files but should be processed by
1269
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1270
# patterns (like *.h and *.hpp) to filter out the header-files in the
1271
# directories. If left blank, the patterns specified with FILE_PATTERNS will
1274
INCLUDE_FILE_PATTERNS =
1276
# The PREDEFINED tag can be used to specify one or more macro names that
1277
# are defined before the preprocessor is started (similar to the -D option of
1278
# gcc). The argument of the tag is a list of macros of the form: name
1279
# or name=definition (no spaces). If the definition and the = are
1280
# omitted =1 is assumed. To prevent a macro definition from being
1281
# undefined via #undef or recursively expanded use the := operator
1282
# instead of the = operator.
1284
PREDEFINED = DOXYGEN PRINTF_ATTRIBUTE(x,y)=
1286
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1287
# this tag can be used to specify a list of macro names that should be expanded.
1288
# The macro definition that is found in the sources will be used.
1289
# Use the PREDEFINED tag if you want to use a different macro definition.
1293
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1294
# doxygen's preprocessor will remove all function-like macros that are alone
1295
# on a line, have an all uppercase name, and do not end with a semicolon. Such
1296
# function macros are typically used for boiler-plate code, and will confuse
1297
# the parser if not removed.
1299
SKIP_FUNCTION_MACROS = YES
1301
#---------------------------------------------------------------------------
1302
# Configuration::additions related to external references
1303
#---------------------------------------------------------------------------
1305
# The TAGFILES option can be used to specify one or more tagfiles.
1306
# Optionally an initial location of the external documentation
1307
# can be added for each tagfile. The format of a tag file without
1308
# this location is as follows:
1310
# TAGFILES = file1 file2 ...
1311
# Adding location for the tag files is done as follows:
1313
# TAGFILES = file1=loc1 "file2 = loc2" ...
1314
# where "loc1" and "loc2" can be relative or absolute paths or
1315
# URLs. If a location is present for each tag, the installdox tool
1316
# does not have to be run to correct the links.
1317
# Note that each tag file must have a unique name
1318
# (where the name does NOT include the path)
1319
# If a tag file is not located in the directory in which doxygen
1320
# is run, you must also specify the path to the tagfile here.
1324
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1325
# a tag file that is based on the input files it reads.
1329
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1330
# in the class index. If set to NO only the inherited external classes
1335
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1336
# in the modules index. If set to NO, only the current project's groups will
1339
EXTERNAL_GROUPS = YES
1341
# The PERL_PATH should be the absolute path and name of the perl script
1342
# interpreter (i.e. the result of `which perl').
1344
PERL_PATH = /usr/bin/perl
1346
#---------------------------------------------------------------------------
1347
# Configuration options related to the dot tool
1348
#---------------------------------------------------------------------------
1350
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1351
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1352
# or super classes. Setting the tag to NO turns the diagrams off. Note that
1353
# this option is superseded by the HAVE_DOT option below. This is only a
1354
# fallback. It is recommended to install and use dot, since it yields more
1357
CLASS_DIAGRAMS = YES
1359
# You can define message sequence charts within doxygen comments using the \msc
1360
# command. Doxygen will then run the mscgen tool (see
1361
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1362
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1363
# the mscgen tool resides. If left empty the tool is assumed to be found in the
1364
# default search path.
1368
# If set to YES, the inheritance and collaboration graphs will hide
1369
# inheritance and usage relations if the target is undocumented
1370
# or is not a class.
1372
HIDE_UNDOC_RELATIONS = YES
1374
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1375
# available from the path. This tool is part of Graphviz, a graph visualization
1376
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1377
# have no effect if this option is set to NO (the default)
1381
# By default doxygen will write a font called FreeSans.ttf to the output
1382
# directory and reference it in all dot files that doxygen generates. This
1383
# font does not include all possible unicode characters however, so when you need
1384
# these (or just want a differently looking font) you can specify the font name
1385
# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1386
# which can be done by putting it in a standard location or by setting the
1387
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1388
# containing the font.
1390
DOT_FONTNAME = FreeSans
1392
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1393
# The default size is 10pt.
1397
# By default doxygen will tell dot to use the output directory to look for the
1398
# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1399
# different font using DOT_FONTNAME you can set the path where dot
1400
# can find it using this tag.
1404
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1405
# will generate a graph for each documented class showing the direct and
1406
# indirect inheritance relations. Setting this tag to YES will force the
1407
# the CLASS_DIAGRAMS tag to NO.
1411
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1412
# will generate a graph for each documented class showing the direct and
1413
# indirect implementation dependencies (inheritance, containment, and
1414
# class references variables) of the class with other documented classes.
1416
COLLABORATION_GRAPH = YES
1418
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1419
# will generate a graph for groups, showing the direct groups dependencies
1423
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1424
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1429
# If set to YES, the inheritance and collaboration graphs will show the
1430
# relations between templates and their instances.
1432
TEMPLATE_RELATIONS = NO
1434
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1435
# tags are set to YES then doxygen will generate a graph for each documented
1436
# file showing the direct and indirect include dependencies of the file with
1437
# other documented files.
1441
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1442
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1443
# documented header file showing the documented files that directly or
1444
# indirectly include this file.
1446
INCLUDED_BY_GRAPH = YES
1448
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1449
# doxygen will generate a call dependency graph for every global function
1450
# or class method. Note that enabling this option will significantly increase
1451
# the time of a run. So in most cases it will be better to enable call graphs
1452
# for selected functions only using the \callgraph command.
1456
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1457
# doxygen will generate a caller dependency graph for every global function
1458
# or class method. Note that enabling this option will significantly increase
1459
# the time of a run. So in most cases it will be better to enable caller
1460
# graphs for selected functions only using the \callergraph command.
1464
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1465
# will graphical hierarchy of all classes instead of a textual one.
1467
GRAPHICAL_HIERARCHY = YES
1469
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1470
# then doxygen will show the dependencies a directory has on other directories
1471
# in a graphical way. The dependency relations are determined by the #include
1472
# relations between the files in the directories.
1474
DIRECTORY_GRAPH = YES
1476
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1477
# generated by dot. Possible values are png, jpg, or gif
1478
# If left blank png will be used.
1480
DOT_IMAGE_FORMAT = png
1482
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1483
# found. If left blank, it is assumed the dot tool can be found in the path.
1487
# The DOTFILE_DIRS tag can be used to specify one or more directories that
1488
# contain dot files that are included in the documentation (see the
1489
# \dotfile command).
1493
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1494
# nodes that will be shown in the graph. If the number of nodes in a graph
1495
# becomes larger than this value, doxygen will truncate the graph, which is
1496
# visualized by representing a node as a red box. Note that doxygen if the
1497
# number of direct children of the root node in a graph is already larger than
1498
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1499
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1501
DOT_GRAPH_MAX_NODES = 50
1503
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1504
# graphs generated by dot. A depth value of 3 means that only nodes reachable
1505
# from the root by following a path via at most 3 edges will be shown. Nodes
1506
# that lay further from the root node will be omitted. Note that setting this
1507
# option to 1 or 2 may greatly reduce the computation time needed for large
1508
# code bases. Also note that the size of a graph can be further restricted by
1509
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1511
MAX_DOT_GRAPH_DEPTH = 0
1513
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1514
# background. This is disabled by default, because dot on Windows does not
1515
# seem to support this out of the box. Warning: Depending on the platform used,
1516
# enabling this option may lead to badly anti-aliased labels on the edges of
1517
# a graph (i.e. they become hard to read).
1519
DOT_TRANSPARENT = YES
1521
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1522
# files in one run (i.e. multiple -o and -T options on the command line). This
1523
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1524
# support this, this feature is disabled by default.
1526
DOT_MULTI_TARGETS = NO
1528
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1529
# generate a legend page explaining the meaning of the various boxes and
1530
# arrows in the dot generated graphs.
1532
GENERATE_LEGEND = YES
1534
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1535
# remove the intermediate dot files that are used to generate
1536
# the various graphs.
added
removed
lib/talloc/doxy.config
