1.1 --- a/doc/Doxyfile Tue Apr 05 06:41:21 2005 +0000
1.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
1.3 @@ -1,1234 +0,0 @@
1.4 -# Doxyfile 1.4.0
1.5 -
1.6 -# This file describes the settings to be used by the documentation system
1.7 -# doxygen (www.doxygen.org) for a project
1.8 -#
1.9 -# All text after a hash (#) is considered a comment and will be ignored
1.10 -# The format is:
1.11 -# TAG = value [value, ...]
1.12 -# For lists items can also be appended using:
1.13 -# TAG += value [value, ...]
1.14 -# Values that contain spaces should be placed between quotes (" ")
1.15 -
1.16 -#---------------------------------------------------------------------------
1.17 -# Project related configuration options
1.18 -#---------------------------------------------------------------------------
1.19 -
1.20 -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
1.21 -# by quotes) that should identify the project.
1.22 -
1.23 -PROJECT_NAME = LEMON
1.24 -
1.25 -# The PROJECT_NUMBER tag can be used to enter a project or revision number.
1.26 -# This could be handy for archiving the generated documentation or
1.27 -# if some version control system is used.
1.28 -
1.29 -PROJECT_NUMBER = 0.4
1.30 -
1.31 -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
1.32 -# base path where the generated documentation will be put.
1.33 -# If a relative path is entered, it will be relative to the location
1.34 -# where doxygen was started. If left blank the current directory will be used.
1.35 -
1.36 -OUTPUT_DIRECTORY =
1.37 -
1.38 -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
1.39 -# 4096 sub-directories (in 2 levels) under the output directory of each output
1.40 -# format and will distribute the generated files over these directories.
1.41 -# Enabling this option can be useful when feeding doxygen a huge amount of
1.42 -# source files, where putting all generated files in the same directory would
1.43 -# otherwise cause performance problems for the file system.
1.44 -
1.45 -CREATE_SUBDIRS = NO
1.46 -
1.47 -# The OUTPUT_LANGUAGE tag is used to specify the language in which all
1.48 -# documentation generated by doxygen is written. Doxygen will use this
1.49 -# information to generate all constant output in the proper language.
1.50 -# The default language is English, other supported languages are:
1.51 -# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
1.52 -# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
1.53 -# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
1.54 -# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
1.55 -# Swedish, and Ukrainian.
1.56 -
1.57 -OUTPUT_LANGUAGE = English
1.58 -
1.59 -# This tag can be used to specify the encoding used in the generated output.
1.60 -# The encoding is not always determined by the language that is chosen,
1.61 -# but also whether or not the output is meant for Windows or non-Windows users.
1.62 -# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
1.63 -# forces the Windows encoding (this is the default for the Windows binary),
1.64 -# whereas setting the tag to NO uses a Unix-style encoding (the default for
1.65 -# all platforms other than Windows).
1.66 -
1.67 -USE_WINDOWS_ENCODING = NO
1.68 -
1.69 -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
1.70 -# include brief member descriptions after the members that are listed in
1.71 -# the file and class documentation (similar to JavaDoc).
1.72 -# Set to NO to disable this.
1.73 -
1.74 -BRIEF_MEMBER_DESC = YES
1.75 -
1.76 -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
1.77 -# the brief description of a member or function before the detailed description.
1.78 -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
1.79 -# brief descriptions will be completely suppressed.
1.80 -
1.81 -REPEAT_BRIEF = NO
1.82 -
1.83 -# This tag implements a quasi-intelligent brief description abbreviator
1.84 -# that is used to form the text in various listings. Each string
1.85 -# in this list, if found as the leading text of the brief description, will be
1.86 -# stripped from the text and the result after processing the whole list, is
1.87 -# used as the annotated text. Otherwise, the brief description is used as-is.
1.88 -# If left blank, the following values are used ("$name" is automatically
1.89 -# replaced with the name of the entity): "The $name class" "The $name widget"
1.90 -# "The $name file" "is" "provides" "specifies" "contains"
1.91 -# "represents" "a" "an" "the"
1.92 -
1.93 -ABBREVIATE_BRIEF =
1.94 -
1.95 -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
1.96 -# Doxygen will generate a detailed section even if there is only a brief
1.97 -# description.
1.98 -
1.99 -ALWAYS_DETAILED_SEC = NO
1.100 -
1.101 -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
1.102 -# inherited members of a class in the documentation of that class as if those
1.103 -# members were ordinary class members. Constructors, destructors and assignment
1.104 -# operators of the base classes will not be shown.
1.105 -
1.106 -INLINE_INHERITED_MEMB = NO
1.107 -
1.108 -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
1.109 -# path before files name in the file list and in the header files. If set
1.110 -# to NO the shortest path that makes the file name unique will be used.
1.111 -
1.112 -FULL_PATH_NAMES = YES
1.113 -
1.114 -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
1.115 -# can be used to strip a user-defined part of the path. Stripping is
1.116 -# only done if one of the specified strings matches the left-hand part of
1.117 -# the path. The tag can be used to show relative paths in the file list.
1.118 -# If left blank the directory from which doxygen is run is used as the
1.119 -# path to strip.
1.120 -
1.121 -STRIP_FROM_PATH = ../src
1.122 -
1.123 -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
1.124 -# the path mentioned in the documentation of a class, which tells
1.125 -# the reader which header file to include in order to use a class.
1.126 -# If left blank only the name of the header file containing the class
1.127 -# definition is used. Otherwise one should specify the include paths that
1.128 -# are normally passed to the compiler using the -I flag.
1.129 -
1.130 -STRIP_FROM_INC_PATH = ../src
1.131 -
1.132 -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
1.133 -# (but less readable) file names. This can be useful is your file systems
1.134 -# doesn't support long names like on DOS, Mac, or CD-ROM.
1.135 -
1.136 -SHORT_NAMES = NO
1.137 -
1.138 -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
1.139 -# will interpret the first line (until the first dot) of a JavaDoc-style
1.140 -# comment as the brief description. If set to NO, the JavaDoc
1.141 -# comments will behave just like the Qt-style comments (thus requiring an
1.142 -# explicit @brief command for a brief description.
1.143 -
1.144 -JAVADOC_AUTOBRIEF = NO
1.145 -
1.146 -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
1.147 -# treat a multi-line C++ special comment block (i.e. a block of //! or ///
1.148 -# comments) as a brief description. This used to be the default behaviour.
1.149 -# The new default is to treat a multi-line C++ comment block as a detailed
1.150 -# description. Set this tag to YES if you prefer the old behaviour instead.
1.151 -
1.152 -MULTILINE_CPP_IS_BRIEF = NO
1.153 -
1.154 -# If the DETAILS_AT_TOP tag is set to YES then Doxygen
1.155 -# will output the detailed description near the top, like JavaDoc.
1.156 -# If set to NO, the detailed description appears after the member
1.157 -# documentation.
1.158 -
1.159 -DETAILS_AT_TOP = YES
1.160 -
1.161 -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
1.162 -# member inherits the documentation from any documented member that it
1.163 -# re-implements.
1.164 -
1.165 -INHERIT_DOCS = NO
1.166 -
1.167 -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
1.168 -# tag is set to YES, then doxygen will reuse the documentation of the first
1.169 -# member in the group (if any) for the other members of the group. By default
1.170 -# all members of a group must be documented explicitly.
1.171 -
1.172 -DISTRIBUTE_GROUP_DOC = NO
1.173 -
1.174 -# The TAB_SIZE tag can be used to set the number of spaces in a tab.
1.175 -# Doxygen uses this value to replace tabs by spaces in code fragments.
1.176 -
1.177 -TAB_SIZE = 8
1.178 -
1.179 -# This tag can be used to specify a number of aliases that acts
1.180 -# as commands in the documentation. An alias has the form "name=value".
1.181 -# For example adding "sideeffect=\par Side Effects:\n" will allow you to
1.182 -# put the command \sideeffect (or @sideeffect) in the documentation, which
1.183 -# will result in a user-defined paragraph with heading "Side Effects:".
1.184 -# You can put \n's in the value part of an alias to insert newlines.
1.185 -
1.186 -ALIASES =
1.187 -
1.188 -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
1.189 -# sources only. Doxygen will then generate output that is more tailored for C.
1.190 -# For instance, some of the names that are used will be different. The list
1.191 -# of all members will be omitted, etc.
1.192 -
1.193 -OPTIMIZE_OUTPUT_FOR_C = NO
1.194 -
1.195 -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
1.196 -# only. Doxygen will then generate output that is more tailored for Java.
1.197 -# For instance, namespaces will be presented as packages, qualified scopes
1.198 -# will look different, etc.
1.199 -
1.200 -OPTIMIZE_OUTPUT_JAVA = NO
1.201 -
1.202 -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
1.203 -# the same type (for instance a group of public functions) to be put as a
1.204 -# subgroup of that type (e.g. under the Public Functions section). Set it to
1.205 -# NO to prevent subgrouping. Alternatively, this can be done per class using
1.206 -# the \nosubgrouping command.
1.207 -
1.208 -SUBGROUPING = YES
1.209 -
1.210 -#---------------------------------------------------------------------------
1.211 -# Build related configuration options
1.212 -#---------------------------------------------------------------------------
1.213 -
1.214 -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
1.215 -# documentation are documented, even if no documentation was available.
1.216 -# Private class members and static file members will be hidden unless
1.217 -# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
1.218 -
1.219 -EXTRACT_ALL = NO
1.220 -
1.221 -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
1.222 -# will be included in the documentation.
1.223 -
1.224 -EXTRACT_PRIVATE = NO
1.225 -
1.226 -# If the EXTRACT_STATIC tag is set to YES all static members of a file
1.227 -# will be included in the documentation.
1.228 -
1.229 -EXTRACT_STATIC = NO
1.230 -
1.231 -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
1.232 -# defined locally in source files will be included in the documentation.
1.233 -# If set to NO only classes defined in header files are included.
1.234 -
1.235 -EXTRACT_LOCAL_CLASSES = YES
1.236 -
1.237 -# This flag is only useful for Objective-C code. When set to YES local
1.238 -# methods, which are defined in the implementation section but not in
1.239 -# the interface are included in the documentation.
1.240 -# If set to NO (the default) only methods in the interface are included.
1.241 -
1.242 -EXTRACT_LOCAL_METHODS = NO
1.243 -
1.244 -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
1.245 -# undocumented members of documented classes, files or namespaces.
1.246 -# If set to NO (the default) these members will be included in the
1.247 -# various overviews, but no documentation section is generated.
1.248 -# This option has no effect if EXTRACT_ALL is enabled.
1.249 -
1.250 -HIDE_UNDOC_MEMBERS = YES
1.251 -
1.252 -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
1.253 -# undocumented classes that are normally visible in the class hierarchy.
1.254 -# If set to NO (the default) these classes will be included in the various
1.255 -# overviews. This option has no effect if EXTRACT_ALL is enabled.
1.256 -
1.257 -HIDE_UNDOC_CLASSES = YES
1.258 -
1.259 -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
1.260 -# friend (class|struct|union) declarations.
1.261 -# If set to NO (the default) these declarations will be included in the
1.262 -# documentation.
1.263 -
1.264 -HIDE_FRIEND_COMPOUNDS = NO
1.265 -
1.266 -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
1.267 -# documentation blocks found inside the body of a function.
1.268 -# If set to NO (the default) these blocks will be appended to the
1.269 -# function's detailed documentation block.
1.270 -
1.271 -HIDE_IN_BODY_DOCS = NO
1.272 -
1.273 -# The INTERNAL_DOCS tag determines if documentation
1.274 -# that is typed after a \internal command is included. If the tag is set
1.275 -# to NO (the default) then the documentation will be excluded.
1.276 -# Set it to YES to include the internal documentation.
1.277 -
1.278 -INTERNAL_DOCS = NO
1.279 -
1.280 -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
1.281 -# file names in lower-case letters. If set to YES upper-case letters are also
1.282 -# allowed. This is useful if you have classes or files whose names only differ
1.283 -# in case and if your file system supports case sensitive file names. Windows
1.284 -# and Mac users are advised to set this option to NO.
1.285 -
1.286 -CASE_SENSE_NAMES = YES
1.287 -
1.288 -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
1.289 -# will show members with their full class and namespace scopes in the
1.290 -# documentation. If set to YES the scope will be hidden.
1.291 -
1.292 -HIDE_SCOPE_NAMES = YES
1.293 -
1.294 -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
1.295 -# will put a list of the files that are included by a file in the documentation
1.296 -# of that file.
1.297 -
1.298 -SHOW_INCLUDE_FILES = YES
1.299 -
1.300 -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
1.301 -# is inserted in the documentation for inline members.
1.302 -
1.303 -INLINE_INFO = YES
1.304 -
1.305 -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
1.306 -# will sort the (detailed) documentation of file and class members
1.307 -# alphabetically by member name. If set to NO the members will appear in
1.308 -# declaration order.
1.309 -
1.310 -SORT_MEMBER_DOCS = NO
1.311 -
1.312 -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
1.313 -# brief documentation of file, namespace and class members alphabetically
1.314 -# by member name. If set to NO (the default) the members will appear in
1.315 -# declaration order.
1.316 -
1.317 -SORT_BRIEF_DOCS = NO
1.318 -
1.319 -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
1.320 -# sorted by fully-qualified names, including namespaces. If set to
1.321 -# NO (the default), the class list will be sorted only by class name,
1.322 -# not including the namespace part.
1.323 -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
1.324 -# Note: This option applies only to the class list, not to the
1.325 -# alphabetical list.
1.326 -
1.327 -SORT_BY_SCOPE_NAME = NO
1.328 -
1.329 -# The GENERATE_TODOLIST tag can be used to enable (YES) or
1.330 -# disable (NO) the todo list. This list is created by putting \todo
1.331 -# commands in the documentation.
1.332 -
1.333 -GENERATE_TODOLIST = YES
1.334 -
1.335 -# The GENERATE_TESTLIST tag can be used to enable (YES) or
1.336 -# disable (NO) the test list. This list is created by putting \test
1.337 -# commands in the documentation.
1.338 -
1.339 -GENERATE_TESTLIST = YES
1.340 -
1.341 -# The GENERATE_BUGLIST tag can be used to enable (YES) or
1.342 -# disable (NO) the bug list. This list is created by putting \bug
1.343 -# commands in the documentation.
1.344 -
1.345 -GENERATE_BUGLIST = YES
1.346 -
1.347 -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
1.348 -# disable (NO) the deprecated list. This list is created by putting
1.349 -# \deprecated commands in the documentation.
1.350 -
1.351 -GENERATE_DEPRECATEDLIST= YES
1.352 -
1.353 -# The ENABLED_SECTIONS tag can be used to enable conditional
1.354 -# documentation sections, marked by \if sectionname ... \endif.
1.355 -
1.356 -ENABLED_SECTIONS =
1.357 -
1.358 -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
1.359 -# the initial value of a variable or define consists of for it to appear in
1.360 -# the documentation. If the initializer consists of more lines than specified
1.361 -# here it will be hidden. Use a value of 0 to hide initializers completely.
1.362 -# The appearance of the initializer of individual variables and defines in the
1.363 -# documentation can be controlled using \showinitializer or \hideinitializer
1.364 -# command in the documentation regardless of this setting.
1.365 -
1.366 -MAX_INITIALIZER_LINES = 5
1.367 -
1.368 -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
1.369 -# at the bottom of the documentation of classes and structs. If set to YES the
1.370 -# list will mention the files that were used to generate the documentation.
1.371 -
1.372 -SHOW_USED_FILES = YES
1.373 -
1.374 -# If the sources in your project are distributed over multiple directories
1.375 -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
1.376 -# in the documentation.
1.377 -
1.378 -SHOW_DIRECTORIES = YES
1.379 -
1.380 -# The FILE_VERSION_FILTER tag can be used to specify a program or script that
1.381 -# doxygen should invoke to get the current version for each file (typically from the
1.382 -# version control system). Doxygen will invoke the program by executing (via
1.383 -# popen()) the command <command> <input-file>, where <command> is the value of
1.384 -# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
1.385 -# provided by doxygen. Whatever the progam writes to standard output
1.386 -# is used as the file version. See the manual for examples.
1.387 -
1.388 -FILE_VERSION_FILTER =
1.389 -
1.390 -#---------------------------------------------------------------------------
1.391 -# configuration options related to warning and progress messages
1.392 -#---------------------------------------------------------------------------
1.393 -
1.394 -# The QUIET tag can be used to turn on/off the messages that are generated
1.395 -# by doxygen. Possible values are YES and NO. If left blank NO is used.
1.396 -
1.397 -QUIET = NO
1.398 -
1.399 -# The WARNINGS tag can be used to turn on/off the warning messages that are
1.400 -# generated by doxygen. Possible values are YES and NO. If left blank
1.401 -# NO is used.
1.402 -
1.403 -WARNINGS = YES
1.404 -
1.405 -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
1.406 -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
1.407 -# automatically be disabled.
1.408 -
1.409 -WARN_IF_UNDOCUMENTED = YES
1.410 -
1.411 -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
1.412 -# potential errors in the documentation, such as not documenting some
1.413 -# parameters in a documented function, or documenting parameters that
1.414 -# don't exist or using markup commands wrongly.
1.415 -
1.416 -WARN_IF_DOC_ERROR = YES
1.417 -
1.418 -# This WARN_NO_PARAMDOC option can be abled to get warnings for
1.419 -# functions that are documented, but have no documentation for their parameters
1.420 -# or return value. If set to NO (the default) doxygen will only warn about
1.421 -# wrong or incomplete parameter documentation, but not about the absence of
1.422 -# documentation.
1.423 -
1.424 -WARN_NO_PARAMDOC = NO
1.425 -
1.426 -# The WARN_FORMAT tag determines the format of the warning messages that
1.427 -# doxygen can produce. The string should contain the $file, $line, and $text
1.428 -# tags, which will be replaced by the file and line number from which the
1.429 -# warning originated and the warning text. Optionally the format may contain
1.430 -# $version, which will be replaced by the version of the file (if it could
1.431 -# be obtained via FILE_VERSION_FILTER)
1.432 -
1.433 -WARN_FORMAT = "$file:$line: $text"
1.434 -
1.435 -# The WARN_LOGFILE tag can be used to specify a file to which warning
1.436 -# and error messages should be written. If left blank the output is written
1.437 -# to stderr.
1.438 -
1.439 -WARN_LOGFILE = doxygen.log
1.440 -
1.441 -#---------------------------------------------------------------------------
1.442 -# configuration options related to the input files
1.443 -#---------------------------------------------------------------------------
1.444 -
1.445 -# The INPUT tag can be used to specify the files and/or directories that contain
1.446 -# documented source files. You may enter file names like "myfile.cpp" or
1.447 -# directories like "/usr/src/myproject". Separate the files or directories
1.448 -# with spaces.
1.449 -
1.450 -INPUT = mainpage.dox \
1.451 - getstart.dox \
1.452 - quicktour.dox \
1.453 - demoprograms.dox \
1.454 - graphs.dox \
1.455 - undir_graphs.dox \
1.456 - named-param.dox \
1.457 - maps.dox \
1.458 - coding_style.dox \
1.459 - groups.dox \
1.460 - namespaces.dox \
1.461 - license.dox \
1.462 - developers_interface.dox \
1.463 - graph_io.dox \
1.464 - dirs.dox \
1.465 - gwrappers.dox \
1.466 - ../src/lemon \
1.467 - ../src/lemon/concept \
1.468 - ../src/demo \
1.469 - ../src/test/test_tools.h
1.470 -
1.471 -# If the value of the INPUT tag contains directories, you can use the
1.472 -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
1.473 -# and *.h) to filter out the source-files in the directories. If left
1.474 -# blank the following patterns are tested:
1.475 -# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
1.476 -# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
1.477 -
1.478 -FILE_PATTERNS =
1.479 -
1.480 -# The RECURSIVE tag can be used to turn specify whether or not subdirectories
1.481 -# should be searched for input files as well. Possible values are YES and NO.
1.482 -# If left blank NO is used.
1.483 -
1.484 -RECURSIVE = NO
1.485 -
1.486 -# The EXCLUDE tag can be used to specify files and/or directories that should
1.487 -# excluded from the INPUT source files. This way you can easily exclude a
1.488 -# subdirectory from a directory tree whose root is specified with the INPUT tag.
1.489 -
1.490 -EXCLUDE =
1.491 -
1.492 -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
1.493 -# directories that are symbolic links (a Unix filesystem feature) are excluded
1.494 -# from the input.
1.495 -
1.496 -EXCLUDE_SYMLINKS = NO
1.497 -
1.498 -# If the value of the INPUT tag contains directories, you can use the
1.499 -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
1.500 -# certain files from those directories.
1.501 -
1.502 -EXCLUDE_PATTERNS =
1.503 -
1.504 -# The EXAMPLE_PATH tag can be used to specify one or more files or
1.505 -# directories that contain example code fragments that are included (see
1.506 -# the \include command).
1.507 -
1.508 -EXAMPLE_PATH = ../src/demo \
1.509 - ../LICENSE \
1.510 - .
1.511 -
1.512 -# If the value of the EXAMPLE_PATH tag contains directories, you can use the
1.513 -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
1.514 -# and *.h) to filter out the source-files in the directories. If left
1.515 -# blank all files are included.
1.516 -
1.517 -EXAMPLE_PATTERNS =
1.518 -
1.519 -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1.520 -# searched for input files to be used with the \include or \dontinclude
1.521 -# commands irrespective of the value of the RECURSIVE tag.
1.522 -# Possible values are YES and NO. If left blank NO is used.
1.523 -
1.524 -EXAMPLE_RECURSIVE = NO
1.525 -
1.526 -# The IMAGE_PATH tag can be used to specify one or more files or
1.527 -# directories that contain image that are included in the documentation (see
1.528 -# the \image command).
1.529 -
1.530 -IMAGE_PATH = images
1.531 -
1.532 -# The INPUT_FILTER tag can be used to specify a program that doxygen should
1.533 -# invoke to filter for each input file. Doxygen will invoke the filter program
1.534 -# by executing (via popen()) the command <filter> <input-file>, where <filter>
1.535 -# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
1.536 -# input file. Doxygen will then use the output that the filter program writes
1.537 -# to standard output. If FILTER_PATTERNS is specified, this tag will be
1.538 -# ignored.
1.539 -
1.540 -INPUT_FILTER =
1.541 -
1.542 -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1.543 -# basis. Doxygen will compare the file name with each pattern and apply the
1.544 -# filter if there is a match. The filters are a list of the form:
1.545 -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
1.546 -# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
1.547 -# is applied to all files.
1.548 -
1.549 -FILTER_PATTERNS =
1.550 -
1.551 -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1.552 -# INPUT_FILTER) will be used to filter the input files when producing source
1.553 -# files to browse (i.e. when SOURCE_BROWSER is set to YES).
1.554 -
1.555 -FILTER_SOURCE_FILES = NO
1.556 -
1.557 -#---------------------------------------------------------------------------
1.558 -# configuration options related to source browsing
1.559 -#---------------------------------------------------------------------------
1.560 -
1.561 -# If the SOURCE_BROWSER tag is set to YES then a list of source files will
1.562 -# be generated. Documented entities will be cross-referenced with these sources.
1.563 -# Note: To get rid of all source code in the generated output, make sure also
1.564 -# VERBATIM_HEADERS is set to NO.
1.565 -
1.566 -SOURCE_BROWSER = YES
1.567 -
1.568 -# Setting the INLINE_SOURCES tag to YES will include the body
1.569 -# of functions and classes directly in the documentation.
1.570 -
1.571 -INLINE_SOURCES = NO
1.572 -
1.573 -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
1.574 -# doxygen to hide any special comment blocks from generated source code
1.575 -# fragments. Normal C and C++ comments will always remain visible.
1.576 -
1.577 -STRIP_CODE_COMMENTS = YES
1.578 -
1.579 -# If the REFERENCED_BY_RELATION tag is set to YES (the default)
1.580 -# then for each documented function all documented
1.581 -# functions referencing it will be listed.
1.582 -
1.583 -REFERENCED_BY_RELATION = NO
1.584 -
1.585 -# If the REFERENCES_RELATION tag is set to YES (the default)
1.586 -# then for each documented function all documented entities
1.587 -# called/used by that function will be listed.
1.588 -
1.589 -REFERENCES_RELATION = NO
1.590 -
1.591 -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
1.592 -# will generate a verbatim copy of the header file for each class for
1.593 -# which an include is specified. Set to NO to disable this.
1.594 -
1.595 -VERBATIM_HEADERS = YES
1.596 -
1.597 -#---------------------------------------------------------------------------
1.598 -# configuration options related to the alphabetical class index
1.599 -#---------------------------------------------------------------------------
1.600 -
1.601 -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
1.602 -# of all compounds will be generated. Enable this if the project
1.603 -# contains a lot of classes, structs, unions or interfaces.
1.604 -
1.605 -ALPHABETICAL_INDEX = YES
1.606 -
1.607 -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
1.608 -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
1.609 -# in which this list will be split (can be a number in the range [1..20])
1.610 -
1.611 -COLS_IN_ALPHA_INDEX = 2
1.612 -
1.613 -# In case all classes in a project start with a common prefix, all
1.614 -# classes will be put under the same header in the alphabetical index.
1.615 -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
1.616 -# should be ignored while generating the index headers.
1.617 -
1.618 -IGNORE_PREFIX =
1.619 -
1.620 -#---------------------------------------------------------------------------
1.621 -# configuration options related to the HTML output
1.622 -#---------------------------------------------------------------------------
1.623 -
1.624 -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
1.625 -# generate HTML output.
1.626 -
1.627 -GENERATE_HTML = YES
1.628 -
1.629 -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
1.630 -# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1.631 -# put in front of it. If left blank `html' will be used as the default path.
1.632 -
1.633 -HTML_OUTPUT = html
1.634 -
1.635 -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
1.636 -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
1.637 -# doxygen will generate files with .html extension.
1.638 -
1.639 -HTML_FILE_EXTENSION = .html
1.640 -
1.641 -# The HTML_HEADER tag can be used to specify a personal HTML header for
1.642 -# each generated HTML page. If it is left blank doxygen will generate a
1.643 -# standard header.
1.644 -
1.645 -HTML_HEADER =
1.646 -
1.647 -# The HTML_FOOTER tag can be used to specify a personal HTML footer for
1.648 -# each generated HTML page. If it is left blank doxygen will generate a
1.649 -# standard footer.
1.650 -
1.651 -HTML_FOOTER =
1.652 -
1.653 -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
1.654 -# style sheet that is used by each HTML page. It can be used to
1.655 -# fine-tune the look of the HTML output. If the tag is left blank doxygen
1.656 -# will generate a default style sheet. Note that doxygen will try to copy
1.657 -# the style sheet file to the HTML output directory, so don't put your own
1.658 -# stylesheet in the HTML output directory as well, or it will be erased!
1.659 -
1.660 -HTML_STYLESHEET =
1.661 -
1.662 -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
1.663 -# files or namespaces will be aligned in HTML using tables. If set to
1.664 -# NO a bullet list will be used.
1.665 -
1.666 -HTML_ALIGN_MEMBERS = YES
1.667 -
1.668 -# If the GENERATE_HTMLHELP tag is set to YES, additional index files
1.669 -# will be generated that can be used as input for tools like the
1.670 -# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
1.671 -# of the generated HTML documentation.
1.672 -
1.673 -GENERATE_HTMLHELP = NO
1.674 -
1.675 -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1.676 -# be used to specify the file name of the resulting .chm file. You
1.677 -# can add a path in front of the file if the result should not be
1.678 -# written to the html output directory.
1.679 -
1.680 -CHM_FILE =
1.681 -
1.682 -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1.683 -# be used to specify the location (absolute path including file name) of
1.684 -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1.685 -# the HTML help compiler on the generated index.hhp.
1.686 -
1.687 -HHC_LOCATION =
1.688 -
1.689 -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1.690 -# controls if a separate .chi index file is generated (YES) or that
1.691 -# it should be included in the master .chm file (NO).
1.692 -
1.693 -GENERATE_CHI = NO
1.694 -
1.695 -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1.696 -# controls whether a binary table of contents is generated (YES) or a
1.697 -# normal table of contents (NO) in the .chm file.
1.698 -
1.699 -BINARY_TOC = NO
1.700 -
1.701 -# The TOC_EXPAND flag can be set to YES to add extra items for group members
1.702 -# to the contents of the HTML help documentation and to the tree view.
1.703 -
1.704 -TOC_EXPAND = NO
1.705 -
1.706 -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1.707 -# top of each HTML page. The value NO (the default) enables the index and
1.708 -# the value YES disables it.
1.709 -
1.710 -DISABLE_INDEX = NO
1.711 -
1.712 -# This tag can be used to set the number of enum values (range [1..20])
1.713 -# that doxygen will group on one line in the generated HTML documentation.
1.714 -
1.715 -ENUM_VALUES_PER_LINE = 4
1.716 -
1.717 -# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
1.718 -# generated containing a tree-like index structure (just like the one that
1.719 -# is generated for HTML Help). For this to work a browser that supports
1.720 -# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
1.721 -# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
1.722 -# probably better off using the HTML help feature.
1.723 -
1.724 -GENERATE_TREEVIEW = YES
1.725 -
1.726 -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1.727 -# used to set the initial width (in pixels) of the frame in which the tree
1.728 -# is shown.
1.729 -
1.730 -TREEVIEW_WIDTH = 250
1.731 -
1.732 -#---------------------------------------------------------------------------
1.733 -# configuration options related to the LaTeX output
1.734 -#---------------------------------------------------------------------------
1.735 -
1.736 -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1.737 -# generate Latex output.
1.738 -
1.739 -GENERATE_LATEX = NO
1.740 -
1.741 -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1.742 -# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1.743 -# put in front of it. If left blank `latex' will be used as the default path.
1.744 -
1.745 -LATEX_OUTPUT = latex
1.746 -
1.747 -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1.748 -# invoked. If left blank `latex' will be used as the default command name.
1.749 -
1.750 -LATEX_CMD_NAME = latex
1.751 -
1.752 -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1.753 -# generate index for LaTeX. If left blank `makeindex' will be used as the
1.754 -# default command name.
1.755 -
1.756 -MAKEINDEX_CMD_NAME = makeindex
1.757 -
1.758 -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1.759 -# LaTeX documents. This may be useful for small projects and may help to
1.760 -# save some trees in general.
1.761 -
1.762 -COMPACT_LATEX = YES
1.763 -
1.764 -# The PAPER_TYPE tag can be used to set the paper type that is used
1.765 -# by the printer. Possible values are: a4, a4wide, letter, legal and
1.766 -# executive. If left blank a4wide will be used.
1.767 -
1.768 -PAPER_TYPE = a4wide
1.769 -
1.770 -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1.771 -# packages that should be included in the LaTeX output.
1.772 -
1.773 -EXTRA_PACKAGES = amsmath \
1.774 - amssymb
1.775 -
1.776 -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1.777 -# the generated latex document. The header should contain everything until
1.778 -# the first chapter. If it is left blank doxygen will generate a
1.779 -# standard header. Notice: only use this tag if you know what you are doing!
1.780 -
1.781 -LATEX_HEADER =
1.782 -
1.783 -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1.784 -# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1.785 -# contain links (just like the HTML output) instead of page references
1.786 -# This makes the output suitable for online browsing using a pdf viewer.
1.787 -
1.788 -PDF_HYPERLINKS = YES
1.789 -
1.790 -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1.791 -# plain latex in the generated Makefile. Set this option to YES to get a
1.792 -# higher quality PDF documentation.
1.793 -
1.794 -USE_PDFLATEX = YES
1.795 -
1.796 -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1.797 -# command to the generated LaTeX files. This will instruct LaTeX to keep
1.798 -# running if errors occur, instead of asking the user for help.
1.799 -# This option is also used when generating formulas in HTML.
1.800 -
1.801 -LATEX_BATCHMODE = NO
1.802 -
1.803 -# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1.804 -# include the index chapters (such as File Index, Compound Index, etc.)
1.805 -# in the output.
1.806 -
1.807 -LATEX_HIDE_INDICES = NO
1.808 -
1.809 -#---------------------------------------------------------------------------
1.810 -# configuration options related to the RTF output
1.811 -#---------------------------------------------------------------------------
1.812 -
1.813 -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1.814 -# The RTF output is optimized for Word 97 and may not look very pretty with
1.815 -# other RTF readers or editors.
1.816 -
1.817 -GENERATE_RTF = NO
1.818 -
1.819 -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1.820 -# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1.821 -# put in front of it. If left blank `rtf' will be used as the default path.
1.822 -
1.823 -RTF_OUTPUT = rtf
1.824 -
1.825 -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1.826 -# RTF documents. This may be useful for small projects and may help to
1.827 -# save some trees in general.
1.828 -
1.829 -COMPACT_RTF = NO
1.830 -
1.831 -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1.832 -# will contain hyperlink fields. The RTF file will
1.833 -# contain links (just like the HTML output) instead of page references.
1.834 -# This makes the output suitable for online browsing using WORD or other
1.835 -# programs which support those fields.
1.836 -# Note: wordpad (write) and others do not support links.
1.837 -
1.838 -RTF_HYPERLINKS = NO
1.839 -
1.840 -# Load stylesheet definitions from file. Syntax is similar to doxygen's
1.841 -# config file, i.e. a series of assignments. You only have to provide
1.842 -# replacements, missing definitions are set to their default value.
1.843 -
1.844 -RTF_STYLESHEET_FILE =
1.845 -
1.846 -# Set optional variables used in the generation of an rtf document.
1.847 -# Syntax is similar to doxygen's config file.
1.848 -
1.849 -RTF_EXTENSIONS_FILE =
1.850 -
1.851 -#---------------------------------------------------------------------------
1.852 -# configuration options related to the man page output
1.853 -#---------------------------------------------------------------------------
1.854 -
1.855 -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1.856 -# generate man pages
1.857 -
1.858 -GENERATE_MAN = NO
1.859 -
1.860 -# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1.861 -# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1.862 -# put in front of it. If left blank `man' will be used as the default path.
1.863 -
1.864 -MAN_OUTPUT = man
1.865 -
1.866 -# The MAN_EXTENSION tag determines the extension that is added to
1.867 -# the generated man pages (default is the subroutine's section .3)
1.868 -
1.869 -MAN_EXTENSION = .3
1.870 -
1.871 -# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1.872 -# then it will generate one additional man file for each entity
1.873 -# documented in the real man page(s). These additional files
1.874 -# only source the real man page, but without them the man command
1.875 -# would be unable to find the correct page. The default is NO.
1.876 -
1.877 -MAN_LINKS = NO
1.878 -
1.879 -#---------------------------------------------------------------------------
1.880 -# configuration options related to the XML output
1.881 -#---------------------------------------------------------------------------
1.882 -
1.883 -# If the GENERATE_XML tag is set to YES Doxygen will
1.884 -# generate an XML file that captures the structure of
1.885 -# the code including all documentation.
1.886 -
1.887 -GENERATE_XML = NO
1.888 -
1.889 -# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1.890 -# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1.891 -# put in front of it. If left blank `xml' will be used as the default path.
1.892 -
1.893 -XML_OUTPUT = xml
1.894 -
1.895 -# The XML_SCHEMA tag can be used to specify an XML schema,
1.896 -# which can be used by a validating XML parser to check the
1.897 -# syntax of the XML files.
1.898 -
1.899 -XML_SCHEMA =
1.900 -
1.901 -# The XML_DTD tag can be used to specify an XML DTD,
1.902 -# which can be used by a validating XML parser to check the
1.903 -# syntax of the XML files.
1.904 -
1.905 -XML_DTD =
1.906 -
1.907 -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1.908 -# dump the program listings (including syntax highlighting
1.909 -# and cross-referencing information) to the XML output. Note that
1.910 -# enabling this will significantly increase the size of the XML output.
1.911 -
1.912 -XML_PROGRAMLISTING = YES
1.913 -
1.914 -#---------------------------------------------------------------------------
1.915 -# configuration options for the AutoGen Definitions output
1.916 -#---------------------------------------------------------------------------
1.917 -
1.918 -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1.919 -# generate an AutoGen Definitions (see autogen.sf.net) file
1.920 -# that captures the structure of the code including all
1.921 -# documentation. Note that this feature is still experimental
1.922 -# and incomplete at the moment.
1.923 -
1.924 -GENERATE_AUTOGEN_DEF = NO
1.925 -
1.926 -#---------------------------------------------------------------------------
1.927 -# configuration options related to the Perl module output
1.928 -#---------------------------------------------------------------------------
1.929 -
1.930 -# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1.931 -# generate a Perl module file that captures the structure of
1.932 -# the code including all documentation. Note that this
1.933 -# feature is still experimental and incomplete at the
1.934 -# moment.
1.935 -
1.936 -GENERATE_PERLMOD = NO
1.937 -
1.938 -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1.939 -# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1.940 -# to generate PDF and DVI output from the Perl module output.
1.941 -
1.942 -PERLMOD_LATEX = NO
1.943 -
1.944 -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1.945 -# nicely formatted so it can be parsed by a human reader. This is useful
1.946 -# if you want to understand what is going on. On the other hand, if this
1.947 -# tag is set to NO the size of the Perl module output will be much smaller
1.948 -# and Perl will parse it just the same.
1.949 -
1.950 -PERLMOD_PRETTY = YES
1.951 -
1.952 -# The names of the make variables in the generated doxyrules.make file
1.953 -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1.954 -# This is useful so different doxyrules.make files included by the same
1.955 -# Makefile don't overwrite each other's variables.
1.956 -
1.957 -PERLMOD_MAKEVAR_PREFIX =
1.958 -
1.959 -#---------------------------------------------------------------------------
1.960 -# Configuration options related to the preprocessor
1.961 -#---------------------------------------------------------------------------
1.962 -
1.963 -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1.964 -# evaluate all C-preprocessor directives found in the sources and include
1.965 -# files.
1.966 -
1.967 -ENABLE_PREPROCESSING = YES
1.968 -
1.969 -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1.970 -# names in the source code. If set to NO (the default) only conditional
1.971 -# compilation will be performed. Macro expansion can be done in a controlled
1.972 -# way by setting EXPAND_ONLY_PREDEF to YES.
1.973 -
1.974 -MACRO_EXPANSION = NO
1.975 -
1.976 -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1.977 -# then the macro expansion is limited to the macros specified with the
1.978 -# PREDEFINED and EXPAND_AS_PREDEFINED tags.
1.979 -
1.980 -EXPAND_ONLY_PREDEF = NO
1.981 -
1.982 -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1.983 -# in the INCLUDE_PATH (see below) will be search if a #include is found.
1.984 -
1.985 -SEARCH_INCLUDES = YES
1.986 -
1.987 -# The INCLUDE_PATH tag can be used to specify one or more directories that
1.988 -# contain include files that are not input files but should be processed by
1.989 -# the preprocessor.
1.990 -
1.991 -INCLUDE_PATH =
1.992 -
1.993 -# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1.994 -# patterns (like *.h and *.hpp) to filter out the header-files in the
1.995 -# directories. If left blank, the patterns specified with FILE_PATTERNS will
1.996 -# be used.
1.997 -
1.998 -INCLUDE_FILE_PATTERNS =
1.999 -
1.1000 -# The PREDEFINED tag can be used to specify one or more macro names that
1.1001 -# are defined before the preprocessor is started (similar to the -D option of
1.1002 -# gcc). The argument of the tag is a list of macros of the form: name
1.1003 -# or name=definition (no spaces). If the definition and the = are
1.1004 -# omitted =1 is assumed. To prevent a macro definition from being
1.1005 -# undefined via #undef or recursively expanded use the := operator
1.1006 -# instead of the = operator.
1.1007 -
1.1008 -PREDEFINED = DOXYGEN
1.1009 -
1.1010 -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1.1011 -# this tag can be used to specify a list of macro names that should be expanded.
1.1012 -# The macro definition that is found in the sources will be used.
1.1013 -# Use the PREDEFINED tag if you want to use a different macro definition.
1.1014 -
1.1015 -EXPAND_AS_DEFINED =
1.1016 -
1.1017 -# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1.1018 -# doxygen's preprocessor will remove all function-like macros that are alone
1.1019 -# on a line, have an all uppercase name, and do not end with a semicolon. Such
1.1020 -# function macros are typically used for boiler-plate code, and will confuse
1.1021 -# the parser if not removed.
1.1022 -
1.1023 -SKIP_FUNCTION_MACROS = YES
1.1024 -
1.1025 -#---------------------------------------------------------------------------
1.1026 -# Configuration::additions related to external references
1.1027 -#---------------------------------------------------------------------------
1.1028 -
1.1029 -# The TAGFILES option can be used to specify one or more tagfiles.
1.1030 -# Optionally an initial location of the external documentation
1.1031 -# can be added for each tagfile. The format of a tag file without
1.1032 -# this location is as follows:
1.1033 -# TAGFILES = file1 file2 ...
1.1034 -# Adding location for the tag files is done as follows:
1.1035 -# TAGFILES = file1=loc1 "file2 = loc2" ...
1.1036 -# where "loc1" and "loc2" can be relative or absolute paths or
1.1037 -# URLs. If a location is present for each tag, the installdox tool
1.1038 -# does not have to be run to correct the links.
1.1039 -# Note that each tag file must have a unique name
1.1040 -# (where the name does NOT include the path)
1.1041 -# If a tag file is not located in the directory in which doxygen
1.1042 -# is run, you must also specify the path to the tagfile here.
1.1043 -
1.1044 -TAGFILES =
1.1045 -
1.1046 -# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1.1047 -# a tag file that is based on the input files it reads.
1.1048 -
1.1049 -GENERATE_TAGFILE =
1.1050 -
1.1051 -# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1.1052 -# in the class index. If set to NO only the inherited external classes
1.1053 -# will be listed.
1.1054 -
1.1055 -ALLEXTERNALS = NO
1.1056 -
1.1057 -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1.1058 -# in the modules index. If set to NO, only the current project's groups will
1.1059 -# be listed.
1.1060 -
1.1061 -EXTERNAL_GROUPS = YES
1.1062 -
1.1063 -# The PERL_PATH should be the absolute path and name of the perl script
1.1064 -# interpreter (i.e. the result of `which perl').
1.1065 -
1.1066 -PERL_PATH = /usr/bin/perl
1.1067 -
1.1068 -#---------------------------------------------------------------------------
1.1069 -# Configuration options related to the dot tool
1.1070 -#---------------------------------------------------------------------------
1.1071 -
1.1072 -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1.1073 -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1.1074 -# or super classes. Setting the tag to NO turns the diagrams off. Note that
1.1075 -# this option is superseded by the HAVE_DOT option below. This is only a
1.1076 -# fallback. It is recommended to install and use dot, since it yields more
1.1077 -# powerful graphs.
1.1078 -
1.1079 -CLASS_DIAGRAMS = YES
1.1080 -
1.1081 -# If set to YES, the inheritance and collaboration graphs will hide
1.1082 -# inheritance and usage relations if the target is undocumented
1.1083 -# or is not a class.
1.1084 -
1.1085 -HIDE_UNDOC_RELATIONS = NO
1.1086 -
1.1087 -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1.1088 -# available from the path. This tool is part of Graphviz, a graph visualization
1.1089 -# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1.1090 -# have no effect if this option is set to NO (the default)
1.1091 -
1.1092 -HAVE_DOT = YES
1.1093 -
1.1094 -# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1.1095 -# will generate a graph for each documented class showing the direct and
1.1096 -# indirect inheritance relations. Setting this tag to YES will force the
1.1097 -# the CLASS_DIAGRAMS tag to NO.
1.1098 -
1.1099 -CLASS_GRAPH = YES
1.1100 -
1.1101 -# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1.1102 -# will generate a graph for each documented class showing the direct and
1.1103 -# indirect implementation dependencies (inheritance, containment, and
1.1104 -# class references variables) of the class with other documented classes.
1.1105 -
1.1106 -COLLABORATION_GRAPH = YES
1.1107 -
1.1108 -# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1.1109 -# will generate a graph for groups, showing the direct groups dependencies
1.1110 -
1.1111 -GROUP_GRAPHS = YES
1.1112 -
1.1113 -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1.1114 -# collaboration diagrams in a style similar to the OMG's Unified Modeling
1.1115 -# Language.
1.1116 -
1.1117 -UML_LOOK = NO
1.1118 -
1.1119 -# If set to YES, the inheritance and collaboration graphs will show the
1.1120 -# relations between templates and their instances.
1.1121 -
1.1122 -TEMPLATE_RELATIONS = YES
1.1123 -
1.1124 -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1.1125 -# tags are set to YES then doxygen will generate a graph for each documented
1.1126 -# file showing the direct and indirect include dependencies of the file with
1.1127 -# other documented files.
1.1128 -
1.1129 -INCLUDE_GRAPH = YES
1.1130 -
1.1131 -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1.1132 -# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1.1133 -# documented header file showing the documented files that directly or
1.1134 -# indirectly include this file.
1.1135 -
1.1136 -INCLUDED_BY_GRAPH = YES
1.1137 -
1.1138 -# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1.1139 -# generate a call dependency graph for every global function or class method.
1.1140 -# Note that enabling this option will significantly increase the time of a run.
1.1141 -# So in most cases it will be better to enable call graphs for selected
1.1142 -# functions only using the \callgraph command.
1.1143 -
1.1144 -CALL_GRAPH = YES
1.1145 -
1.1146 -# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1.1147 -# will graphical hierarchy of all classes instead of a textual one.
1.1148 -
1.1149 -GRAPHICAL_HIERARCHY = YES
1.1150 -
1.1151 -# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1.1152 -# then doxygen will show the dependencies a directory has on other directories
1.1153 -# in a graphical way. The dependency relations are determined by the #include
1.1154 -# relations between the files in the directories.
1.1155 -
1.1156 -DIRECTORY_GRAPH = YES
1.1157 -
1.1158 -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1.1159 -# generated by dot. Possible values are png, jpg, or gif
1.1160 -# If left blank png will be used.
1.1161 -
1.1162 -DOT_IMAGE_FORMAT = png
1.1163 -
1.1164 -# The tag DOT_PATH can be used to specify the path where the dot tool can be
1.1165 -# found. If left blank, it is assumed the dot tool can be found on the path.
1.1166 -
1.1167 -DOT_PATH =
1.1168 -
1.1169 -# The DOTFILE_DIRS tag can be used to specify one or more directories that
1.1170 -# contain dot files that are included in the documentation (see the
1.1171 -# \dotfile command).
1.1172 -
1.1173 -DOTFILE_DIRS =
1.1174 -
1.1175 -# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1.1176 -# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1.1177 -# this value, doxygen will try to truncate the graph, so that it fits within
1.1178 -# the specified constraint. Beware that most browsers cannot cope with very
1.1179 -# large images.
1.1180 -
1.1181 -MAX_DOT_GRAPH_WIDTH = 1024
1.1182 -
1.1183 -# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1.1184 -# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1.1185 -# this value, doxygen will try to truncate the graph, so that it fits within
1.1186 -# the specified constraint. Beware that most browsers cannot cope with very
1.1187 -# large images.
1.1188 -
1.1189 -MAX_DOT_GRAPH_HEIGHT = 1024
1.1190 -
1.1191 -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1.1192 -# graphs generated by dot. A depth value of 3 means that only nodes reachable
1.1193 -# from the root by following a path via at most 3 edges will be shown. Nodes
1.1194 -# that lay further from the root node will be omitted. Note that setting this
1.1195 -# option to 1 or 2 may greatly reduce the computation time needed for large
1.1196 -# code bases. Also note that a graph may be further truncated if the graph's
1.1197 -# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
1.1198 -# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
1.1199 -# the graph is not depth-constrained.
1.1200 -
1.1201 -MAX_DOT_GRAPH_DEPTH = 0
1.1202 -
1.1203 -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1.1204 -# background. This is disabled by default, which results in a white background.
1.1205 -# Warning: Depending on the platform used, enabling this option may lead to
1.1206 -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1.1207 -# read).
1.1208 -
1.1209 -DOT_TRANSPARENT = NO
1.1210 -
1.1211 -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1.1212 -# files in one run (i.e. multiple -o and -T options on the command line). This
1.1213 -# makes dot run faster, but since only newer versions of dot (>1.8.10)
1.1214 -# support this, this feature is disabled by default.
1.1215 -
1.1216 -DOT_MULTI_TARGETS = NO
1.1217 -
1.1218 -# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1.1219 -# generate a legend page explaining the meaning of the various boxes and
1.1220 -# arrows in the dot generated graphs.
1.1221 -
1.1222 -GENERATE_LEGEND = YES
1.1223 -
1.1224 -# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1.1225 -# remove the intermediate dot files that are used to generate
1.1226 -# the various graphs.
1.1227 -
1.1228 -DOT_CLEANUP = YES
1.1229 -
1.1230 -#---------------------------------------------------------------------------
1.1231 -# Configuration::additions related to the search engine
1.1232 -#---------------------------------------------------------------------------
1.1233 -
1.1234 -# The SEARCHENGINE tag specifies whether or not a search engine should be
1.1235 -# used. If set to NO the values of all tags below this one will be ignored.
1.1236 -
1.1237 -SEARCHENGINE = NO