33
33
OUTPUT_DIRECTORY = doc/API
35
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
36
# 4096 sub-directories (in 2 levels) under the output directory of each output
37
# format and will distribute the generated files over these directories.
38
# Enabling this option can be useful when feeding doxygen a huge amount of
39
# source files, where putting all generated files in the same directory would
40
# otherwise cause performance problems for the file system.
35
44
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
36
45
# documentation generated by doxygen is written. Doxygen will use this
37
46
# information to generate all constant output in the proper language.
38
47
# The default language is English, other supported languages are:
39
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
40
# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
41
# (Japanese with English messages), Korean, Norwegian, Polish, Portuguese,
42
# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
48
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
49
# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
50
# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
51
# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
52
# Swedish, and Ukrainian.
44
54
OUTPUT_LANGUAGE = English
80
# This tag implements a quasi-intelligent brief description abbreviator
81
# that is used to form the text in various listings. Each string
82
# in this list, if found as the leading text of the brief description, will be
83
# stripped from the text and the result after processing the whole list, is
84
# used as the annotated text. Otherwise, the brief description is used as-is.
85
# If left blank, the following values are used ("$name" is automatically
86
# replaced with the name of the entity): "The $name class" "The $name widget"
87
# "The $name file" "is" "provides" "specifies" "contains"
88
# "represents" "a" "an" "the"
70
92
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
71
93
# Doxygen will generate a detailed section even if there is only a brief
74
96
ALWAYS_DETAILED_SEC = YES
76
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
77
# members of a class in the documentation of that class as if those members were
78
# ordinary class members. Constructors, destructors and assignment operators of
79
# the base classes will not be shown.
98
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
99
# inherited members of a class in the documentation of that class as if those
100
# members were ordinary class members. Constructors, destructors and assignment
101
# operators of the base classes will not be shown.
81
INLINE_INHERITED_MEMB = NO
103
INLINE_INHERITED_MEMB = YES
83
105
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
84
106
# path before files name in the file list and in the header files. If set
89
111
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
90
112
# can be used to strip a user-defined part of the path. Stripping is
91
113
# only done if one of the specified strings matches the left-hand part of
92
# the path. It is allowed to use relative paths in the argument list.
114
# the path. The tag can be used to show relative paths in the file list.
115
# If left blank the directory from which doxygen is run is used as the
120
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
121
# the path mentioned in the documentation of a class, which tells
122
# the reader which header file to include in order to use a class.
123
# If left blank only the name of the header file containing the class
124
# definition is used. Otherwise one should specify the include paths that
125
# are normally passed to the compiler using the -I flag.
127
STRIP_FROM_INC_PATH =
96
129
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
97
130
# (but less readable) file names. This can be useful is your file systems
98
131
# doesn't support long names like on DOS, Mac, or CD-ROM.
125
158
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
126
159
# member inherits the documentation from any documented member that it
129
162
INHERIT_DOCS = YES
131
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
132
# tag is set to YES, then doxygen will reuse the documentation of the first
133
# member in the group (if any) for the other members of the group. By default
134
# all members of a group must be documented explicitly.
164
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
165
# a new page for each member. If set to NO, the documentation of a member will
166
# be part of the file/class/namespace that contains it.
136
DISTRIBUTE_GROUP_DOC = NO
168
SEPARATE_MEMBER_PAGES = NO
138
170
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
139
171
# Doxygen uses this value to replace tabs by spaces in code fragments.
152
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
153
# only. Doxygen will then generate output that is more tailored for C.
184
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
185
# sources only. Doxygen will then generate output that is more tailored for C.
154
186
# For instance, some of the names that are used will be different. The list
155
187
# of all members will be omitted, etc.
157
189
OPTIMIZE_OUTPUT_FOR_C = NO
159
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
160
# only. Doxygen will then generate output that is more tailored for Java.
191
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
192
# sources only. Doxygen will then generate output that is more tailored for Java.
161
193
# For instance, namespaces will be presented as packages, qualified scopes
162
194
# will look different, etc.
164
196
OPTIMIZE_OUTPUT_JAVA = NO
198
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
199
# include (a tag file for) the STL sources as input, then you should
200
# set this tag to YES in order to let doxygen match functions declarations and
201
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
202
# func(std::string) {}). This also make the inheritance and collaboration
203
# diagrams that involve STL classes more complete and accurate.
205
BUILTIN_STL_SUPPORT = YES
207
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
208
# tag is set to YES, then doxygen will reuse the documentation of the first
209
# member in the group (if any) for the other members of the group. By default
210
# all members of a group must be documented explicitly.
212
DISTRIBUTE_GROUP_DOC = NO
166
214
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
167
215
# the same type (for instance a group of public functions) to be put as a
168
216
# subgroup of that type (e.g. under the Public Functions section). Set it to
199
247
EXTRACT_LOCAL_CLASSES = NO
249
# This flag is only useful for Objective-C code. When set to YES local
250
# methods, which are defined in the implementation section but not in
251
# the interface are included in the documentation.
252
# If set to NO (the default) only methods in the interface are included.
254
EXTRACT_LOCAL_METHODS = NO
201
256
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
202
257
# undocumented members of documented classes, files or namespaces.
203
258
# If set to NO (the default) these members will be included in the
264
319
# alphabetically by member name. If set to NO the members will appear in
265
320
# declaration order.
267
SORT_MEMBER_DOCS = YES
322
SORT_MEMBER_DOCS = NO
324
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
325
# brief documentation of file, namespace and class members alphabetically
326
# by member name. If set to NO (the default) the members will appear in
331
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
332
# sorted by fully-qualified names, including namespaces. If set to
333
# NO (the default), the class list will be sorted only by class name,
334
# not including the namespace part.
335
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
336
# Note: This option applies only to the class list, not to the
339
SORT_BY_SCOPE_NAME = NO
269
341
# The GENERATE_TODOLIST tag can be used to enable (YES) or
270
342
# disable (NO) the todo list. This list is created by putting \todo
312
384
SHOW_USED_FILES = YES
386
# If the sources in your project are distributed over multiple directories
387
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
388
# in the documentation. The default is YES.
390
SHOW_DIRECTORIES = YES
392
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
393
# doxygen should invoke to get the current version for each file (typically from the
394
# version control system). Doxygen will invoke the program by executing (via
395
# popen()) the command <command> <input-file>, where <command> is the value of
396
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
397
# provided by doxygen. Whatever the program writes to standard output
398
# is used as the file version. See the manual for examples.
400
FILE_VERSION_FILTER =
314
402
#---------------------------------------------------------------------------
315
403
# configuration options related to warning and progress messages
316
404
#---------------------------------------------------------------------------
340
428
WARN_IF_DOC_ERROR = YES
430
# This WARN_NO_PARAMDOC option can be abled to get warnings for
431
# functions that are documented, but have no documentation for their parameters
432
# or return value. If set to NO (the default) doxygen will only warn about
433
# wrong or incomplete parameter documentation, but not about the absence of
436
WARN_NO_PARAMDOC = NO
342
438
# The WARN_FORMAT tag determines the format of the warning messages that
343
439
# doxygen can produce. The string should contain the $file, $line, and $text
344
440
# tags, which will be replaced by the file and line number from which the
345
# warning originated and the warning text.
441
# warning originated and the warning text. Optionally the format may contain
442
# $version, which will be replaced by the version of the file (if it could
443
# be obtained via FILE_VERSION_FILTER)
347
445
WARN_FORMAT = "$file:$line: $text"
368
466
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
369
467
# and *.h) to filter out the source-files in the directories. If left
370
468
# blank the following patterns are tested:
371
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
372
# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
469
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
470
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
374
472
FILE_PATTERNS = *.h \
387
485
EXCLUDE = src/main.cpp \
389
487
src/newmain.cpp \
491
src/zipstreamimpl.h \
392
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
393
# that are symbolic links (a Unix filesystem feature) are excluded from the input.
494
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
495
# directories that are symbolic links (a Unix filesystem feature) are excluded
395
498
EXCLUDE_SYMLINKS = NO
397
500
# If the value of the INPUT tag contains directories, you can use the
398
501
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
399
# certain files from those directories.
502
# certain files from those directories. Note that the wildcards are matched
503
# against the file with absolute path, so to exclude all test directories
504
# for example use the pattern */test/*
401
506
EXCLUDE_PATTERNS =
431
536
# by executing (via popen()) the command <filter> <input-file>, where <filter>
432
537
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
433
538
# input file. Doxygen will then use the output that the filter program writes
434
# to standard output.
539
# to standard output. If FILTER_PATTERNS is specified, this tag will be
544
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
545
# basis. Doxygen will compare the file name with each pattern and apply the
546
# filter if there is a match. The filters are a list of the form:
547
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
548
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
549
# is applied to all files.
438
553
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
439
554
# INPUT_FILTER) will be used to filter the input files when producing source
440
555
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
446
561
#---------------------------------------------------------------------------
448
563
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
449
# be generated. Documented entities will be cross-referenced with these sources.
564
# be generated. Documented entities will be cross-referenced with these sources.
565
# Note: To get rid of all source code in the generated output, make sure also
566
# VERBATIM_HEADERS is set to NO.
451
568
SOURCE_BROWSER = NO
474
591
REFERENCES_RELATION = YES
593
# If the USE_HTAGS tag is set to YES then the references to source code
594
# will point to the HTML generated by the htags(1) tool instead of doxygen
595
# built-in source browser. The htags tool is part of GNU's global source
596
# tagging system (see http://www.gnu.org/software/global/global.html). You
597
# will need version 4.8.6 or higher.
476
601
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
477
602
# will generate a verbatim copy of the header file for each class for
478
603
# which an include is specified. Set to NO to disable this.
521
646
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
522
647
# doxygen will generate files with .html extension.
524
HTML_FILE_EXTENSION = .html
649
HTML_FILE_EXTENSION = .shtml
526
651
# The HTML_HEADER tag can be used to specify a personal HTML header for
527
652
# each generated HTML page. If it is left blank doxygen will generate a
528
653
# standard header.
655
HTML_HEADER = doc/api-header.html
532
657
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
533
658
# each generated HTML page. If it is left blank doxygen will generate a
534
659
# standard footer.
661
HTML_FOOTER = doc/api-footer.html
538
663
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
539
664
# style sheet that is used by each HTML page. It can be used to
540
665
# fine-tune the look of the HTML output. If the tag is left blank doxygen
541
# will generate a default style sheet
666
# will generate a default style sheet. Note that doxygen will try to copy
667
# the style sheet file to the HTML output directory, so don't put your own
668
# stylesheet in the HTML output directory as well, or it will be erased!
670
HTML_STYLESHEET = doc/api-style.css
545
672
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
546
673
# files or namespaces will be aligned in HTML using tables. If set to
916
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
917
# dump the program listings (including syntax highlighting
918
# and cross-referencing information) to the XML output. Note that
919
# enabling this will significantly increase the size of the XML output.
921
XML_PROGRAMLISTING = YES
791
923
#---------------------------------------------------------------------------
792
924
# configuration options for the AutoGen Definitions output
793
925
#---------------------------------------------------------------------------
848
980
# compilation will be performed. Macro expansion can be done in a controlled
849
981
# way by setting EXPAND_ONLY_PREDEF to YES.
983
MACRO_EXPANSION = YES
853
985
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
854
986
# then the macro expansion is limited to the macros specified with the
855
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
987
# PREDEFINED and EXPAND_AS_DEFINED tags.
857
EXPAND_ONLY_PREDEF = NO
989
EXPAND_ONLY_PREDEF = YES
859
991
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
860
992
# in the INCLUDE_PATH (see below) will be search if a #include is found.
878
1010
# are defined before the preprocessor is started (similar to the -D option of
879
1011
# gcc). The argument of the tag is a list of macros of the form: name
880
1012
# or name=definition (no spaces). If the definition and the = are
881
# omitted =1 is assumed.
1013
# omitted =1 is assumed. To prevent a macro definition from being
1014
# undefined via #undef or recursively expanded use the := operator
1015
# instead of the = operator.
1017
PREDEFINED = OBAPI:= \
885
1020
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
886
1021
# this tag can be used to specify a list of macro names that should be expanded.
892
1027
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
893
1028
# doxygen's preprocessor will remove all function-like macros that are alone
894
1029
# on a line, have an all uppercase name, and do not end with a semicolon. Such
895
# function macros are typically used for boiler-plate code, and will confuse the
896
# parser if not removed.
1030
# function macros are typically used for boiler-plate code, and will confuse
1031
# the parser if not removed.
898
1033
SKIP_FUNCTION_MACROS = YES
900
1035
#---------------------------------------------------------------------------
901
# Configuration::addtions related to external references
1036
# Configuration::additions related to external references
902
1037
#---------------------------------------------------------------------------
904
1039
# The TAGFILES option can be used to specify one or more tagfiles.
945
1080
#---------------------------------------------------------------------------
947
1082
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
948
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
949
# super classes. Setting the tag to NO turns the diagrams off. Note that this
950
# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
951
# recommended to install and use dot, since it yields more powerful graphs.
1083
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1084
# or super classes. Setting the tag to NO turns the diagrams off. Note that
1085
# this option is superseded by the HAVE_DOT option below. This is only a
1086
# fallback. It is recommended to install and use dot, since it yields more
953
1089
CLASS_DIAGRAMS = YES
977
1113
# indirect implementation dependencies (inheritance, containment, and
978
1114
# class references variables) of the class with other documented classes.
980
COLLABORATION_GRAPH = YES
1116
COLLABORATION_GRAPH = NO
1118
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1119
# will generate a graph for groups, showing the direct groups dependencies
982
1123
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
983
# collaboration diagrams in a style similiar to the OMG's Unified Modeling
1124
# collaboration diagrams in a style similar to the OMG's Unified Modeling
995
1136
# file showing the direct and indirect include dependencies of the file with
996
1137
# other documented files.
1000
1141
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1001
1142
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1002
1143
# documented header file showing the documented files that directly or
1003
1144
# indirectly include this file.
1005
INCLUDED_BY_GRAPH = YES
1146
INCLUDED_BY_GRAPH = NO
1007
1148
# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1008
1149
# generate a call dependency graph for every global function or class method.
1015
1156
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1016
1157
# will graphical hierarchy of all classes instead of a textual one.
1018
GRAPHICAL_HIERARCHY = YES
1159
GRAPHICAL_HIERARCHY = NO
1161
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1162
# then doxygen will show the dependencies a directory has on other directories
1163
# in a graphical way. The dependency relations are determined by the #include
1164
# relations between the files in the directories.
1166
DIRECTORY_GRAPH = NO
1020
1168
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1021
1169
# generated by dot. Possible values are png, jpg, or gif
1048
1196
# the specified constraint. Beware that most browsers cannot cope with very
1049
1197
# large images.
1051
MAX_DOT_GRAPH_HEIGHT = 1024
1199
MAX_DOT_GRAPH_HEIGHT = 512
1053
1201
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1054
1202
# graphs generated by dot. A depth value of 3 means that only nodes reachable
1055
# from the root by following a path via at most 3 edges will be shown. Nodes that
1056
# lay further from the root node will be omitted. Note that setting this option to
1057
# 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1058
# note that a graph may be further truncated if the graph's image dimensions are
1059
# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1060
# If 0 is used for the depth value (the default), the graph is not depth-constrained.
1203
# from the root by following a path via at most 3 edges will be shown. Nodes
1204
# that lay further from the root node will be omitted. Note that setting this
1205
# option to 1 or 2 may greatly reduce the computation time needed for large
1206
# code bases. Also note that a graph may be further truncated if the graph's
1207
# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
1208
# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
1209
# the graph is not depth-constrained.
1062
1211
MAX_DOT_GRAPH_DEPTH = 0
1213
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1214
# background. This is disabled by default, which results in a white background.
1215
# Warning: Depending on the platform used, enabling this option may lead to
1216
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1219
DOT_TRANSPARENT = NO
1221
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1222
# files in one run (i.e. multiple -o and -T options on the command line). This
1223
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1224
# support this, this feature is disabled by default.
1226
DOT_MULTI_TARGETS = YES
1064
1228
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1065
1229
# generate a legend page explaining the meaning of the various boxes and
1066
1230
# arrows in the dot generated graphs.
added
removed
Doxyfile
