From now on 'work in progress' files are not in /doc/Doxyfile.
The new src/work/Doxyfile containes these as well.
1.1 --- a/doc/Doxyfile Sat May 08 08:18:44 2004 +0000
1.2 +++ b/doc/Doxyfile Sat May 08 15:56:00 2004 +0000
1.3 @@ -396,9 +396,6 @@
1.4 groups.dox \
1.5 ../src/hugo \
1.6 ../src/hugo/skeletons \
1.7 - ../src/work/athos/minlengthpaths.h \
1.8 - ../src/work/klao/path.h \
1.9 - ../src/work/jacint/max_flow.h \
1.10 ../src/test/test_tools.h
1.11
1.12 # If the value of the INPUT tag contains directories, you can use the
2.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
2.2 +++ b/src/work/Doxyfile Sat May 08 15:56:00 2004 +0000
2.3 @@ -0,0 +1,1123 @@
2.4 +# Doxyfile 1.3.6
2.5 +
2.6 +# This file describes the settings to be used by the documentation system
2.7 +# doxygen (www.doxygen.org) for a project
2.8 +#
2.9 +# All text after a hash (#) is considered a comment and will be ignored
2.10 +# The format is:
2.11 +# TAG = value [value, ...]
2.12 +# For lists items can also be appended using:
2.13 +# TAG += value [value, ...]
2.14 +# Values that contain spaces should be placed between quotes (" ")
2.15 +
2.16 +#---------------------------------------------------------------------------
2.17 +# Project related configuration options
2.18 +#---------------------------------------------------------------------------
2.19 +
2.20 +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
2.21 +# by quotes) that should identify the project.
2.22 +
2.23 +PROJECT_NAME = HugoLib
2.24 +
2.25 +# The PROJECT_NUMBER tag can be used to enter a project or revision number.
2.26 +# This could be handy for archiving the generated documentation or
2.27 +# if some version control system is used.
2.28 +
2.29 +PROJECT_NUMBER = 0.1
2.30 +
2.31 +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
2.32 +# base path where the generated documentation will be put.
2.33 +# If a relative path is entered, it will be relative to the location
2.34 +# where doxygen was started. If left blank the current directory will be used.
2.35 +
2.36 +OUTPUT_DIRECTORY =
2.37 +
2.38 +# The OUTPUT_LANGUAGE tag is used to specify the language in which all
2.39 +# documentation generated by doxygen is written. Doxygen will use this
2.40 +# information to generate all constant output in the proper language.
2.41 +# The default language is English, other supported languages are:
2.42 +# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
2.43 +# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
2.44 +# (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese,
2.45 +# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
2.46 +
2.47 +OUTPUT_LANGUAGE = English
2.48 +
2.49 +# This tag can be used to specify the encoding used in the generated output.
2.50 +# The encoding is not always determined by the language that is chosen,
2.51 +# but also whether or not the output is meant for Windows or non-Windows users.
2.52 +# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
2.53 +# forces the Windows encoding (this is the default for the Windows binary),
2.54 +# whereas setting the tag to NO uses a Unix-style encoding (the default for
2.55 +# all platforms other than Windows).
2.56 +
2.57 +USE_WINDOWS_ENCODING = NO
2.58 +
2.59 +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
2.60 +# include brief member descriptions after the members that are listed in
2.61 +# the file and class documentation (similar to JavaDoc).
2.62 +# Set to NO to disable this.
2.63 +
2.64 +BRIEF_MEMBER_DESC = YES
2.65 +
2.66 +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
2.67 +# the brief description of a member or function before the detailed description.
2.68 +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
2.69 +# brief descriptions will be completely suppressed.
2.70 +
2.71 +REPEAT_BRIEF = NO
2.72 +
2.73 +# This tag implements a quasi-intelligent brief description abbreviator
2.74 +# that is used to form the text in various listings. Each string
2.75 +# in this list, if found as the leading text of the brief description, will be
2.76 +# stripped from the text and the result after processing the whole list, is used
2.77 +# as the annotated text. Otherwise, the brief description is used as-is. If left
2.78 +# blank, the following values are used ("$name" is automatically replaced with the
2.79 +# name of the entity): "The $name class" "The $name widget" "The $name file"
2.80 +# "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
2.81 +
2.82 +ABBREVIATE_BRIEF =
2.83 +
2.84 +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
2.85 +# Doxygen will generate a detailed section even if there is only a brief
2.86 +# description.
2.87 +
2.88 +ALWAYS_DETAILED_SEC = NO
2.89 +
2.90 +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
2.91 +# members of a class in the documentation of that class as if those members were
2.92 +# ordinary class members. Constructors, destructors and assignment operators of
2.93 +# the base classes will not be shown.
2.94 +
2.95 +INLINE_INHERITED_MEMB = NO
2.96 +
2.97 +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
2.98 +# path before files name in the file list and in the header files. If set
2.99 +# to NO the shortest path that makes the file name unique will be used.
2.100 +
2.101 +FULL_PATH_NAMES = NO
2.102 +
2.103 +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
2.104 +# can be used to strip a user-defined part of the path. Stripping is
2.105 +# only done if one of the specified strings matches the left-hand part of
2.106 +# the path. It is allowed to use relative paths in the argument list.
2.107 +# If left blank the directory from which doxygen is run is used as the
2.108 +# path to strip.
2.109 +
2.110 +STRIP_FROM_PATH =
2.111 +
2.112 +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
2.113 +# (but less readable) file names. This can be useful is your file systems
2.114 +# doesn't support long names like on DOS, Mac, or CD-ROM.
2.115 +
2.116 +SHORT_NAMES = NO
2.117 +
2.118 +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
2.119 +# will interpret the first line (until the first dot) of a JavaDoc-style
2.120 +# comment as the brief description. If set to NO, the JavaDoc
2.121 +# comments will behave just like the Qt-style comments (thus requiring an
2.122 +# explicit @brief command for a brief description.
2.123 +
2.124 +JAVADOC_AUTOBRIEF = NO
2.125 +
2.126 +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
2.127 +# treat a multi-line C++ special comment block (i.e. a block of //! or ///
2.128 +# comments) as a brief description. This used to be the default behaviour.
2.129 +# The new default is to treat a multi-line C++ comment block as a detailed
2.130 +# description. Set this tag to YES if you prefer the old behaviour instead.
2.131 +
2.132 +MULTILINE_CPP_IS_BRIEF = NO
2.133 +
2.134 +# If the DETAILS_AT_TOP tag is set to YES then Doxygen
2.135 +# will output the detailed description near the top, like JavaDoc.
2.136 +# If set to NO, the detailed description appears after the member
2.137 +# documentation.
2.138 +
2.139 +DETAILS_AT_TOP = YES
2.140 +
2.141 +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
2.142 +# member inherits the documentation from any documented member that it
2.143 +# re-implements.
2.144 +
2.145 +INHERIT_DOCS = NO
2.146 +
2.147 +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
2.148 +# tag is set to YES, then doxygen will reuse the documentation of the first
2.149 +# member in the group (if any) for the other members of the group. By default
2.150 +# all members of a group must be documented explicitly.
2.151 +
2.152 +DISTRIBUTE_GROUP_DOC = NO
2.153 +
2.154 +# The TAB_SIZE tag can be used to set the number of spaces in a tab.
2.155 +# Doxygen uses this value to replace tabs by spaces in code fragments.
2.156 +
2.157 +TAB_SIZE = 8
2.158 +
2.159 +# This tag can be used to specify a number of aliases that acts
2.160 +# as commands in the documentation. An alias has the form "name=value".
2.161 +# For example adding "sideeffect=\par Side Effects:\n" will allow you to
2.162 +# put the command \sideeffect (or @sideeffect) in the documentation, which
2.163 +# will result in a user-defined paragraph with heading "Side Effects:".
2.164 +# You can put \n's in the value part of an alias to insert newlines.
2.165 +
2.166 +ALIASES =
2.167 +
2.168 +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
2.169 +# only. Doxygen will then generate output that is more tailored for C.
2.170 +# For instance, some of the names that are used will be different. The list
2.171 +# of all members will be omitted, etc.
2.172 +
2.173 +OPTIMIZE_OUTPUT_FOR_C = NO
2.174 +
2.175 +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
2.176 +# only. Doxygen will then generate output that is more tailored for Java.
2.177 +# For instance, namespaces will be presented as packages, qualified scopes
2.178 +# will look different, etc.
2.179 +
2.180 +OPTIMIZE_OUTPUT_JAVA = NO
2.181 +
2.182 +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
2.183 +# the same type (for instance a group of public functions) to be put as a
2.184 +# subgroup of that type (e.g. under the Public Functions section). Set it to
2.185 +# NO to prevent subgrouping. Alternatively, this can be done per class using
2.186 +# the \nosubgrouping command.
2.187 +
2.188 +SUBGROUPING = YES
2.189 +
2.190 +#---------------------------------------------------------------------------
2.191 +# Build related configuration options
2.192 +#---------------------------------------------------------------------------
2.193 +
2.194 +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
2.195 +# documentation are documented, even if no documentation was available.
2.196 +# Private class members and static file members will be hidden unless
2.197 +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
2.198 +
2.199 +EXTRACT_ALL = NO
2.200 +
2.201 +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
2.202 +# will be included in the documentation.
2.203 +
2.204 +EXTRACT_PRIVATE = NO
2.205 +
2.206 +# If the EXTRACT_STATIC tag is set to YES all static members of a file
2.207 +# will be included in the documentation.
2.208 +
2.209 +EXTRACT_STATIC = NO
2.210 +
2.211 +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
2.212 +# defined locally in source files will be included in the documentation.
2.213 +# If set to NO only classes defined in header files are included.
2.214 +
2.215 +EXTRACT_LOCAL_CLASSES = YES
2.216 +
2.217 +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
2.218 +# undocumented members of documented classes, files or namespaces.
2.219 +# If set to NO (the default) these members will be included in the
2.220 +# various overviews, but no documentation section is generated.
2.221 +# This option has no effect if EXTRACT_ALL is enabled.
2.222 +
2.223 +HIDE_UNDOC_MEMBERS = YES
2.224 +
2.225 +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
2.226 +# undocumented classes that are normally visible in the class hierarchy.
2.227 +# If set to NO (the default) these classes will be included in the various
2.228 +# overviews. This option has no effect if EXTRACT_ALL is enabled.
2.229 +
2.230 +HIDE_UNDOC_CLASSES = YES
2.231 +
2.232 +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
2.233 +# friend (class|struct|union) declarations.
2.234 +# If set to NO (the default) these declarations will be included in the
2.235 +# documentation.
2.236 +
2.237 +HIDE_FRIEND_COMPOUNDS = NO
2.238 +
2.239 +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
2.240 +# documentation blocks found inside the body of a function.
2.241 +# If set to NO (the default) these blocks will be appended to the
2.242 +# function's detailed documentation block.
2.243 +
2.244 +HIDE_IN_BODY_DOCS = NO
2.245 +
2.246 +# The INTERNAL_DOCS tag determines if documentation
2.247 +# that is typed after a \internal command is included. If the tag is set
2.248 +# to NO (the default) then the documentation will be excluded.
2.249 +# Set it to YES to include the internal documentation.
2.250 +
2.251 +INTERNAL_DOCS = NO
2.252 +
2.253 +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
2.254 +# file names in lower-case letters. If set to YES upper-case letters are also
2.255 +# allowed. This is useful if you have classes or files whose names only differ
2.256 +# in case and if your file system supports case sensitive file names. Windows
2.257 +# users are advised to set this option to NO.
2.258 +
2.259 +CASE_SENSE_NAMES = YES
2.260 +
2.261 +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
2.262 +# will show members with their full class and namespace scopes in the
2.263 +# documentation. If set to YES the scope will be hidden.
2.264 +
2.265 +HIDE_SCOPE_NAMES = YES
2.266 +
2.267 +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
2.268 +# will put a list of the files that are included by a file in the documentation
2.269 +# of that file.
2.270 +
2.271 +SHOW_INCLUDE_FILES = YES
2.272 +
2.273 +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
2.274 +# is inserted in the documentation for inline members.
2.275 +
2.276 +INLINE_INFO = YES
2.277 +
2.278 +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
2.279 +# will sort the (detailed) documentation of file and class members
2.280 +# alphabetically by member name. If set to NO the members will appear in
2.281 +# declaration order.
2.282 +
2.283 +SORT_MEMBER_DOCS = NO
2.284 +
2.285 +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
2.286 +# brief documentation of file, namespace and class members alphabetically
2.287 +# by member name. If set to NO (the default) the members will appear in
2.288 +# declaration order.
2.289 +
2.290 +SORT_BRIEF_DOCS = NO
2.291 +
2.292 +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
2.293 +# sorted by fully-qualified names, including namespaces. If set to
2.294 +# NO (the default), the class list will be sorted only by class name,
2.295 +# not including the namespace part.
2.296 +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
2.297 +# Note: This option applies only to the class list, not to the
2.298 +# alphabetical list.
2.299 +
2.300 +SORT_BY_SCOPE_NAME = NO
2.301 +
2.302 +# The GENERATE_TODOLIST tag can be used to enable (YES) or
2.303 +# disable (NO) the todo list. This list is created by putting \todo
2.304 +# commands in the documentation.
2.305 +
2.306 +GENERATE_TODOLIST = YES
2.307 +
2.308 +# The GENERATE_TESTLIST tag can be used to enable (YES) or
2.309 +# disable (NO) the test list. This list is created by putting \test
2.310 +# commands in the documentation.
2.311 +
2.312 +GENERATE_TESTLIST = YES
2.313 +
2.314 +# The GENERATE_BUGLIST tag can be used to enable (YES) or
2.315 +# disable (NO) the bug list. This list is created by putting \bug
2.316 +# commands in the documentation.
2.317 +
2.318 +GENERATE_BUGLIST = YES
2.319 +
2.320 +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
2.321 +# disable (NO) the deprecated list. This list is created by putting
2.322 +# \deprecated commands in the documentation.
2.323 +
2.324 +GENERATE_DEPRECATEDLIST= YES
2.325 +
2.326 +# The ENABLED_SECTIONS tag can be used to enable conditional
2.327 +# documentation sections, marked by \if sectionname ... \endif.
2.328 +
2.329 +ENABLED_SECTIONS =
2.330 +
2.331 +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
2.332 +# the initial value of a variable or define consists of for it to appear in
2.333 +# the documentation. If the initializer consists of more lines than specified
2.334 +# here it will be hidden. Use a value of 0 to hide initializers completely.
2.335 +# The appearance of the initializer of individual variables and defines in the
2.336 +# documentation can be controlled using \showinitializer or \hideinitializer
2.337 +# command in the documentation regardless of this setting.
2.338 +
2.339 +MAX_INITIALIZER_LINES = 30
2.340 +
2.341 +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
2.342 +# at the bottom of the documentation of classes and structs. If set to YES the
2.343 +# list will mention the files that were used to generate the documentation.
2.344 +
2.345 +SHOW_USED_FILES = YES
2.346 +
2.347 +#---------------------------------------------------------------------------
2.348 +# configuration options related to warning and progress messages
2.349 +#---------------------------------------------------------------------------
2.350 +
2.351 +# The QUIET tag can be used to turn on/off the messages that are generated
2.352 +# by doxygen. Possible values are YES and NO. If left blank NO is used.
2.353 +
2.354 +QUIET = NO
2.355 +
2.356 +# The WARNINGS tag can be used to turn on/off the warning messages that are
2.357 +# generated by doxygen. Possible values are YES and NO. If left blank
2.358 +# NO is used.
2.359 +
2.360 +WARNINGS = YES
2.361 +
2.362 +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
2.363 +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
2.364 +# automatically be disabled.
2.365 +
2.366 +WARN_IF_UNDOCUMENTED = YES
2.367 +
2.368 +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
2.369 +# potential errors in the documentation, such as not documenting some
2.370 +# parameters in a documented function, or documenting parameters that
2.371 +# don't exist or using markup commands wrongly.
2.372 +
2.373 +WARN_IF_DOC_ERROR = YES
2.374 +
2.375 +# The WARN_FORMAT tag determines the format of the warning messages that
2.376 +# doxygen can produce. The string should contain the $file, $line, and $text
2.377 +# tags, which will be replaced by the file and line number from which the
2.378 +# warning originated and the warning text.
2.379 +
2.380 +WARN_FORMAT = "$file:$line: $text"
2.381 +
2.382 +# The WARN_LOGFILE tag can be used to specify a file to which warning
2.383 +# and error messages should be written. If left blank the output is written
2.384 +# to stderr.
2.385 +
2.386 +WARN_LOGFILE = doxygen.log
2.387 +
2.388 +#---------------------------------------------------------------------------
2.389 +# configuration options related to the input files
2.390 +#---------------------------------------------------------------------------
2.391 +
2.392 +# The INPUT tag can be used to specify the files and/or directories that contain
2.393 +# documented source files. You may enter file names like "myfile.cpp" or
2.394 +# directories like "/usr/src/myproject". Separate the files or directories
2.395 +# with spaces.
2.396 +
2.397 +INPUT = ../hugo \
2.398 + ../hugo/skeletons \
2.399 + ../test/test_tools.h \
2.400 + athos/minlengthpaths.h \
2.401 + klao/path.h \
2.402 + jacint/max_flow.h \
2.403 + jacint/max_matching.h
2.404 +
2.405 +# If the value of the INPUT tag contains directories, you can use the
2.406 +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
2.407 +# and *.h) to filter out the source-files in the directories. If left
2.408 +# blank the following patterns are tested:
2.409 +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
2.410 +# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
2.411 +
2.412 +FILE_PATTERNS =
2.413 +
2.414 +# The RECURSIVE tag can be used to turn specify whether or not subdirectories
2.415 +# should be searched for input files as well. Possible values are YES and NO.
2.416 +# If left blank NO is used.
2.417 +
2.418 +RECURSIVE = NO
2.419 +
2.420 +# The EXCLUDE tag can be used to specify files and/or directories that should
2.421 +# excluded from the INPUT source files. This way you can easily exclude a
2.422 +# subdirectory from a directory tree whose root is specified with the INPUT tag.
2.423 +
2.424 +EXCLUDE =
2.425 +
2.426 +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
2.427 +# that are symbolic links (a Unix filesystem feature) are excluded from the input.
2.428 +
2.429 +EXCLUDE_SYMLINKS = NO
2.430 +
2.431 +# If the value of the INPUT tag contains directories, you can use the
2.432 +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
2.433 +# certain files from those directories.
2.434 +
2.435 +EXCLUDE_PATTERNS =
2.436 +
2.437 +# The EXAMPLE_PATH tag can be used to specify one or more files or
2.438 +# directories that contain example code fragments that are included (see
2.439 +# the \include command).
2.440 +
2.441 +EXAMPLE_PATH =
2.442 +
2.443 +# If the value of the EXAMPLE_PATH tag contains directories, you can use the
2.444 +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
2.445 +# and *.h) to filter out the source-files in the directories. If left
2.446 +# blank all files are included.
2.447 +
2.448 +EXAMPLE_PATTERNS =
2.449 +
2.450 +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
2.451 +# searched for input files to be used with the \include or \dontinclude
2.452 +# commands irrespective of the value of the RECURSIVE tag.
2.453 +# Possible values are YES and NO. If left blank NO is used.
2.454 +
2.455 +EXAMPLE_RECURSIVE = NO
2.456 +
2.457 +# The IMAGE_PATH tag can be used to specify one or more files or
2.458 +# directories that contain image that are included in the documentation (see
2.459 +# the \image command).
2.460 +
2.461 +IMAGE_PATH =
2.462 +
2.463 +# The INPUT_FILTER tag can be used to specify a program that doxygen should
2.464 +# invoke to filter for each input file. Doxygen will invoke the filter program
2.465 +# by executing (via popen()) the command <filter> <input-file>, where <filter>
2.466 +# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
2.467 +# input file. Doxygen will then use the output that the filter program writes
2.468 +# to standard output.
2.469 +
2.470 +INPUT_FILTER =
2.471 +
2.472 +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
2.473 +# INPUT_FILTER) will be used to filter the input files when producing source
2.474 +# files to browse (i.e. when SOURCE_BROWSER is set to YES).
2.475 +
2.476 +FILTER_SOURCE_FILES = NO
2.477 +
2.478 +#---------------------------------------------------------------------------
2.479 +# configuration options related to source browsing
2.480 +#---------------------------------------------------------------------------
2.481 +
2.482 +# If the SOURCE_BROWSER tag is set to YES then a list of source files will
2.483 +# be generated. Documented entities will be cross-referenced with these sources.
2.484 +# Note: To get rid of all source code in the generated output, make sure also
2.485 +# VERBATIM_HEADERS is set to NO.
2.486 +
2.487 +SOURCE_BROWSER = YES
2.488 +
2.489 +# Setting the INLINE_SOURCES tag to YES will include the body
2.490 +# of functions and classes directly in the documentation.
2.491 +
2.492 +INLINE_SOURCES = NO
2.493 +
2.494 +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
2.495 +# doxygen to hide any special comment blocks from generated source code
2.496 +# fragments. Normal C and C++ comments will always remain visible.
2.497 +
2.498 +STRIP_CODE_COMMENTS = YES
2.499 +
2.500 +# If the REFERENCED_BY_RELATION tag is set to YES (the default)
2.501 +# then for each documented function all documented
2.502 +# functions referencing it will be listed.
2.503 +
2.504 +REFERENCED_BY_RELATION = YES
2.505 +
2.506 +# If the REFERENCES_RELATION tag is set to YES (the default)
2.507 +# then for each documented function all documented entities
2.508 +# called/used by that function will be listed.
2.509 +
2.510 +REFERENCES_RELATION = YES
2.511 +
2.512 +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
2.513 +# will generate a verbatim copy of the header file for each class for
2.514 +# which an include is specified. Set to NO to disable this.
2.515 +
2.516 +VERBATIM_HEADERS = YES
2.517 +
2.518 +#---------------------------------------------------------------------------
2.519 +# configuration options related to the alphabetical class index
2.520 +#---------------------------------------------------------------------------
2.521 +
2.522 +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
2.523 +# of all compounds will be generated. Enable this if the project
2.524 +# contains a lot of classes, structs, unions or interfaces.
2.525 +
2.526 +ALPHABETICAL_INDEX = YES
2.527 +
2.528 +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
2.529 +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
2.530 +# in which this list will be split (can be a number in the range [1..20])
2.531 +
2.532 +COLS_IN_ALPHA_INDEX = 2
2.533 +
2.534 +# In case all classes in a project start with a common prefix, all
2.535 +# classes will be put under the same header in the alphabetical index.
2.536 +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
2.537 +# should be ignored while generating the index headers.
2.538 +
2.539 +IGNORE_PREFIX =
2.540 +
2.541 +#---------------------------------------------------------------------------
2.542 +# configuration options related to the HTML output
2.543 +#---------------------------------------------------------------------------
2.544 +
2.545 +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
2.546 +# generate HTML output.
2.547 +
2.548 +GENERATE_HTML = YES
2.549 +
2.550 +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
2.551 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
2.552 +# put in front of it. If left blank `html' will be used as the default path.
2.553 +
2.554 +HTML_OUTPUT = html
2.555 +
2.556 +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
2.557 +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
2.558 +# doxygen will generate files with .html extension.
2.559 +
2.560 +HTML_FILE_EXTENSION = .html
2.561 +
2.562 +# The HTML_HEADER tag can be used to specify a personal HTML header for
2.563 +# each generated HTML page. If it is left blank doxygen will generate a
2.564 +# standard header.
2.565 +
2.566 +HTML_HEADER =
2.567 +
2.568 +# The HTML_FOOTER tag can be used to specify a personal HTML footer for
2.569 +# each generated HTML page. If it is left blank doxygen will generate a
2.570 +# standard footer.
2.571 +
2.572 +HTML_FOOTER =
2.573 +
2.574 +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
2.575 +# style sheet that is used by each HTML page. It can be used to
2.576 +# fine-tune the look of the HTML output. If the tag is left blank doxygen
2.577 +# will generate a default style sheet. Note that doxygen will try to copy
2.578 +# the style sheet file to the HTML output directory, so don't put your own
2.579 +# stylesheet in the HTML output directory as well, or it will be erased!
2.580 +
2.581 +HTML_STYLESHEET =
2.582 +
2.583 +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
2.584 +# files or namespaces will be aligned in HTML using tables. If set to
2.585 +# NO a bullet list will be used.
2.586 +
2.587 +HTML_ALIGN_MEMBERS = YES
2.588 +
2.589 +# If the GENERATE_HTMLHELP tag is set to YES, additional index files
2.590 +# will be generated that can be used as input for tools like the
2.591 +# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
2.592 +# of the generated HTML documentation.
2.593 +
2.594 +GENERATE_HTMLHELP = NO
2.595 +
2.596 +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
2.597 +# be used to specify the file name of the resulting .chm file. You
2.598 +# can add a path in front of the file if the result should not be
2.599 +# written to the html output directory.
2.600 +
2.601 +CHM_FILE =
2.602 +
2.603 +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
2.604 +# be used to specify the location (absolute path including file name) of
2.605 +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
2.606 +# the HTML help compiler on the generated index.hhp.
2.607 +
2.608 +HHC_LOCATION =
2.609 +
2.610 +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
2.611 +# controls if a separate .chi index file is generated (YES) or that
2.612 +# it should be included in the master .chm file (NO).
2.613 +
2.614 +GENERATE_CHI = NO
2.615 +
2.616 +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
2.617 +# controls whether a binary table of contents is generated (YES) or a
2.618 +# normal table of contents (NO) in the .chm file.
2.619 +
2.620 +BINARY_TOC = NO
2.621 +
2.622 +# The TOC_EXPAND flag can be set to YES to add extra items for group members
2.623 +# to the contents of the HTML help documentation and to the tree view.
2.624 +
2.625 +TOC_EXPAND = NO
2.626 +
2.627 +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
2.628 +# top of each HTML page. The value NO (the default) enables the index and
2.629 +# the value YES disables it.
2.630 +
2.631 +DISABLE_INDEX = NO
2.632 +
2.633 +# This tag can be used to set the number of enum values (range [1..20])
2.634 +# that doxygen will group on one line in the generated HTML documentation.
2.635 +
2.636 +ENUM_VALUES_PER_LINE = 4
2.637 +
2.638 +# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
2.639 +# generated containing a tree-like index structure (just like the one that
2.640 +# is generated for HTML Help). For this to work a browser that supports
2.641 +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
2.642 +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
2.643 +# probably better off using the HTML help feature.
2.644 +
2.645 +GENERATE_TREEVIEW = YES
2.646 +
2.647 +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
2.648 +# used to set the initial width (in pixels) of the frame in which the tree
2.649 +# is shown.
2.650 +
2.651 +TREEVIEW_WIDTH = 250
2.652 +
2.653 +#---------------------------------------------------------------------------
2.654 +# configuration options related to the LaTeX output
2.655 +#---------------------------------------------------------------------------
2.656 +
2.657 +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
2.658 +# generate Latex output.
2.659 +
2.660 +GENERATE_LATEX = NO
2.661 +
2.662 +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
2.663 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
2.664 +# put in front of it. If left blank `latex' will be used as the default path.
2.665 +
2.666 +LATEX_OUTPUT = latex
2.667 +
2.668 +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
2.669 +# invoked. If left blank `latex' will be used as the default command name.
2.670 +
2.671 +LATEX_CMD_NAME = latex
2.672 +
2.673 +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
2.674 +# generate index for LaTeX. If left blank `makeindex' will be used as the
2.675 +# default command name.
2.676 +
2.677 +MAKEINDEX_CMD_NAME = makeindex
2.678 +
2.679 +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
2.680 +# LaTeX documents. This may be useful for small projects and may help to
2.681 +# save some trees in general.
2.682 +
2.683 +COMPACT_LATEX = YES
2.684 +
2.685 +# The PAPER_TYPE tag can be used to set the paper type that is used
2.686 +# by the printer. Possible values are: a4, a4wide, letter, legal and
2.687 +# executive. If left blank a4wide will be used.
2.688 +
2.689 +PAPER_TYPE = a4wide
2.690 +
2.691 +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
2.692 +# packages that should be included in the LaTeX output.
2.693 +
2.694 +EXTRA_PACKAGES =
2.695 +
2.696 +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
2.697 +# the generated latex document. The header should contain everything until
2.698 +# the first chapter. If it is left blank doxygen will generate a
2.699 +# standard header. Notice: only use this tag if you know what you are doing!
2.700 +
2.701 +LATEX_HEADER =
2.702 +
2.703 +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
2.704 +# is prepared for conversion to pdf (using ps2pdf). The pdf file will
2.705 +# contain links (just like the HTML output) instead of page references
2.706 +# This makes the output suitable for online browsing using a pdf viewer.
2.707 +
2.708 +PDF_HYPERLINKS = YES
2.709 +
2.710 +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
2.711 +# plain latex in the generated Makefile. Set this option to YES to get a
2.712 +# higher quality PDF documentation.
2.713 +
2.714 +USE_PDFLATEX = YES
2.715 +
2.716 +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
2.717 +# command to the generated LaTeX files. This will instruct LaTeX to keep
2.718 +# running if errors occur, instead of asking the user for help.
2.719 +# This option is also used when generating formulas in HTML.
2.720 +
2.721 +LATEX_BATCHMODE = NO
2.722 +
2.723 +# If LATEX_HIDE_INDICES is set to YES then doxygen will not
2.724 +# include the index chapters (such as File Index, Compound Index, etc.)
2.725 +# in the output.
2.726 +
2.727 +LATEX_HIDE_INDICES = NO
2.728 +
2.729 +#---------------------------------------------------------------------------
2.730 +# configuration options related to the RTF output
2.731 +#---------------------------------------------------------------------------
2.732 +
2.733 +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
2.734 +# The RTF output is optimized for Word 97 and may not look very pretty with
2.735 +# other RTF readers or editors.
2.736 +
2.737 +GENERATE_RTF = NO
2.738 +
2.739 +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
2.740 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
2.741 +# put in front of it. If left blank `rtf' will be used as the default path.
2.742 +
2.743 +RTF_OUTPUT = rtf
2.744 +
2.745 +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
2.746 +# RTF documents. This may be useful for small projects and may help to
2.747 +# save some trees in general.
2.748 +
2.749 +COMPACT_RTF = NO
2.750 +
2.751 +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
2.752 +# will contain hyperlink fields. The RTF file will
2.753 +# contain links (just like the HTML output) instead of page references.
2.754 +# This makes the output suitable for online browsing using WORD or other
2.755 +# programs which support those fields.
2.756 +# Note: wordpad (write) and others do not support links.
2.757 +
2.758 +RTF_HYPERLINKS = NO
2.759 +
2.760 +# Load stylesheet definitions from file. Syntax is similar to doxygen's
2.761 +# config file, i.e. a series of assignments. You only have to provide
2.762 +# replacements, missing definitions are set to their default value.
2.763 +
2.764 +RTF_STYLESHEET_FILE =
2.765 +
2.766 +# Set optional variables used in the generation of an rtf document.
2.767 +# Syntax is similar to doxygen's config file.
2.768 +
2.769 +RTF_EXTENSIONS_FILE =
2.770 +
2.771 +#---------------------------------------------------------------------------
2.772 +# configuration options related to the man page output
2.773 +#---------------------------------------------------------------------------
2.774 +
2.775 +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
2.776 +# generate man pages
2.777 +
2.778 +GENERATE_MAN = NO
2.779 +
2.780 +# The MAN_OUTPUT tag is used to specify where the man pages will be put.
2.781 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
2.782 +# put in front of it. If left blank `man' will be used as the default path.
2.783 +
2.784 +MAN_OUTPUT = man
2.785 +
2.786 +# The MAN_EXTENSION tag determines the extension that is added to
2.787 +# the generated man pages (default is the subroutine's section .3)
2.788 +
2.789 +MAN_EXTENSION = .3
2.790 +
2.791 +# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
2.792 +# then it will generate one additional man file for each entity
2.793 +# documented in the real man page(s). These additional files
2.794 +# only source the real man page, but without them the man command
2.795 +# would be unable to find the correct page. The default is NO.
2.796 +
2.797 +MAN_LINKS = NO
2.798 +
2.799 +#---------------------------------------------------------------------------
2.800 +# configuration options related to the XML output
2.801 +#---------------------------------------------------------------------------
2.802 +
2.803 +# If the GENERATE_XML tag is set to YES Doxygen will
2.804 +# generate an XML file that captures the structure of
2.805 +# the code including all documentation.
2.806 +
2.807 +GENERATE_XML = NO
2.808 +
2.809 +# The XML_OUTPUT tag is used to specify where the XML pages will be put.
2.810 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
2.811 +# put in front of it. If left blank `xml' will be used as the default path.
2.812 +
2.813 +XML_OUTPUT = xml
2.814 +
2.815 +# The XML_SCHEMA tag can be used to specify an XML schema,
2.816 +# which can be used by a validating XML parser to check the
2.817 +# syntax of the XML files.
2.818 +
2.819 +XML_SCHEMA =
2.820 +
2.821 +# The XML_DTD tag can be used to specify an XML DTD,
2.822 +# which can be used by a validating XML parser to check the
2.823 +# syntax of the XML files.
2.824 +
2.825 +XML_DTD =
2.826 +
2.827 +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
2.828 +# dump the program listings (including syntax highlighting
2.829 +# and cross-referencing information) to the XML output. Note that
2.830 +# enabling this will significantly increase the size of the XML output.
2.831 +
2.832 +XML_PROGRAMLISTING = YES
2.833 +
2.834 +#---------------------------------------------------------------------------
2.835 +# configuration options for the AutoGen Definitions output
2.836 +#---------------------------------------------------------------------------
2.837 +
2.838 +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
2.839 +# generate an AutoGen Definitions (see autogen.sf.net) file
2.840 +# that captures the structure of the code including all
2.841 +# documentation. Note that this feature is still experimental
2.842 +# and incomplete at the moment.
2.843 +
2.844 +GENERATE_AUTOGEN_DEF = NO
2.845 +
2.846 +#---------------------------------------------------------------------------
2.847 +# configuration options related to the Perl module output
2.848 +#---------------------------------------------------------------------------
2.849 +
2.850 +# If the GENERATE_PERLMOD tag is set to YES Doxygen will
2.851 +# generate a Perl module file that captures the structure of
2.852 +# the code including all documentation. Note that this
2.853 +# feature is still experimental and incomplete at the
2.854 +# moment.
2.855 +
2.856 +GENERATE_PERLMOD = NO
2.857 +
2.858 +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
2.859 +# the necessary Makefile rules, Perl scripts and LaTeX code to be able
2.860 +# to generate PDF and DVI output from the Perl module output.
2.861 +
2.862 +PERLMOD_LATEX = NO
2.863 +
2.864 +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
2.865 +# nicely formatted so it can be parsed by a human reader. This is useful
2.866 +# if you want to understand what is going on. On the other hand, if this
2.867 +# tag is set to NO the size of the Perl module output will be much smaller
2.868 +# and Perl will parse it just the same.
2.869 +
2.870 +PERLMOD_PRETTY = YES
2.871 +
2.872 +# The names of the make variables in the generated doxyrules.make file
2.873 +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
2.874 +# This is useful so different doxyrules.make files included by the same
2.875 +# Makefile don't overwrite each other's variables.
2.876 +
2.877 +PERLMOD_MAKEVAR_PREFIX =
2.878 +
2.879 +#---------------------------------------------------------------------------
2.880 +# Configuration options related to the preprocessor
2.881 +#---------------------------------------------------------------------------
2.882 +
2.883 +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
2.884 +# evaluate all C-preprocessor directives found in the sources and include
2.885 +# files.
2.886 +
2.887 +ENABLE_PREPROCESSING = YES
2.888 +
2.889 +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
2.890 +# names in the source code. If set to NO (the default) only conditional
2.891 +# compilation will be performed. Macro expansion can be done in a controlled
2.892 +# way by setting EXPAND_ONLY_PREDEF to YES.
2.893 +
2.894 +MACRO_EXPANSION = NO
2.895 +
2.896 +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
2.897 +# then the macro expansion is limited to the macros specified with the
2.898 +# PREDEFINED and EXPAND_AS_PREDEFINED tags.
2.899 +
2.900 +EXPAND_ONLY_PREDEF = NO
2.901 +
2.902 +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
2.903 +# in the INCLUDE_PATH (see below) will be search if a #include is found.
2.904 +
2.905 +SEARCH_INCLUDES = YES
2.906 +
2.907 +# The INCLUDE_PATH tag can be used to specify one or more directories that
2.908 +# contain include files that are not input files but should be processed by
2.909 +# the preprocessor.
2.910 +
2.911 +INCLUDE_PATH =
2.912 +
2.913 +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2.914 +# patterns (like *.h and *.hpp) to filter out the header-files in the
2.915 +# directories. If left blank, the patterns specified with FILE_PATTERNS will
2.916 +# be used.
2.917 +
2.918 +INCLUDE_FILE_PATTERNS =
2.919 +
2.920 +# The PREDEFINED tag can be used to specify one or more macro names that
2.921 +# are defined before the preprocessor is started (similar to the -D option of
2.922 +# gcc). The argument of the tag is a list of macros of the form: name
2.923 +# or name=definition (no spaces). If the definition and the = are
2.924 +# omitted =1 is assumed.
2.925 +
2.926 +PREDEFINED = DOXYGEN
2.927 +
2.928 +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
2.929 +# this tag can be used to specify a list of macro names that should be expanded.
2.930 +# The macro definition that is found in the sources will be used.
2.931 +# Use the PREDEFINED tag if you want to use a different macro definition.
2.932 +
2.933 +EXPAND_AS_DEFINED =
2.934 +
2.935 +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
2.936 +# doxygen's preprocessor will remove all function-like macros that are alone
2.937 +# on a line, have an all uppercase name, and do not end with a semicolon. Such
2.938 +# function macros are typically used for boiler-plate code, and will confuse the
2.939 +# parser if not removed.
2.940 +
2.941 +SKIP_FUNCTION_MACROS = YES
2.942 +
2.943 +#---------------------------------------------------------------------------
2.944 +# Configuration::additions related to external references
2.945 +#---------------------------------------------------------------------------
2.946 +
2.947 +# The TAGFILES option can be used to specify one or more tagfiles.
2.948 +# Optionally an initial location of the external documentation
2.949 +# can be added for each tagfile. The format of a tag file without
2.950 +# this location is as follows:
2.951 +# TAGFILES = file1 file2 ...
2.952 +# Adding location for the tag files is done as follows:
2.953 +# TAGFILES = file1=loc1 "file2 = loc2" ...
2.954 +# where "loc1" and "loc2" can be relative or absolute paths or
2.955 +# URLs. If a location is present for each tag, the installdox tool
2.956 +# does not have to be run to correct the links.
2.957 +# Note that each tag file must have a unique name
2.958 +# (where the name does NOT include the path)
2.959 +# If a tag file is not located in the directory in which doxygen
2.960 +# is run, you must also specify the path to the tagfile here.
2.961 +
2.962 +TAGFILES =
2.963 +
2.964 +# When a file name is specified after GENERATE_TAGFILE, doxygen will create
2.965 +# a tag file that is based on the input files it reads.
2.966 +
2.967 +GENERATE_TAGFILE =
2.968 +
2.969 +# If the ALLEXTERNALS tag is set to YES all external classes will be listed
2.970 +# in the class index. If set to NO only the inherited external classes
2.971 +# will be listed.
2.972 +
2.973 +ALLEXTERNALS = NO
2.974 +
2.975 +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
2.976 +# in the modules index. If set to NO, only the current project's groups will
2.977 +# be listed.
2.978 +
2.979 +EXTERNAL_GROUPS = YES
2.980 +
2.981 +# The PERL_PATH should be the absolute path and name of the perl script
2.982 +# interpreter (i.e. the result of `which perl').
2.983 +
2.984 +PERL_PATH = /usr/bin/perl
2.985 +
2.986 +#---------------------------------------------------------------------------
2.987 +# Configuration options related to the dot tool
2.988 +#---------------------------------------------------------------------------
2.989 +
2.990 +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
2.991 +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
2.992 +# super classes. Setting the tag to NO turns the diagrams off. Note that this
2.993 +# option is superseded by the HAVE_DOT option below. This is only a fallback. It is
2.994 +# recommended to install and use dot, since it yields more powerful graphs.
2.995 +
2.996 +CLASS_DIAGRAMS = YES
2.997 +
2.998 +# If set to YES, the inheritance and collaboration graphs will hide
2.999 +# inheritance and usage relations if the target is undocumented
2.1000 +# or is not a class.
2.1001 +
2.1002 +HIDE_UNDOC_RELATIONS = NO
2.1003 +
2.1004 +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2.1005 +# available from the path. This tool is part of Graphviz, a graph visualization
2.1006 +# toolkit from AT&T and Lucent Bell Labs. The other options in this section
2.1007 +# have no effect if this option is set to NO (the default)
2.1008 +
2.1009 +HAVE_DOT = YES
2.1010 +
2.1011 +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
2.1012 +# will generate a graph for each documented class showing the direct and
2.1013 +# indirect inheritance relations. Setting this tag to YES will force the
2.1014 +# the CLASS_DIAGRAMS tag to NO.
2.1015 +
2.1016 +CLASS_GRAPH = YES
2.1017 +
2.1018 +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
2.1019 +# will generate a graph for each documented class showing the direct and
2.1020 +# indirect implementation dependencies (inheritance, containment, and
2.1021 +# class references variables) of the class with other documented classes.
2.1022 +
2.1023 +COLLABORATION_GRAPH = YES
2.1024 +
2.1025 +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2.1026 +# collaboration diagrams in a style similar to the OMG's Unified Modeling
2.1027 +# Language.
2.1028 +
2.1029 +UML_LOOK = NO
2.1030 +
2.1031 +# If set to YES, the inheritance and collaboration graphs will show the
2.1032 +# relations between templates and their instances.
2.1033 +
2.1034 +TEMPLATE_RELATIONS = YES
2.1035 +
2.1036 +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
2.1037 +# tags are set to YES then doxygen will generate a graph for each documented
2.1038 +# file showing the direct and indirect include dependencies of the file with
2.1039 +# other documented files.
2.1040 +
2.1041 +INCLUDE_GRAPH = YES
2.1042 +
2.1043 +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
2.1044 +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
2.1045 +# documented header file showing the documented files that directly or
2.1046 +# indirectly include this file.
2.1047 +
2.1048 +INCLUDED_BY_GRAPH = YES
2.1049 +
2.1050 +# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
2.1051 +# generate a call dependency graph for every global function or class method.
2.1052 +# Note that enabling this option will significantly increase the time of a run.
2.1053 +# So in most cases it will be better to enable call graphs for selected
2.1054 +# functions only using the \callgraph command.
2.1055 +
2.1056 +CALL_GRAPH = YES
2.1057 +
2.1058 +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
2.1059 +# will graphical hierarchy of all classes instead of a textual one.
2.1060 +
2.1061 +GRAPHICAL_HIERARCHY = YES
2.1062 +
2.1063 +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2.1064 +# generated by dot. Possible values are png, jpg, or gif
2.1065 +# If left blank png will be used.
2.1066 +
2.1067 +DOT_IMAGE_FORMAT = png
2.1068 +
2.1069 +# The tag DOT_PATH can be used to specify the path where the dot tool can be
2.1070 +# found. If left blank, it is assumed the dot tool can be found on the path.
2.1071 +
2.1072 +DOT_PATH =
2.1073 +
2.1074 +# The DOTFILE_DIRS tag can be used to specify one or more directories that
2.1075 +# contain dot files that are included in the documentation (see the
2.1076 +# \dotfile command).
2.1077 +
2.1078 +DOTFILE_DIRS =
2.1079 +
2.1080 +# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
2.1081 +# (in pixels) of the graphs generated by dot. If a graph becomes larger than
2.1082 +# this value, doxygen will try to truncate the graph, so that it fits within
2.1083 +# the specified constraint. Beware that most browsers cannot cope with very
2.1084 +# large images.
2.1085 +
2.1086 +MAX_DOT_GRAPH_WIDTH = 1024
2.1087 +
2.1088 +# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
2.1089 +# (in pixels) of the graphs generated by dot. If a graph becomes larger than
2.1090 +# this value, doxygen will try to truncate the graph, so that it fits within
2.1091 +# the specified constraint. Beware that most browsers cannot cope with very
2.1092 +# large images.
2.1093 +
2.1094 +MAX_DOT_GRAPH_HEIGHT = 1024
2.1095 +
2.1096 +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
2.1097 +# graphs generated by dot. A depth value of 3 means that only nodes reachable
2.1098 +# from the root by following a path via at most 3 edges will be shown. Nodes that
2.1099 +# lay further from the root node will be omitted. Note that setting this option to
2.1100 +# 1 or 2 may greatly reduce the computation time needed for large code bases. Also
2.1101 +# note that a graph may be further truncated if the graph's image dimensions are
2.1102 +# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
2.1103 +# If 0 is used for the depth value (the default), the graph is not depth-constrained.
2.1104 +
2.1105 +MAX_DOT_GRAPH_DEPTH = 0
2.1106 +
2.1107 +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
2.1108 +# generate a legend page explaining the meaning of the various boxes and
2.1109 +# arrows in the dot generated graphs.
2.1110 +
2.1111 +GENERATE_LEGEND = YES
2.1112 +
2.1113 +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
2.1114 +# remove the intermediate dot files that are used to generate
2.1115 +# the various graphs.
2.1116 +
2.1117 +DOT_CLEANUP = YES
2.1118 +
2.1119 +#---------------------------------------------------------------------------
2.1120 +# Configuration::additions related to the search engine
2.1121 +#---------------------------------------------------------------------------
2.1122 +
2.1123 +# The SEARCHENGINE tag specifies whether or not a search engine should be
2.1124 +# used. If set to NO the values of all tags below this one will be ignored.
2.1125 +
2.1126 +SEARCHENGINE = YES