20
20
# Project related configuration options
21
21
#---------------------------------------------------------------------------
23
# This tag specifies the encoding used for all characters in the config file that
24
# follow. The default is UTF-8 which is also the encoding used for all text before
25
# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
26
# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
29
DOXYFILE_ENCODING = iso-8859-1
23
31
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
24
32
# by quotes) that should identify the project.
51
59
# documentation generated by doxygen is written. Doxygen will use this
52
60
# information to generate all constant output in the proper language.
53
61
# The default language is English, other supported languages are:
54
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
55
# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
56
# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
57
# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
58
# Swedish, and Ukrainian.
62
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
63
# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
64
# Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
65
# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
66
# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
60
68
OUTPUT_LANGUAGE = English
62
# This tag can be used to specify the encoding used in the generated output.
63
# The encoding is not always determined by the language that is chosen,
64
# but also whether or not the output is meant for Windows or non-Windows users.
65
# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
66
# forces the Windows encoding (this is the default for the Windows binary),
67
# whereas setting the tag to NO uses a Unix-style encoding (the default for
68
# all platforms other than Windows).
70
USE_WINDOWS_ENCODING = NO
72
70
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
73
71
# include brief member descriptions after the members that are listed in
74
72
# the file and class documentation (similar to JavaDoc).
168
166
INHERIT_DOCS = YES
170
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
171
# tag is set to YES, then doxygen will reuse the documentation of the first
172
# member in the group (if any) for the other members of the group. By default
173
# all members of a group must be documented explicitly.
168
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
169
# a new page for each member. If set to NO, the documentation of a member will
170
# be part of the file/class/namespace that contains it.
175
DISTRIBUTE_GROUP_DOC = NO
172
SEPARATE_MEMBER_PAGES = NO
177
174
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
178
175
# Doxygen uses this value to replace tabs by spaces in code fragments.
196
193
OPTIMIZE_OUTPUT_FOR_C = YES
198
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
199
# only. Doxygen will then generate output that is more tailored for Java.
195
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
196
# sources only. Doxygen will then generate output that is more tailored for Java.
200
197
# For instance, namespaces will be presented as packages, qualified scopes
201
198
# will look different, etc.
203
200
OPTIMIZE_OUTPUT_JAVA = NO
202
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
203
# include (a tag file for) the STL sources as input, then you should
204
# set this tag to YES in order to let doxygen match functions declarations and
205
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
206
# func(std::string) {}). This also make the inheritance and collaboration
207
# diagrams that involve STL classes more complete and accurate.
209
BUILTIN_STL_SUPPORT = NO
211
# If you use Microsoft's C++/CLI language, you should set this option to YES to
212
# enable parsing support.
216
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
217
# tag is set to YES, then doxygen will reuse the documentation of the first
218
# member in the group (if any) for the other members of the group. By default
219
# all members of a group must be documented explicitly.
221
DISTRIBUTE_GROUP_DOC = NO
205
223
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
206
224
# the same type (for instance a group of public functions) to be put as a
207
225
# subgroup of that type (e.g. under the Public Functions section). Set it to
385
403
# version control system). Doxygen will invoke the program by executing (via
386
404
# popen()) the command <command> <input-file>, where <command> is the value of
387
405
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
388
# provided by doxygen. Whatever the progam writes to standard output
406
# provided by doxygen. Whatever the program writes to standard output
389
407
# is used as the file version. See the manual for examples.
391
409
FILE_VERSION_FILTER =
456
474
# compat/ headers, then demo projects.
457
475
# For the User Manual, it is whatever chapter order seems sensible.
459
INPUT = @top_srcdir@/include/assert.h \
477
INPUT = @top_srcdir@/include/alloca.h \
478
@top_srcdir@/include/assert.h \
460
479
@top_srcdir@/include/ctype.h \
461
480
@top_srcdir@/include/errno.h \
462
481
@top_srcdir@/include/inttypes.h \
505
525
@top_srcdir@/doc/examples/stdiodemo \
506
526
@top_srcdir@/doc/examples/twitest
528
# This tag can be used to specify the character encoding of the source files that
529
# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
530
# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
531
# See http://www.gnu.org/software/libiconv for the list of possible encodings.
533
INPUT_ENCODING = iso-8859-1
508
535
# If the value of the INPUT tag contains directories, you can use the
509
536
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
510
537
# and *.h) to filter out the source-files in the directories. If left
511
538
# blank the following patterns are tested:
512
539
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
513
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
540
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
515
542
FILE_PATTERNS = *.c \
538
565
# If the value of the INPUT tag contains directories, you can use the
539
566
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
540
# certain files from those directories.
567
# certain files from those directories. Note that the wildcards are matched
568
# against the file with absolute path, so to exclude all test directories
569
# for example use the pattern */test/*
542
571
EXCLUDE_PATTERNS = *CVS*
573
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
574
# (namespaces, classes, functions, etc.) that should be excluded from the output.
575
# The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
576
# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
544
580
# The EXAMPLE_PATH tag can be used to specify one or more files or
545
581
# directories that contain example code fragments that are included (see
546
582
# the \include command).
635
671
REFERENCES_RELATION = NO
673
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
674
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
675
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
676
# link to the source code. Otherwise they will link to the documentstion.
678
REFERENCES_LINK_SOURCE = YES
680
# If the USE_HTAGS tag is set to YES then the references to source code
681
# will point to the HTML generated by the htags(1) tool instead of doxygen
682
# built-in source browser. The htags tool is part of GNU's global source
683
# tagging system (see http://www.gnu.org/software/global/global.html). You
684
# will need version 4.8.6 or higher.
637
688
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
638
689
# will generate a verbatim copy of the header file for each class for
639
690
# which an include is specified. Set to NO to disable this.
1124
1175
CLASS_DIAGRAMS = YES
1177
# You can define message sequence charts within doxygen comments using the \msc
1178
# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
1179
# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
1180
# specify the directory where the mscgen tool resides. If left empty the tool is assumed to
1181
# be found in the default search path.
1126
1185
# If set to YES, the inheritance and collaboration graphs will hide
1127
1186
# inheritance and usage relations if the target is undocumented
1128
1187
# or is not a class.
1189
1248
CALL_GRAPH = NO
1250
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1251
# generate a caller dependency graph for every global function or class method.
1252
# Note that enabling this option will significantly increase the time of a run.
1253
# So in most cases it will be better to enable caller graphs for selected
1254
# functions only using the \callergraph command.
1191
1258
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1192
1259
# will graphical hierarchy of all classes instead of a textual one.
1220
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1221
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1222
# this value, doxygen will try to truncate the graph, so that it fits within
1223
# the specified constraint. Beware that most browsers cannot cope with very
1226
MAX_DOT_GRAPH_WIDTH = 1024
1228
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1229
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1230
# this value, doxygen will try to truncate the graph, so that it fits within
1231
# the specified constraint. Beware that most browsers cannot cope with very
1234
MAX_DOT_GRAPH_HEIGHT = 1024
1236
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1237
# graphs generated by dot. A depth value of 3 means that only nodes reachable
1238
# from the root by following a path via at most 3 edges will be shown. Nodes
1239
# that lay further from the root node will be omitted. Note that setting this
1240
# option to 1 or 2 may greatly reduce the computation time needed for large
1241
# code bases. Also note that a graph may be further truncated if the graph's
1242
# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
1243
# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
1244
# the graph is not depth-constrained.
1246
MAX_DOT_GRAPH_DEPTH = 0
1287
# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1288
# nodes that will be shown in the graph. If the number of nodes in a graph
1289
# becomes larger than this value, doxygen will truncate the graph, which is
1290
# visualized by representing a node as a red box. Note that doxygen will always
1291
# show the root nodes and its direct children regardless of this setting.
1293
DOT_GRAPH_MAX_NODES = 50
1248
1295
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1249
1296
# background. This is disabled by default, which results in a white background.
added
removed
doc/api/doxygen.config.in
