14
14
# Project related configuration options
15
15
#---------------------------------------------------------------------------
17
# This tag specifies the encoding used for all characters in the config file that
18
# follow. The default is UTF-8 which is also the encoding used for all text before
19
# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
20
# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
23
DOXYFILE_ENCODING = UTF-8
17
25
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18
26
# by quotes) that should identify the project.
35
43
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
36
# 2 levels of 10 sub-directories under the output directory of each output
44
# 4096 sub-directories (in 2 levels) under the output directory of each output
37
45
# format and will distribute the generated files over these directories.
38
# Enabling this option can be useful when feeding doxygen a huge amount of source
39
# files, where putting all generated files in the same directory would otherwise
40
# cause performance problems for the file system.
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.
42
50
CREATE_SUBDIRS = NO
45
53
# documentation generated by doxygen is written. Doxygen will use this
46
54
# information to generate all constant output in the proper language.
47
55
# The default language is English, other supported languages are:
48
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
49
# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
50
# (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese,
51
# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
56
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57
# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
58
# Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
59
# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
60
# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
53
62
OUTPUT_LANGUAGE = English
55
# This tag can be used to specify the encoding used in the generated output.
56
# The encoding is not always determined by the language that is chosen,
57
# but also whether or not the output is meant for Windows or non-Windows users.
58
# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
59
# forces the Windows encoding (this is the default for the Windows binary),
60
# whereas setting the tag to NO uses a Unix-style encoding (the default for
61
# all platforms other than Windows).
63
USE_WINDOWS_ENCODING = NO
65
64
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66
65
# include brief member descriptions after the members that are listed in
67
66
# the file and class documentation (similar to JavaDoc).
79
78
# This tag implements a quasi-intelligent brief description abbreviator
80
79
# that is used to form the text in various listings. Each string
81
80
# 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 used
83
# as the annotated text. Otherwise, the brief description is used as-is. If left
84
# blank, the following values are used ("$name" is automatically replaced with the
85
# name of the entity): "The $name class" "The $name widget" "The $name file"
86
# "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
81
# stripped from the text and the result after processing the whole list, is
82
# used as the annotated text. Otherwise, the brief description is used as-is.
83
# If left blank, the following values are used ("$name" is automatically
84
# replaced with the name of the entity): "The $name class" "The $name widget"
85
# "The $name file" "is" "provides" "specifies" "contains"
86
# "represents" "a" "an" "the"
94
94
ALWAYS_DETAILED_SEC = NO
96
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
97
# members of a class in the documentation of that class as if those members were
98
# ordinary class members. Constructors, destructors and assignment operators of
99
# the base classes will not be shown.
96
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
97
# inherited members of a class in the documentation of that class as if those
98
# members were ordinary class members. Constructors, destructors and assignment
99
# operators of the base classes will not be shown.
101
101
INLINE_INHERITED_MEMB = NO
133
133
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
134
134
# will interpret the first line (until the first dot) of a JavaDoc-style
135
135
# comment as the brief description. If set to NO, the JavaDoc
136
# comments will behave just like the Qt-style comments (thus requiring an
137
# explicit @brief command for a brief description.
136
# comments will behave just like regular Qt-style comments
137
# (thus requiring an explicit @brief command for a brief description.)
139
139
JAVADOC_AUTOBRIEF = NO
141
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
142
# interpret the first line (until the first dot) of a Qt-style
143
# comment as the brief description. If set to NO, the comments
144
# will behave just like regular Qt-style comments (thus requiring
145
# an explicit \brief command for a brief description.)
141
149
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
142
150
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
143
151
# comments) as a brief description. This used to be the default behaviour.
160
168
INHERIT_DOCS = YES
162
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
163
# tag is set to YES, then doxygen will reuse the documentation of the first
164
# member in the group (if any) for the other members of the group. By default
165
# all members of a group must be documented explicitly.
170
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
171
# a new page for each member. If set to NO, the documentation of a member will
172
# be part of the file/class/namespace that contains it.
167
DISTRIBUTE_GROUP_DOC = NO
174
SEPARATE_MEMBER_PAGES = NO
169
176
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
170
177
# Doxygen uses this value to replace tabs by spaces in code fragments.
183
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
184
# only. Doxygen will then generate output that is more tailored for C.
190
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
191
# sources only. Doxygen will then generate output that is more tailored for C.
185
192
# For instance, some of the names that are used will be different. The list
186
193
# of all members will be omitted, etc.
188
195
OPTIMIZE_OUTPUT_FOR_C = YES
190
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
191
# only. Doxygen will then generate output that is more tailored for Java.
197
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
198
# sources only. Doxygen will then generate output that is more tailored for Java.
192
199
# For instance, namespaces will be presented as packages, qualified scopes
193
200
# will look different, etc.
195
202
OPTIMIZE_OUTPUT_JAVA = NO
204
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
205
# include (a tag file for) the STL sources as input, then you should
206
# set this tag to YES in order to let doxygen match functions declarations and
207
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
208
# func(std::string) {}). This also make the inheritance and collaboration
209
# diagrams that involve STL classes more complete and accurate.
211
BUILTIN_STL_SUPPORT = NO
213
# If you use Microsoft's C++/CLI language, you should set this option to YES to
214
# enable parsing support.
218
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
219
# tag is set to YES, then doxygen will reuse the documentation of the first
220
# member in the group (if any) for the other members of the group. By default
221
# all members of a group must be documented explicitly.
223
DISTRIBUTE_GROUP_DOC = NO
197
225
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
198
226
# the same type (for instance a group of public functions) to be put as a
199
227
# subgroup of that type (e.g. under the Public Functions section). Set it to
237
265
EXTRACT_LOCAL_METHODS = NO
267
# If this flag is set to YES, the members of anonymous namespaces will be extracted
268
# and appear in the documentation as a namespace called 'anonymous_namespace{file}',
269
# where file will be replaced with the base name of the file that contains the anonymous
270
# namespace. By default anonymous namespace are hidden.
272
EXTRACT_ANON_NSPACES = NO
239
274
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
240
275
# undocumented members of documented classes, files or namespaces.
241
276
# If set to NO (the default) these members will be included in the
367
402
SHOW_USED_FILES = YES
404
# If the sources in your project are distributed over multiple directories
405
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
406
# in the documentation. The default is NO.
408
SHOW_DIRECTORIES = NO
410
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
411
# doxygen should invoke to get the current version for each file (typically from the
412
# version control system). Doxygen will invoke the program by executing (via
413
# popen()) the command <command> <input-file>, where <command> is the value of
414
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
415
# provided by doxygen. Whatever the program writes to standard output
416
# is used as the file version. See the manual for examples.
418
FILE_VERSION_FILTER =
369
420
#---------------------------------------------------------------------------
370
421
# configuration options related to warning and progress messages
371
422
#---------------------------------------------------------------------------
395
446
WARN_IF_DOC_ERROR = YES
448
# This WARN_NO_PARAMDOC option can be abled to get warnings for
449
# functions that are documented, but have no documentation for their parameters
450
# or return value. If set to NO (the default) doxygen will only warn about
451
# wrong or incomplete parameter documentation, but not about the absence of
454
WARN_NO_PARAMDOC = NO
397
456
# The WARN_FORMAT tag determines the format of the warning messages that
398
457
# doxygen can produce. The string should contain the $file, $line, and $text
399
458
# tags, which will be replaced by the file and line number from which the
400
# warning originated and the warning text.
459
# warning originated and the warning text. Optionally the format may contain
460
# $version, which will be replaced by the version of the file (if it could
461
# be obtained via FILE_VERSION_FILTER)
482
# This tag can be used to specify the character encoding of the source files that
483
# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
484
# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
485
# See http://www.gnu.org/software/libiconv for the list of possible encodings.
487
INPUT_ENCODING = UTF-8
421
489
# If the value of the INPUT tag contains directories, you can use the
422
490
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
423
491
# and *.h) to filter out the source-files in the directories. If left
424
492
# blank the following patterns are tested:
425
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
426
# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
493
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
494
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
442
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
443
# that are symbolic links (a Unix filesystem feature) are excluded from the input.
510
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
511
# directories that are symbolic links (a Unix filesystem feature) are excluded
445
514
EXCLUDE_SYMLINKS = NO
447
516
# If the value of the INPUT tag contains directories, you can use the
448
517
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
449
# certain files from those directories.
518
# certain files from those directories. Note that the wildcards are matched
519
# against the file with absolute path, so to exclude all test directories
520
# for example use the pattern */test/*
451
522
EXCLUDE_PATTERNS =
524
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
525
# (namespaces, classes, functions, etc.) that should be excluded from the output.
526
# The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
527
# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
453
531
# The EXAMPLE_PATH tag can be used to specify one or more files or
454
532
# directories that contain example code fragments that are included (see
455
533
# the \include command).
481
559
# by executing (via popen()) the command <filter> <input-file>, where <filter>
482
560
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
483
561
# input file. Doxygen will then use the output that the filter program writes
484
# to standard output.
562
# to standard output. If FILTER_PATTERNS is specified, this tag will be
567
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
568
# basis. Doxygen will compare the file name with each pattern and apply the
569
# filter if there is a match. The filters are a list of the form:
570
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
571
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
572
# is applied to all files.
488
576
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
489
577
# INPUT_FILTER) will be used to filter the input files when producing source
490
578
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
498
586
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
499
587
# be generated. Documented entities will be cross-referenced with these sources.
500
588
# Note: To get rid of all source code in the generated output, make sure also
501
# VERBATIM_HEADERS is set to NO.
589
# VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH
590
# then you must also enable this option. If you don't then doxygen will produce
591
# a warning and turn it on anyway
503
593
SOURCE_BROWSER = YES
526
616
REFERENCES_RELATION = NO
618
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
619
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
620
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
621
# link to the source code. Otherwise they will link to the documentstion.
623
REFERENCES_LINK_SOURCE = YES
625
# If the USE_HTAGS tag is set to YES then the references to source code
626
# will point to the HTML generated by the htags(1) tool instead of doxygen
627
# built-in source browser. The htags tool is part of GNU's global source
628
# tagging system (see http://www.gnu.org/software/global/global.html). You
629
# will need version 4.8.6 or higher.
528
633
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
529
634
# will generate a verbatim copy of the header file for each class for
530
635
# which an include is specified. Set to NO to disable this.
610
715
GENERATE_HTMLHELP = NO
717
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
718
# documentation will contain sections that can be hidden and shown after the
719
# page has loaded. For this to work a browser that supports
720
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
721
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
723
HTML_DYNAMIC_SECTIONS = NO
612
725
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
613
726
# be used to specify the file name of the resulting .chm file. You
614
727
# can add a path in front of the file if the result should not be
951
1066
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
952
1067
# doxygen's preprocessor will remove all function-like macros that are alone
953
1068
# on a line, have an all uppercase name, and do not end with a semicolon. Such
954
# function macros are typically used for boiler-plate code, and will confuse the
955
# parser if not removed.
1069
# function macros are typically used for boiler-plate code, and will confuse
1070
# the parser if not removed.
957
1072
SKIP_FUNCTION_MACROS = YES
1004
1119
#---------------------------------------------------------------------------
1006
1121
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1007
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
1008
# super classes. Setting the tag to NO turns the diagrams off. Note that this
1009
# option is superseded by the HAVE_DOT option below. This is only a fallback. It is
1010
# recommended to install and use dot, since it yields more powerful graphs.
1122
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1123
# or super classes. Setting the tag to NO turns the diagrams off. Note that
1124
# this option is superseded by the HAVE_DOT option below. This is only a
1125
# fallback. It is recommended to install and use dot, since it yields more
1012
1128
CLASS_DIAGRAMS = YES
1130
# You can define message sequence charts within doxygen comments using the \msc
1131
# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
1132
# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
1133
# specify the directory where the mscgen tool resides. If left empty the tool is assumed to
1134
# be found in the default search path.
1014
1138
# If set to YES, the inheritance and collaboration graphs will hide
1015
1139
# inheritance and usage relations if the target is undocumented
1016
1140
# or is not a class.
1072
1201
CALL_GRAPH = NO
1203
# If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
1204
# generate a caller dependency graph for every global function or class method.
1205
# Note that enabling this option will significantly increase the time of a run.
1206
# So in most cases it will be better to enable caller graphs for selected
1207
# functions only using the \callergraph command.
1074
1211
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1075
1212
# will graphical hierarchy of all classes instead of a textual one.
1077
1214
GRAPHICAL_HIERARCHY = YES
1216
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1217
# then doxygen will show the dependencies a directory has on other directories
1218
# in a graphical way. The dependency relations are determined by the #include
1219
# relations between the files in the directories.
1221
DIRECTORY_GRAPH = YES
1079
1223
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1080
1224
# generated by dot. Possible values are png, jpg, or gif
1081
1225
# If left blank png will be used.
1096
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1097
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1098
# this value, doxygen will try to truncate the graph, so that it fits within
1099
# the specified constraint. Beware that most browsers cannot cope with very
1102
MAX_DOT_GRAPH_WIDTH = 1024
1104
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1105
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1106
# this value, doxygen will try to truncate the graph, so that it fits within
1107
# the specified constraint. Beware that most browsers cannot cope with very
1110
MAX_DOT_GRAPH_HEIGHT = 1024
1240
# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1241
# nodes that will be shown in the graph. If the number of nodes in a graph
1242
# becomes larger than this value, doxygen will truncate the graph, which is
1243
# visualized by representing a node as a red box. Note that doxygen if the number
1244
# of direct children of the root node in a graph is already larger than
1245
# MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note
1246
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1248
DOT_GRAPH_MAX_NODES = 50
1112
1250
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1113
1251
# graphs generated by dot. A depth value of 3 means that only nodes reachable
1114
# from the root by following a path via at most 3 edges will be shown. Nodes that
1115
# lay further from the root node will be omitted. Note that setting this option to
1116
# 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1117
# note that a graph may be further truncated if the graph's image dimensions are
1118
# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1119
# If 0 is used for the depth value (the default), the graph is not depth-constrained.
1252
# from the root by following a path via at most 3 edges will be shown. Nodes
1253
# that lay further from the root node will be omitted. Note that setting this
1254
# option to 1 or 2 may greatly reduce the computation time needed for large
1255
# code bases. Also note that the size of a graph can be further restricted by
1256
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1121
1258
MAX_DOT_GRAPH_DEPTH = 0
1260
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1261
# background. This is disabled by default, which results in a white background.
1262
# Warning: Depending on the platform used, enabling this option may lead to
1263
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1266
DOT_TRANSPARENT = NO
1268
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1269
# files in one run (i.e. multiple -o and -T options on the command line). This
1270
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1271
# support this, this feature is disabled by default.
1273
DOT_MULTI_TARGETS = NO
1123
1275
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1124
1276
# generate a legend page explaining the meaning of the various boxes and
1125
1277
# arrows in the dot generated graphs.
added
removed
doc/doxygen.cfg
