1.1 --- a/doc/Doxyfile Wed Mar 24 09:36:21 2004 +0000
1.2 +++ b/doc/Doxyfile Wed Mar 24 13:06:06 2004 +0000
1.3 @@ -1,62 +1,396 @@
1.4 -# Doxyfile 1.3.2
1.5 +# Doxyfile 1.3.6
1.6 +
1.7 +# This file describes the settings to be used by the documentation system
1.8 +# doxygen (www.doxygen.org) for a project
1.9 +#
1.10 +# All text after a hash (#) is considered a comment and will be ignored
1.11 +# The format is:
1.12 +# TAG = value [value, ...]
1.13 +# For lists items can also be appended using:
1.14 +# TAG += value [value, ...]
1.15 +# Values that contain spaces should be placed between quotes (" ")
1.16
1.17 #---------------------------------------------------------------------------
1.18 -# General configuration options
1.19 +# Project related configuration options
1.20 #---------------------------------------------------------------------------
1.21 +
1.22 +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
1.23 +# by quotes) that should identify the project.
1.24 +
1.25 PROJECT_NAME = hugo
1.26 +
1.27 +# The PROJECT_NUMBER tag can be used to enter a project or revision number.
1.28 +# This could be handy for archiving the generated documentation or
1.29 +# if some version control system is used.
1.30 +
1.31 PROJECT_NUMBER = 0.1
1.32 +
1.33 +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
1.34 +# base path where the generated documentation will be put.
1.35 +# If a relative path is entered, it will be relative to the location
1.36 +# where doxygen was started. If left blank the current directory will be used.
1.37 +
1.38 OUTPUT_DIRECTORY =
1.39 +
1.40 +# The OUTPUT_LANGUAGE tag is used to specify the language in which all
1.41 +# documentation generated by doxygen is written. Doxygen will use this
1.42 +# information to generate all constant output in the proper language.
1.43 +# The default language is English, other supported languages are:
1.44 +# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
1.45 +# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
1.46 +# (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese,
1.47 +# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
1.48 +
1.49 OUTPUT_LANGUAGE = English
1.50 +
1.51 +# This tag can be used to specify the encoding used in the generated output.
1.52 +# The encoding is not always determined by the language that is chosen,
1.53 +# but also whether or not the output is meant for Windows or non-Windows users.
1.54 +# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
1.55 +# forces the Windows encoding (this is the default for the Windows binary),
1.56 +# whereas setting the tag to NO uses a Unix-style encoding (the default for
1.57 +# all platforms other than Windows).
1.58 +
1.59 USE_WINDOWS_ENCODING = NO
1.60 +
1.61 +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
1.62 +# include brief member descriptions after the members that are listed in
1.63 +# the file and class documentation (similar to JavaDoc).
1.64 +# Set to NO to disable this.
1.65 +
1.66 +BRIEF_MEMBER_DESC = YES
1.67 +
1.68 +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
1.69 +# the brief description of a member or function before the detailed description.
1.70 +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
1.71 +# brief descriptions will be completely suppressed.
1.72 +
1.73 +REPEAT_BRIEF = NO
1.74 +
1.75 +# This tag implements a quasi-intelligent brief description abbreviator
1.76 +# that is used to form the text in various listings. Each string
1.77 +# in this list, if found as the leading text of the brief description, will be
1.78 +# stripped from the text and the result after processing the whole list, is used
1.79 +# as the annotated text. Otherwise, the brief description is used as-is. If left
1.80 +# blank, the following values are used ("$name" is automatically replaced with the
1.81 +# name of the entity): "The $name class" "The $name widget" "The $name file"
1.82 +# "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
1.83 +
1.84 +ABBREVIATE_BRIEF =
1.85 +
1.86 +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
1.87 +# Doxygen will generate a detailed section even if there is only a brief
1.88 +# description.
1.89 +
1.90 +ALWAYS_DETAILED_SEC = NO
1.91 +
1.92 +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
1.93 +# members of a class in the documentation of that class as if those members were
1.94 +# ordinary class members. Constructors, destructors and assignment operators of
1.95 +# the base classes will not be shown.
1.96 +
1.97 +INLINE_INHERITED_MEMB = NO
1.98 +
1.99 +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
1.100 +# path before files name in the file list and in the header files. If set
1.101 +# to NO the shortest path that makes the file name unique will be used.
1.102 +
1.103 +FULL_PATH_NAMES = NO
1.104 +
1.105 +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
1.106 +# can be used to strip a user-defined part of the path. Stripping is
1.107 +# only done if one of the specified strings matches the left-hand part of
1.108 +# the path. It is allowed to use relative paths in the argument list.
1.109 +# If left blank the directory from which doxygen is run is used as the
1.110 +# path to strip.
1.111 +
1.112 +STRIP_FROM_PATH =
1.113 +
1.114 +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
1.115 +# (but less readable) file names. This can be useful is your file systems
1.116 +# doesn't support long names like on DOS, Mac, or CD-ROM.
1.117 +
1.118 +SHORT_NAMES = NO
1.119 +
1.120 +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
1.121 +# will interpret the first line (until the first dot) of a JavaDoc-style
1.122 +# comment as the brief description. If set to NO, the JavaDoc
1.123 +# comments will behave just like the Qt-style comments (thus requiring an
1.124 +# explicit @brief command for a brief description.
1.125 +
1.126 +JAVADOC_AUTOBRIEF = NO
1.127 +
1.128 +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
1.129 +# treat a multi-line C++ special comment block (i.e. a block of //! or ///
1.130 +# comments) as a brief description. This used to be the default behaviour.
1.131 +# The new default is to treat a multi-line C++ comment block as a detailed
1.132 +# description. Set this tag to YES if you prefer the old behaviour instead.
1.133 +
1.134 +MULTILINE_CPP_IS_BRIEF = NO
1.135 +
1.136 +# If the DETAILS_AT_TOP tag is set to YES then Doxygen
1.137 +# will output the detailed description near the top, like JavaDoc.
1.138 +# If set to NO, the detailed description appears after the member
1.139 +# documentation.
1.140 +
1.141 +DETAILS_AT_TOP = NO
1.142 +
1.143 +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
1.144 +# member inherits the documentation from any documented member that it
1.145 +# re-implements.
1.146 +
1.147 +INHERIT_DOCS = NO
1.148 +
1.149 +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
1.150 +# tag is set to YES, then doxygen will reuse the documentation of the first
1.151 +# member in the group (if any) for the other members of the group. By default
1.152 +# all members of a group must be documented explicitly.
1.153 +
1.154 +DISTRIBUTE_GROUP_DOC = NO
1.155 +
1.156 +# The TAB_SIZE tag can be used to set the number of spaces in a tab.
1.157 +# Doxygen uses this value to replace tabs by spaces in code fragments.
1.158 +
1.159 +TAB_SIZE = 8
1.160 +
1.161 +# This tag can be used to specify a number of aliases that acts
1.162 +# as commands in the documentation. An alias has the form "name=value".
1.163 +# For example adding "sideeffect=\par Side Effects:\n" will allow you to
1.164 +# put the command \sideeffect (or @sideeffect) in the documentation, which
1.165 +# will result in a user-defined paragraph with heading "Side Effects:".
1.166 +# You can put \n's in the value part of an alias to insert newlines.
1.167 +
1.168 +ALIASES =
1.169 +
1.170 +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
1.171 +# only. Doxygen will then generate output that is more tailored for C.
1.172 +# For instance, some of the names that are used will be different. The list
1.173 +# of all members will be omitted, etc.
1.174 +
1.175 +OPTIMIZE_OUTPUT_FOR_C = YES
1.176 +
1.177 +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
1.178 +# only. Doxygen will then generate output that is more tailored for Java.
1.179 +# For instance, namespaces will be presented as packages, qualified scopes
1.180 +# will look different, etc.
1.181 +
1.182 +OPTIMIZE_OUTPUT_JAVA = NO
1.183 +
1.184 +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
1.185 +# the same type (for instance a group of public functions) to be put as a
1.186 +# subgroup of that type (e.g. under the Public Functions section). Set it to
1.187 +# NO to prevent subgrouping. Alternatively, this can be done per class using
1.188 +# the \nosubgrouping command.
1.189 +
1.190 +SUBGROUPING = YES
1.191 +
1.192 +#---------------------------------------------------------------------------
1.193 +# Build related configuration options
1.194 +#---------------------------------------------------------------------------
1.195 +
1.196 +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
1.197 +# documentation are documented, even if no documentation was available.
1.198 +# Private class members and static file members will be hidden unless
1.199 +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
1.200 +
1.201 EXTRACT_ALL = NO
1.202 +
1.203 +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
1.204 +# will be included in the documentation.
1.205 +
1.206 EXTRACT_PRIVATE = NO
1.207 +
1.208 +# If the EXTRACT_STATIC tag is set to YES all static members of a file
1.209 +# will be included in the documentation.
1.210 +
1.211 EXTRACT_STATIC = NO
1.212 +
1.213 +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
1.214 +# defined locally in source files will be included in the documentation.
1.215 +# If set to NO only classes defined in header files are included.
1.216 +
1.217 EXTRACT_LOCAL_CLASSES = YES
1.218 +
1.219 +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
1.220 +# undocumented members of documented classes, files or namespaces.
1.221 +# If set to NO (the default) these members will be included in the
1.222 +# various overviews, but no documentation section is generated.
1.223 +# This option has no effect if EXTRACT_ALL is enabled.
1.224 +
1.225 HIDE_UNDOC_MEMBERS = YES
1.226 +
1.227 +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
1.228 +# undocumented classes that are normally visible in the class hierarchy.
1.229 +# If set to NO (the default) these classes will be included in the various
1.230 +# overviews. This option has no effect if EXTRACT_ALL is enabled.
1.231 +
1.232 HIDE_UNDOC_CLASSES = YES
1.233 +
1.234 +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
1.235 +# friend (class|struct|union) declarations.
1.236 +# If set to NO (the default) these declarations will be included in the
1.237 +# documentation.
1.238 +
1.239 HIDE_FRIEND_COMPOUNDS = NO
1.240 +
1.241 +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
1.242 +# documentation blocks found inside the body of a function.
1.243 +# If set to NO (the default) these blocks will be appended to the
1.244 +# function's detailed documentation block.
1.245 +
1.246 HIDE_IN_BODY_DOCS = NO
1.247 -BRIEF_MEMBER_DESC = YES
1.248 -REPEAT_BRIEF = NO
1.249 -ALWAYS_DETAILED_SEC = NO
1.250 -INLINE_INHERITED_MEMB = NO
1.251 -FULL_PATH_NAMES = NO
1.252 -STRIP_FROM_PATH =
1.253 +
1.254 +# The INTERNAL_DOCS tag determines if documentation
1.255 +# that is typed after a \internal command is included. If the tag is set
1.256 +# to NO (the default) then the documentation will be excluded.
1.257 +# Set it to YES to include the internal documentation.
1.258 +
1.259 INTERNAL_DOCS = NO
1.260 +
1.261 +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
1.262 +# file names in lower-case letters. If set to YES upper-case letters are also
1.263 +# allowed. This is useful if you have classes or files whose names only differ
1.264 +# in case and if your file system supports case sensitive file names. Windows
1.265 +# users are advised to set this option to NO.
1.266 +
1.267 CASE_SENSE_NAMES = YES
1.268 -SHORT_NAMES = NO
1.269 +
1.270 +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
1.271 +# will show members with their full class and namespace scopes in the
1.272 +# documentation. If set to YES the scope will be hidden.
1.273 +
1.274 HIDE_SCOPE_NAMES = YES
1.275 +
1.276 +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
1.277 +# will put a list of the files that are included by a file in the documentation
1.278 +# of that file.
1.279 +
1.280 SHOW_INCLUDE_FILES = YES
1.281 -JAVADOC_AUTOBRIEF = NO
1.282 -MULTILINE_CPP_IS_BRIEF = NO
1.283 -DETAILS_AT_TOP = NO
1.284 -INHERIT_DOCS = NO
1.285 +
1.286 +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
1.287 +# is inserted in the documentation for inline members.
1.288 +
1.289 INLINE_INFO = YES
1.290 +
1.291 +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
1.292 +# will sort the (detailed) documentation of file and class members
1.293 +# alphabetically by member name. If set to NO the members will appear in
1.294 +# declaration order.
1.295 +
1.296 SORT_MEMBER_DOCS = NO
1.297 -DISTRIBUTE_GROUP_DOC = NO
1.298 -TAB_SIZE = 8
1.299 +
1.300 +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
1.301 +# brief documentation of file, namespace and class members alphabetically
1.302 +# by member name. If set to NO (the default) the members will appear in
1.303 +# declaration order.
1.304 +
1.305 +SORT_BRIEF_DOCS = NO
1.306 +
1.307 +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
1.308 +# sorted by fully-qualified names, including namespaces. If set to
1.309 +# NO (the default), the class list will be sorted only by class name,
1.310 +# not including the namespace part.
1.311 +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
1.312 +# Note: This option applies only to the class list, not to the
1.313 +# alphabetical list.
1.314 +
1.315 +SORT_BY_SCOPE_NAME = NO
1.316 +
1.317 +# The GENERATE_TODOLIST tag can be used to enable (YES) or
1.318 +# disable (NO) the todo list. This list is created by putting \todo
1.319 +# commands in the documentation.
1.320 +
1.321 GENERATE_TODOLIST = YES
1.322 +
1.323 +# The GENERATE_TESTLIST tag can be used to enable (YES) or
1.324 +# disable (NO) the test list. This list is created by putting \test
1.325 +# commands in the documentation.
1.326 +
1.327 GENERATE_TESTLIST = YES
1.328 +
1.329 +# The GENERATE_BUGLIST tag can be used to enable (YES) or
1.330 +# disable (NO) the bug list. This list is created by putting \bug
1.331 +# commands in the documentation.
1.332 +
1.333 GENERATE_BUGLIST = YES
1.334 +
1.335 +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
1.336 +# disable (NO) the deprecated list. This list is created by putting
1.337 +# \deprecated commands in the documentation.
1.338 +
1.339 GENERATE_DEPRECATEDLIST= YES
1.340 -ALIASES =
1.341 +
1.342 +# The ENABLED_SECTIONS tag can be used to enable conditional
1.343 +# documentation sections, marked by \if sectionname ... \endif.
1.344 +
1.345 ENABLED_SECTIONS =
1.346 +
1.347 +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
1.348 +# the initial value of a variable or define consists of for it to appear in
1.349 +# the documentation. If the initializer consists of more lines than specified
1.350 +# here it will be hidden. Use a value of 0 to hide initializers completely.
1.351 +# The appearance of the initializer of individual variables and defines in the
1.352 +# documentation can be controlled using \showinitializer or \hideinitializer
1.353 +# command in the documentation regardless of this setting.
1.354 +
1.355 MAX_INITIALIZER_LINES = 30
1.356 -OPTIMIZE_OUTPUT_FOR_C = YES
1.357 -OPTIMIZE_OUTPUT_JAVA = NO
1.358 +
1.359 +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
1.360 +# at the bottom of the documentation of classes and structs. If set to YES the
1.361 +# list will mention the files that were used to generate the documentation.
1.362 +
1.363 SHOW_USED_FILES = YES
1.364 +
1.365 #---------------------------------------------------------------------------
1.366 # configuration options related to warning and progress messages
1.367 #---------------------------------------------------------------------------
1.368 +
1.369 +# The QUIET tag can be used to turn on/off the messages that are generated
1.370 +# by doxygen. Possible values are YES and NO. If left blank NO is used.
1.371 +
1.372 QUIET = NO
1.373 +
1.374 +# The WARNINGS tag can be used to turn on/off the warning messages that are
1.375 +# generated by doxygen. Possible values are YES and NO. If left blank
1.376 +# NO is used.
1.377 +
1.378 WARNINGS = YES
1.379 +
1.380 +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
1.381 +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
1.382 +# automatically be disabled.
1.383 +
1.384 WARN_IF_UNDOCUMENTED = YES
1.385 +
1.386 +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
1.387 +# potential errors in the documentation, such as not documenting some
1.388 +# parameters in a documented function, or documenting parameters that
1.389 +# don't exist or using markup commands wrongly.
1.390 +
1.391 WARN_IF_DOC_ERROR = YES
1.392 +
1.393 +# The WARN_FORMAT tag determines the format of the warning messages that
1.394 +# doxygen can produce. The string should contain the $file, $line, and $text
1.395 +# tags, which will be replaced by the file and line number from which the
1.396 +# warning originated and the warning text.
1.397 +
1.398 WARN_FORMAT = "$file:$line: $text"
1.399 +
1.400 +# The WARN_LOGFILE tag can be used to specify a file to which warning
1.401 +# and error messages should be written. If left blank the output is written
1.402 +# to stderr.
1.403 +
1.404 WARN_LOGFILE =
1.405 +
1.406 #---------------------------------------------------------------------------
1.407 # configuration options related to the input files
1.408 #---------------------------------------------------------------------------
1.409 +
1.410 +# The INPUT tag can be used to specify the files and/or directories that contain
1.411 +# documented source files. You may enter file names like "myfile.cpp" or
1.412 +# directories like "/usr/src/myproject". Separate the files or directories
1.413 +# with spaces.
1.414 +
1.415 INPUT = ../src/demo/alpar/emptygraph.h \
1.416 ../src/doxy/invalid.h \
1.417 ../src/demo/alpar/smart_graph.h \
1.418 @@ -64,151 +398,729 @@
1.419 ../src/demo/alpar/dijkstra/dijkstra.h \
1.420 ../src/demo/alpar/dijkstra/bin_heap.hh \
1.421 ../src/demo/alpar/dijkstra/fib_heap.h \
1.422 + ../src/demo/athos/xy/xy.h \
1.423 + ../src/demo/athos/xy/boundingbox.h \
1.424 maps.dox
1.425 +
1.426 +# If the value of the INPUT tag contains directories, you can use the
1.427 +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
1.428 +# and *.h) to filter out the source-files in the directories. If left
1.429 +# blank the following patterns are tested:
1.430 +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
1.431 +# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
1.432 +
1.433 FILE_PATTERNS =
1.434 +
1.435 +# The RECURSIVE tag can be used to turn specify whether or not subdirectories
1.436 +# should be searched for input files as well. Possible values are YES and NO.
1.437 +# If left blank NO is used.
1.438 +
1.439 RECURSIVE = NO
1.440 +
1.441 +# The EXCLUDE tag can be used to specify files and/or directories that should
1.442 +# excluded from the INPUT source files. This way you can easily exclude a
1.443 +# subdirectory from a directory tree whose root is specified with the INPUT tag.
1.444 +
1.445 EXCLUDE =
1.446 +
1.447 +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
1.448 +# that are symbolic links (a Unix filesystem feature) are excluded from the input.
1.449 +
1.450 EXCLUDE_SYMLINKS = NO
1.451 +
1.452 +# If the value of the INPUT tag contains directories, you can use the
1.453 +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
1.454 +# certain files from those directories.
1.455 +
1.456 EXCLUDE_PATTERNS =
1.457 +
1.458 +# The EXAMPLE_PATH tag can be used to specify one or more files or
1.459 +# directories that contain example code fragments that are included (see
1.460 +# the \include command).
1.461 +
1.462 EXAMPLE_PATH = examples
1.463 +
1.464 +# If the value of the EXAMPLE_PATH tag contains directories, you can use the
1.465 +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
1.466 +# and *.h) to filter out the source-files in the directories. If left
1.467 +# blank all files are included.
1.468 +
1.469 EXAMPLE_PATTERNS =
1.470 +
1.471 +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1.472 +# searched for input files to be used with the \include or \dontinclude
1.473 +# commands irrespective of the value of the RECURSIVE tag.
1.474 +# Possible values are YES and NO. If left blank NO is used.
1.475 +
1.476 EXAMPLE_RECURSIVE = NO
1.477 +
1.478 +# The IMAGE_PATH tag can be used to specify one or more files or
1.479 +# directories that contain image that are included in the documentation (see
1.480 +# the \image command).
1.481 +
1.482 IMAGE_PATH =
1.483 +
1.484 +# The INPUT_FILTER tag can be used to specify a program that doxygen should
1.485 +# invoke to filter for each input file. Doxygen will invoke the filter program
1.486 +# by executing (via popen()) the command <filter> <input-file>, where <filter>
1.487 +# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
1.488 +# input file. Doxygen will then use the output that the filter program writes
1.489 +# to standard output.
1.490 +
1.491 INPUT_FILTER =
1.492 +
1.493 +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1.494 +# INPUT_FILTER) will be used to filter the input files when producing source
1.495 +# files to browse (i.e. when SOURCE_BROWSER is set to YES).
1.496 +
1.497 FILTER_SOURCE_FILES = NO
1.498 +
1.499 #---------------------------------------------------------------------------
1.500 # configuration options related to source browsing
1.501 #---------------------------------------------------------------------------
1.502 +
1.503 +# If the SOURCE_BROWSER tag is set to YES then a list of source files will
1.504 +# be generated. Documented entities will be cross-referenced with these sources.
1.505 +# Note: To get rid of all source code in the generated output, make sure also
1.506 +# VERBATIM_HEADERS is set to NO.
1.507 +
1.508 SOURCE_BROWSER = YES
1.509 +
1.510 +# Setting the INLINE_SOURCES tag to YES will include the body
1.511 +# of functions and classes directly in the documentation.
1.512 +
1.513 INLINE_SOURCES = NO
1.514 +
1.515 +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
1.516 +# doxygen to hide any special comment blocks from generated source code
1.517 +# fragments. Normal C and C++ comments will always remain visible.
1.518 +
1.519 STRIP_CODE_COMMENTS = YES
1.520 +
1.521 +# If the REFERENCED_BY_RELATION tag is set to YES (the default)
1.522 +# then for each documented function all documented
1.523 +# functions referencing it will be listed.
1.524 +
1.525 REFERENCED_BY_RELATION = YES
1.526 +
1.527 +# If the REFERENCES_RELATION tag is set to YES (the default)
1.528 +# then for each documented function all documented entities
1.529 +# called/used by that function will be listed.
1.530 +
1.531 REFERENCES_RELATION = YES
1.532 +
1.533 +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
1.534 +# will generate a verbatim copy of the header file for each class for
1.535 +# which an include is specified. Set to NO to disable this.
1.536 +
1.537 VERBATIM_HEADERS = YES
1.538 +
1.539 #---------------------------------------------------------------------------
1.540 # configuration options related to the alphabetical class index
1.541 #---------------------------------------------------------------------------
1.542 +
1.543 +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
1.544 +# of all compounds will be generated. Enable this if the project
1.545 +# contains a lot of classes, structs, unions or interfaces.
1.546 +
1.547 ALPHABETICAL_INDEX = YES
1.548 +
1.549 +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
1.550 +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
1.551 +# in which this list will be split (can be a number in the range [1..20])
1.552 +
1.553 COLS_IN_ALPHA_INDEX = 2
1.554 +
1.555 +# In case all classes in a project start with a common prefix, all
1.556 +# classes will be put under the same header in the alphabetical index.
1.557 +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
1.558 +# should be ignored while generating the index headers.
1.559 +
1.560 IGNORE_PREFIX =
1.561 +
1.562 #---------------------------------------------------------------------------
1.563 # configuration options related to the HTML output
1.564 #---------------------------------------------------------------------------
1.565 +
1.566 +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
1.567 +# generate HTML output.
1.568 +
1.569 GENERATE_HTML = YES
1.570 +
1.571 +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
1.572 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1.573 +# put in front of it. If left blank `html' will be used as the default path.
1.574 +
1.575 HTML_OUTPUT = html
1.576 +
1.577 +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
1.578 +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
1.579 +# doxygen will generate files with .html extension.
1.580 +
1.581 HTML_FILE_EXTENSION = .html
1.582 +
1.583 +# The HTML_HEADER tag can be used to specify a personal HTML header for
1.584 +# each generated HTML page. If it is left blank doxygen will generate a
1.585 +# standard header.
1.586 +
1.587 HTML_HEADER =
1.588 +
1.589 +# The HTML_FOOTER tag can be used to specify a personal HTML footer for
1.590 +# each generated HTML page. If it is left blank doxygen will generate a
1.591 +# standard footer.
1.592 +
1.593 HTML_FOOTER =
1.594 +
1.595 +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
1.596 +# style sheet that is used by each HTML page. It can be used to
1.597 +# fine-tune the look of the HTML output. If the tag is left blank doxygen
1.598 +# will generate a default style sheet. Note that doxygen will try to copy
1.599 +# the style sheet file to the HTML output directory, so don't put your own
1.600 +# stylesheet in the HTML output directory as well, or it will be erased!
1.601 +
1.602 HTML_STYLESHEET =
1.603 +
1.604 +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
1.605 +# files or namespaces will be aligned in HTML using tables. If set to
1.606 +# NO a bullet list will be used.
1.607 +
1.608 HTML_ALIGN_MEMBERS = YES
1.609 +
1.610 +# If the GENERATE_HTMLHELP tag is set to YES, additional index files
1.611 +# will be generated that can be used as input for tools like the
1.612 +# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
1.613 +# of the generated HTML documentation.
1.614 +
1.615 GENERATE_HTMLHELP = NO
1.616 +
1.617 +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1.618 +# be used to specify the file name of the resulting .chm file. You
1.619 +# can add a path in front of the file if the result should not be
1.620 +# written to the html output directory.
1.621 +
1.622 CHM_FILE =
1.623 +
1.624 +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1.625 +# be used to specify the location (absolute path including file name) of
1.626 +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1.627 +# the HTML help compiler on the generated index.hhp.
1.628 +
1.629 HHC_LOCATION =
1.630 +
1.631 +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1.632 +# controls if a separate .chi index file is generated (YES) or that
1.633 +# it should be included in the master .chm file (NO).
1.634 +
1.635 GENERATE_CHI = NO
1.636 +
1.637 +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1.638 +# controls whether a binary table of contents is generated (YES) or a
1.639 +# normal table of contents (NO) in the .chm file.
1.640 +
1.641 BINARY_TOC = NO
1.642 +
1.643 +# The TOC_EXPAND flag can be set to YES to add extra items for group members
1.644 +# to the contents of the HTML help documentation and to the tree view.
1.645 +
1.646 TOC_EXPAND = NO
1.647 +
1.648 +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1.649 +# top of each HTML page. The value NO (the default) enables the index and
1.650 +# the value YES disables it.
1.651 +
1.652 DISABLE_INDEX = NO
1.653 +
1.654 +# This tag can be used to set the number of enum values (range [1..20])
1.655 +# that doxygen will group on one line in the generated HTML documentation.
1.656 +
1.657 ENUM_VALUES_PER_LINE = 4
1.658 +
1.659 +# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
1.660 +# generated containing a tree-like index structure (just like the one that
1.661 +# is generated for HTML Help). For this to work a browser that supports
1.662 +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
1.663 +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
1.664 +# probably better off using the HTML help feature.
1.665 +
1.666 GENERATE_TREEVIEW = YES
1.667 +
1.668 +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1.669 +# used to set the initial width (in pixels) of the frame in which the tree
1.670 +# is shown.
1.671 +
1.672 TREEVIEW_WIDTH = 250
1.673 +
1.674 #---------------------------------------------------------------------------
1.675 # configuration options related to the LaTeX output
1.676 #---------------------------------------------------------------------------
1.677 +
1.678 +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1.679 +# generate Latex output.
1.680 +
1.681 GENERATE_LATEX = YES
1.682 +
1.683 +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1.684 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1.685 +# put in front of it. If left blank `latex' will be used as the default path.
1.686 +
1.687 LATEX_OUTPUT = latex
1.688 +
1.689 +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1.690 +# invoked. If left blank `latex' will be used as the default command name.
1.691 +
1.692 LATEX_CMD_NAME = latex
1.693 +
1.694 +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1.695 +# generate index for LaTeX. If left blank `makeindex' will be used as the
1.696 +# default command name.
1.697 +
1.698 MAKEINDEX_CMD_NAME = makeindex
1.699 +
1.700 +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1.701 +# LaTeX documents. This may be useful for small projects and may help to
1.702 +# save some trees in general.
1.703 +
1.704 COMPACT_LATEX = YES
1.705 +
1.706 +# The PAPER_TYPE tag can be used to set the paper type that is used
1.707 +# by the printer. Possible values are: a4, a4wide, letter, legal and
1.708 +# executive. If left blank a4wide will be used.
1.709 +
1.710 PAPER_TYPE = a4wide
1.711 +
1.712 +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1.713 +# packages that should be included in the LaTeX output.
1.714 +
1.715 EXTRA_PACKAGES =
1.716 +
1.717 +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1.718 +# the generated latex document. The header should contain everything until
1.719 +# the first chapter. If it is left blank doxygen will generate a
1.720 +# standard header. Notice: only use this tag if you know what you are doing!
1.721 +
1.722 LATEX_HEADER =
1.723 +
1.724 +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1.725 +# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1.726 +# contain links (just like the HTML output) instead of page references
1.727 +# This makes the output suitable for online browsing using a pdf viewer.
1.728 +
1.729 PDF_HYPERLINKS = YES
1.730 +
1.731 +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1.732 +# plain latex in the generated Makefile. Set this option to YES to get a
1.733 +# higher quality PDF documentation.
1.734 +
1.735 USE_PDFLATEX = YES
1.736 +
1.737 +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1.738 +# command to the generated LaTeX files. This will instruct LaTeX to keep
1.739 +# running if errors occur, instead of asking the user for help.
1.740 +# This option is also used when generating formulas in HTML.
1.741 +
1.742 LATEX_BATCHMODE = NO
1.743 +
1.744 +# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1.745 +# include the index chapters (such as File Index, Compound Index, etc.)
1.746 +# in the output.
1.747 +
1.748 LATEX_HIDE_INDICES = NO
1.749 +
1.750 #---------------------------------------------------------------------------
1.751 # configuration options related to the RTF output
1.752 #---------------------------------------------------------------------------
1.753 +
1.754 +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1.755 +# The RTF output is optimized for Word 97 and may not look very pretty with
1.756 +# other RTF readers or editors.
1.757 +
1.758 GENERATE_RTF = NO
1.759 +
1.760 +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1.761 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1.762 +# put in front of it. If left blank `rtf' will be used as the default path.
1.763 +
1.764 RTF_OUTPUT = rtf
1.765 +
1.766 +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1.767 +# RTF documents. This may be useful for small projects and may help to
1.768 +# save some trees in general.
1.769 +
1.770 COMPACT_RTF = NO
1.771 +
1.772 +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1.773 +# will contain hyperlink fields. The RTF file will
1.774 +# contain links (just like the HTML output) instead of page references.
1.775 +# This makes the output suitable for online browsing using WORD or other
1.776 +# programs which support those fields.
1.777 +# Note: wordpad (write) and others do not support links.
1.778 +
1.779 RTF_HYPERLINKS = NO
1.780 +
1.781 +# Load stylesheet definitions from file. Syntax is similar to doxygen's
1.782 +# config file, i.e. a series of assignments. You only have to provide
1.783 +# replacements, missing definitions are set to their default value.
1.784 +
1.785 RTF_STYLESHEET_FILE =
1.786 +
1.787 +# Set optional variables used in the generation of an rtf document.
1.788 +# Syntax is similar to doxygen's config file.
1.789 +
1.790 RTF_EXTENSIONS_FILE =
1.791 +
1.792 #---------------------------------------------------------------------------
1.793 # configuration options related to the man page output
1.794 #---------------------------------------------------------------------------
1.795 +
1.796 +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1.797 +# generate man pages
1.798 +
1.799 GENERATE_MAN = NO
1.800 +
1.801 +# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1.802 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1.803 +# put in front of it. If left blank `man' will be used as the default path.
1.804 +
1.805 MAN_OUTPUT = man
1.806 +
1.807 +# The MAN_EXTENSION tag determines the extension that is added to
1.808 +# the generated man pages (default is the subroutine's section .3)
1.809 +
1.810 MAN_EXTENSION = .3
1.811 +
1.812 +# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1.813 +# then it will generate one additional man file for each entity
1.814 +# documented in the real man page(s). These additional files
1.815 +# only source the real man page, but without them the man command
1.816 +# would be unable to find the correct page. The default is NO.
1.817 +
1.818 MAN_LINKS = NO
1.819 +
1.820 #---------------------------------------------------------------------------
1.821 # configuration options related to the XML output
1.822 #---------------------------------------------------------------------------
1.823 +
1.824 +# If the GENERATE_XML tag is set to YES Doxygen will
1.825 +# generate an XML file that captures the structure of
1.826 +# the code including all documentation.
1.827 +
1.828 GENERATE_XML = NO
1.829 +
1.830 +# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1.831 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1.832 +# put in front of it. If left blank `xml' will be used as the default path.
1.833 +
1.834 XML_OUTPUT = xml
1.835 +
1.836 +# The XML_SCHEMA tag can be used to specify an XML schema,
1.837 +# which can be used by a validating XML parser to check the
1.838 +# syntax of the XML files.
1.839 +
1.840 XML_SCHEMA =
1.841 +
1.842 +# The XML_DTD tag can be used to specify an XML DTD,
1.843 +# which can be used by a validating XML parser to check the
1.844 +# syntax of the XML files.
1.845 +
1.846 XML_DTD =
1.847 +
1.848 +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1.849 +# dump the program listings (including syntax highlighting
1.850 +# and cross-referencing information) to the XML output. Note that
1.851 +# enabling this will significantly increase the size of the XML output.
1.852 +
1.853 +XML_PROGRAMLISTING = YES
1.854 +
1.855 #---------------------------------------------------------------------------
1.856 # configuration options for the AutoGen Definitions output
1.857 #---------------------------------------------------------------------------
1.858 +
1.859 +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1.860 +# generate an AutoGen Definitions (see autogen.sf.net) file
1.861 +# that captures the structure of the code including all
1.862 +# documentation. Note that this feature is still experimental
1.863 +# and incomplete at the moment.
1.864 +
1.865 GENERATE_AUTOGEN_DEF = NO
1.866 +
1.867 #---------------------------------------------------------------------------
1.868 # configuration options related to the Perl module output
1.869 #---------------------------------------------------------------------------
1.870 +
1.871 +# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1.872 +# generate a Perl module file that captures the structure of
1.873 +# the code including all documentation. Note that this
1.874 +# feature is still experimental and incomplete at the
1.875 +# moment.
1.876 +
1.877 GENERATE_PERLMOD = NO
1.878 +
1.879 +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1.880 +# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1.881 +# to generate PDF and DVI output from the Perl module output.
1.882 +
1.883 PERLMOD_LATEX = NO
1.884 +
1.885 +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1.886 +# nicely formatted so it can be parsed by a human reader. This is useful
1.887 +# if you want to understand what is going on. On the other hand, if this
1.888 +# tag is set to NO the size of the Perl module output will be much smaller
1.889 +# and Perl will parse it just the same.
1.890 +
1.891 PERLMOD_PRETTY = YES
1.892 +
1.893 +# The names of the make variables in the generated doxyrules.make file
1.894 +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1.895 +# This is useful so different doxyrules.make files included by the same
1.896 +# Makefile don't overwrite each other's variables.
1.897 +
1.898 PERLMOD_MAKEVAR_PREFIX =
1.899 +
1.900 #---------------------------------------------------------------------------
1.901 # Configuration options related to the preprocessor
1.902 #---------------------------------------------------------------------------
1.903 +
1.904 +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1.905 +# evaluate all C-preprocessor directives found in the sources and include
1.906 +# files.
1.907 +
1.908 ENABLE_PREPROCESSING = YES
1.909 +
1.910 +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1.911 +# names in the source code. If set to NO (the default) only conditional
1.912 +# compilation will be performed. Macro expansion can be done in a controlled
1.913 +# way by setting EXPAND_ONLY_PREDEF to YES.
1.914 +
1.915 MACRO_EXPANSION = NO
1.916 +
1.917 +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1.918 +# then the macro expansion is limited to the macros specified with the
1.919 +# PREDEFINED and EXPAND_AS_PREDEFINED tags.
1.920 +
1.921 EXPAND_ONLY_PREDEF = NO
1.922 +
1.923 +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1.924 +# in the INCLUDE_PATH (see below) will be search if a #include is found.
1.925 +
1.926 SEARCH_INCLUDES = YES
1.927 +
1.928 +# The INCLUDE_PATH tag can be used to specify one or more directories that
1.929 +# contain include files that are not input files but should be processed by
1.930 +# the preprocessor.
1.931 +
1.932 INCLUDE_PATH =
1.933 +
1.934 +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1.935 +# patterns (like *.h and *.hpp) to filter out the header-files in the
1.936 +# directories. If left blank, the patterns specified with FILE_PATTERNS will
1.937 +# be used.
1.938 +
1.939 INCLUDE_FILE_PATTERNS =
1.940 +
1.941 +# The PREDEFINED tag can be used to specify one or more macro names that
1.942 +# are defined before the preprocessor is started (similar to the -D option of
1.943 +# gcc). The argument of the tag is a list of macros of the form: name
1.944 +# or name=definition (no spaces). If the definition and the = are
1.945 +# omitted =1 is assumed.
1.946 +
1.947 PREDEFINED = DOXYGEN
1.948 +
1.949 +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1.950 +# this tag can be used to specify a list of macro names that should be expanded.
1.951 +# The macro definition that is found in the sources will be used.
1.952 +# Use the PREDEFINED tag if you want to use a different macro definition.
1.953 +
1.954 EXPAND_AS_DEFINED =
1.955 +
1.956 +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1.957 +# doxygen's preprocessor will remove all function-like macros that are alone
1.958 +# on a line, have an all uppercase name, and do not end with a semicolon. Such
1.959 +# function macros are typically used for boiler-plate code, and will confuse the
1.960 +# parser if not removed.
1.961 +
1.962 SKIP_FUNCTION_MACROS = YES
1.963 +
1.964 #---------------------------------------------------------------------------
1.965 -# Configuration::addtions related to external references
1.966 +# Configuration::additions related to external references
1.967 #---------------------------------------------------------------------------
1.968 +
1.969 +# The TAGFILES option can be used to specify one or more tagfiles.
1.970 +# Optionally an initial location of the external documentation
1.971 +# can be added for each tagfile. The format of a tag file without
1.972 +# this location is as follows:
1.973 +# TAGFILES = file1 file2 ...
1.974 +# Adding location for the tag files is done as follows:
1.975 +# TAGFILES = file1=loc1 "file2 = loc2" ...
1.976 +# where "loc1" and "loc2" can be relative or absolute paths or
1.977 +# URLs. If a location is present for each tag, the installdox tool
1.978 +# does not have to be run to correct the links.
1.979 +# Note that each tag file must have a unique name
1.980 +# (where the name does NOT include the path)
1.981 +# If a tag file is not located in the directory in which doxygen
1.982 +# is run, you must also specify the path to the tagfile here.
1.983 +
1.984 TAGFILES =
1.985 +
1.986 +# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1.987 +# a tag file that is based on the input files it reads.
1.988 +
1.989 GENERATE_TAGFILE =
1.990 +
1.991 +# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1.992 +# in the class index. If set to NO only the inherited external classes
1.993 +# will be listed.
1.994 +
1.995 ALLEXTERNALS = NO
1.996 +
1.997 +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1.998 +# in the modules index. If set to NO, only the current project's groups will
1.999 +# be listed.
1.1000 +
1.1001 EXTERNAL_GROUPS = YES
1.1002 +
1.1003 +# The PERL_PATH should be the absolute path and name of the perl script
1.1004 +# interpreter (i.e. the result of `which perl').
1.1005 +
1.1006 PERL_PATH = /usr/bin/perl
1.1007 +
1.1008 #---------------------------------------------------------------------------
1.1009 # Configuration options related to the dot tool
1.1010 #---------------------------------------------------------------------------
1.1011 +
1.1012 +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1.1013 +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
1.1014 +# super classes. Setting the tag to NO turns the diagrams off. Note that this
1.1015 +# option is superseded by the HAVE_DOT option below. This is only a fallback. It is
1.1016 +# recommended to install and use dot, since it yields more powerful graphs.
1.1017 +
1.1018 CLASS_DIAGRAMS = YES
1.1019 +
1.1020 +# If set to YES, the inheritance and collaboration graphs will hide
1.1021 +# inheritance and usage relations if the target is undocumented
1.1022 +# or is not a class.
1.1023 +
1.1024 HIDE_UNDOC_RELATIONS = NO
1.1025 +
1.1026 +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1.1027 +# available from the path. This tool is part of Graphviz, a graph visualization
1.1028 +# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1.1029 +# have no effect if this option is set to NO (the default)
1.1030 +
1.1031 HAVE_DOT = YES
1.1032 +
1.1033 +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1.1034 +# will generate a graph for each documented class showing the direct and
1.1035 +# indirect inheritance relations. Setting this tag to YES will force the
1.1036 +# the CLASS_DIAGRAMS tag to NO.
1.1037 +
1.1038 CLASS_GRAPH = YES
1.1039 +
1.1040 +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1.1041 +# will generate a graph for each documented class showing the direct and
1.1042 +# indirect implementation dependencies (inheritance, containment, and
1.1043 +# class references variables) of the class with other documented classes.
1.1044 +
1.1045 COLLABORATION_GRAPH = YES
1.1046 +
1.1047 +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1.1048 +# collaboration diagrams in a style similar to the OMG's Unified Modeling
1.1049 +# Language.
1.1050 +
1.1051 UML_LOOK = NO
1.1052 +
1.1053 +# If set to YES, the inheritance and collaboration graphs will show the
1.1054 +# relations between templates and their instances.
1.1055 +
1.1056 TEMPLATE_RELATIONS = YES
1.1057 +
1.1058 +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1.1059 +# tags are set to YES then doxygen will generate a graph for each documented
1.1060 +# file showing the direct and indirect include dependencies of the file with
1.1061 +# other documented files.
1.1062 +
1.1063 INCLUDE_GRAPH = YES
1.1064 +
1.1065 +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1.1066 +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1.1067 +# documented header file showing the documented files that directly or
1.1068 +# indirectly include this file.
1.1069 +
1.1070 INCLUDED_BY_GRAPH = YES
1.1071 +
1.1072 +# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1.1073 +# generate a call dependency graph for every global function or class method.
1.1074 +# Note that enabling this option will significantly increase the time of a run.
1.1075 +# So in most cases it will be better to enable call graphs for selected
1.1076 +# functions only using the \callgraph command.
1.1077 +
1.1078 CALL_GRAPH = YES
1.1079 +
1.1080 +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1.1081 +# will graphical hierarchy of all classes instead of a textual one.
1.1082 +
1.1083 GRAPHICAL_HIERARCHY = YES
1.1084 +
1.1085 +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1.1086 +# generated by dot. Possible values are png, jpg, or gif
1.1087 +# If left blank png will be used.
1.1088 +
1.1089 DOT_IMAGE_FORMAT = png
1.1090 +
1.1091 +# The tag DOT_PATH can be used to specify the path where the dot tool can be
1.1092 +# found. If left blank, it is assumed the dot tool can be found on the path.
1.1093 +
1.1094 DOT_PATH =
1.1095 +
1.1096 +# The DOTFILE_DIRS tag can be used to specify one or more directories that
1.1097 +# contain dot files that are included in the documentation (see the
1.1098 +# \dotfile command).
1.1099 +
1.1100 DOTFILE_DIRS =
1.1101 +
1.1102 +# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1.1103 +# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1.1104 +# this value, doxygen will try to truncate the graph, so that it fits within
1.1105 +# the specified constraint. Beware that most browsers cannot cope with very
1.1106 +# large images.
1.1107 +
1.1108 MAX_DOT_GRAPH_WIDTH = 1024
1.1109 +
1.1110 +# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1.1111 +# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1.1112 +# this value, doxygen will try to truncate the graph, so that it fits within
1.1113 +# the specified constraint. Beware that most browsers cannot cope with very
1.1114 +# large images.
1.1115 +
1.1116 MAX_DOT_GRAPH_HEIGHT = 1024
1.1117 +
1.1118 +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1.1119 +# graphs generated by dot. A depth value of 3 means that only nodes reachable
1.1120 +# from the root by following a path via at most 3 edges will be shown. Nodes that
1.1121 +# lay further from the root node will be omitted. Note that setting this option to
1.1122 +# 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1.1123 +# note that a graph may be further truncated if the graph's image dimensions are
1.1124 +# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1.1125 +# If 0 is used for the depth value (the default), the graph is not depth-constrained.
1.1126 +
1.1127 MAX_DOT_GRAPH_DEPTH = 0
1.1128 +
1.1129 +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1.1130 +# generate a legend page explaining the meaning of the various boxes and
1.1131 +# arrows in the dot generated graphs.
1.1132 +
1.1133 GENERATE_LEGEND = YES
1.1134 +
1.1135 +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1.1136 +# remove the intermediate dot files that are used to generate
1.1137 +# the various graphs.
1.1138 +
1.1139 DOT_CLEANUP = YES
1.1140 +
1.1141 #---------------------------------------------------------------------------
1.1142 -# Configuration::addtions related to the search engine
1.1143 +# Configuration::additions related to the search engine
1.1144 #---------------------------------------------------------------------------
1.1145 +
1.1146 +# The SEARCHENGINE tag specifies whether or not a search engine should be
1.1147 +# used. If set to NO the values of all tags below this one will be ignored.
1.1148 +
1.1149 SEARCHENGINE = YES
1.1150 -CGI_NAME = search.cgi
1.1151 -CGI_URL =
1.1152 -DOC_URL =
1.1153 -DOC_ABSPATH =
1.1154 -BIN_ABSPATH = /usr/local/bin/
1.1155 -EXT_DOC_PATHS =
2.1 --- a/src/work/alpar/dijkstra/bin_heap.hh Wed Mar 24 09:36:21 2004 +0000
2.2 +++ b/src/work/alpar/dijkstra/bin_heap.hh Wed Mar 24 13:06:06 2004 +0000
2.3 @@ -59,6 +59,9 @@
2.4 #ifndef BIN_HEAP_HH
2.5 #define BIN_HEAP_HH
2.6
2.7 +///\file
2.8 +///\brief Binary Heap implementation.
2.9 +
2.10 #include <vector>
2.11 #include <utility>
2.12 #include <functional>
3.1 --- a/src/work/alpar/dijkstra/dijkstra.h Wed Mar 24 09:36:21 2004 +0000
3.2 +++ b/src/work/alpar/dijkstra/dijkstra.h Wed Mar 24 13:06:06 2004 +0000
3.3 @@ -1,4 +1,5 @@
3.4 // -*- C++ -*-
3.5 +
3.6 /*
3.7 *template <Graph, T, Heap=FibHeap, LengthMap=Graph::EdgeMap<T> >
3.8 *
3.9 @@ -26,6 +27,9 @@
3.10 #ifndef HUGO_DIJKSTRA_H
3.11 #define HUGO_DIJKSTRA_H
3.12
3.13 +///\file
3.14 +///\brief Dijkstra algorithm.
3.15 +
3.16 #include <fib_heap.h>
3.17 #include <bin_heap.hh>
3.18 #include <invalid.h>
3.19 @@ -43,21 +47,31 @@
3.20 ///
3.21 ///The type of the length is determined by the \c ValueType of the length map.
3.22 ///
3.23 - ///It is also posible to change the underlying priority heap.
3.24 + ///It is also possible to change the underlying priority heap.
3.25 ///
3.26 ///\param Graph The graph type the algorithm runs on.
3.27 - ///\param LengthMap This read-only EdgeMap determines the
3.28 + ///\param LengthMap This read-only
3.29 + ///EdgeMap
3.30 + ///determines the
3.31 ///lengths of the edges. It is read once for each edge, so the map
3.32 ///may involve in relatively time consuming process to compute the edge
3.33 - ///length if it is necessary.
3.34 + ///length if it is necessary. The default map type is
3.35 + ///\ref GraphSkeleton::EdgeMap "Graph::EdgeMap<int>"
3.36 ///\param Heap The heap type used by the %Dijkstra
3.37 ///algorithm. The default
3.38 ///is using \ref BinHeap "binary heap".
3.39 +
3.40 +#ifdef DOXYGEN
3.41 + template <typename Graph,
3.42 + typename LengthMap,
3.43 + typename Heap>
3.44 +#else
3.45 template <typename Graph,
3.46 typename LengthMap=typename Graph::EdgeMap<int>,
3.47 typename Heap=BinHeap <typename Graph::Node,
3.48 typename LengthMap::ValueType,
3.49 typename Graph::NodeMap<int> > >
3.50 +#endif
3.51 class Dijkstra{
3.52 public:
3.53 typedef typename Graph::Node Node;
3.54 @@ -135,7 +149,7 @@
3.55
3.56 // bool reached(Node v) { return reach[v]; }
3.57
3.58 - ///Chechs if a node is reachable from the source.
3.59 + ///Checks if a node is reachable from the source.
3.60
3.61 ///Returns \c true if \c v is reachable from the source.
3.62 ///\warning the source node is reported to be unreached!
4.1 --- a/src/work/alpar/dijkstra/fib_heap.h Wed Mar 24 09:36:21 2004 +0000
4.2 +++ b/src/work/alpar/dijkstra/fib_heap.h Wed Mar 24 13:06:06 2004 +0000
4.3 @@ -51,6 +51,9 @@
4.4 #ifndef FIB_HEAP_H
4.5 #define FIB_HEAP_H
4.6
4.7 +///\file
4.8 +///\brief Fibonacci Heap implementation.
4.9 +
4.10 #include <vector>
4.11 #include <functional>
4.12 #include <math.h>
4.13 @@ -73,7 +76,7 @@
4.14 int num_items;
4.15
4.16 ///\todo It is use nowhere
4.17 - ///\todo It doesn't conforms to the naming conventions.
4.18 + ///\todo It doesn't conform to the naming conventions.
4.19 public:
4.20 enum state_enum {
4.21 IN_HEAP = 0,
5.1 --- a/src/work/alpar/emptygraph.h Wed Mar 24 09:36:21 2004 +0000
5.2 +++ b/src/work/alpar/emptygraph.h Wed Mar 24 13:06:06 2004 +0000
5.3 @@ -2,6 +2,9 @@
5.4 #ifndef HUGO_EMPTYGRAPH_H
5.5 #define HUGO_EMPTYGRAPH_H
5.6
5.7 +///\file
5.8 +///\brief Declaration of GraphSkeleton.
5.9 +
5.10 #include <invalid.h>
5.11
5.12 /// The namespace of HugoLib
5.13 @@ -12,9 +15,6 @@
5.14
5.15 /// An empty graph class.
5.16
5.17 - /// When you read this for the first time,
5.18 - /// please send an e-mail to alpar\@cs.elte.hu.
5.19 - ///
5.20 /// This class provides all the common features of a graph structure,
5.21 /// however completely without implementations and real data structures
5.22 /// behind the interface.
5.23 @@ -102,9 +102,9 @@
5.24 bool operator<(Edge n) const { return true; }
5.25 };
5.26
5.27 - /// This iterator goes trought the outgoing edges of a node.
5.28 + /// This iterator goes trough the outgoing edges of a node.
5.29
5.30 - /// This iterator goes trought the \e outgoing edges of a certain node
5.31 + /// This iterator goes trough the \e outgoing edges of a certain node
5.32 /// of a graph.
5.33 /// Its usage is quite simple, for example you can count the number
5.34 /// of outgoing edges of a node \c n
5.35 @@ -130,9 +130,9 @@
5.36 OutEdgeIt(const GraphSkeleton & G, Node n) {}
5.37 };
5.38
5.39 - /// This iterator goes trought the incoming edges of a node.
5.40 + /// This iterator goes trough the incoming edges of a node.
5.41
5.42 - /// This iterator goes trought the \e incoming edges of a certain node
5.43 + /// This iterator goes trough the \e incoming edges of a certain node
5.44 /// of a graph.
5.45 /// Its usage is quite simple, for example you can count the number
5.46 /// of outgoing edges of a node \c n
5.47 @@ -178,9 +178,9 @@
5.48 ///
5.49 NodeIt &first(NodeIt &i) const { return i;}
5.50
5.51 + /// The first incoming edge.
5.52 + InEdgeIt &first(InEdgeIt &i, Node n) const { return i;}
5.53 /// The first outgoing edge.
5.54 - InEdgeIt &first(InEdgeIt &i, Node n) const { return i;}
5.55 - /// The first incoming edge.
5.56 OutEdgeIt &first(OutEdgeIt &i, Node n) const { return i;}
5.57 // SymEdgeIt &first(SymEdgeIt &, Node) const { return i;}
5.58 /// The first edge of the Graph.
5.59 @@ -228,12 +228,12 @@
5.60
5.61 ///Gives back the \e id of a node.
5.62
5.63 - ///\warning Not all graph structure provide this feature.
5.64 + ///\warning Not all graph structures provide this feature.
5.65 ///
5.66 int id(const Node) const { return 0;}
5.67 ///Gives back the \e id of an edge.
5.68
5.69 - ///\warning Not all graph structure provide this feature.
5.70 + ///\warning Not all graph structures provide this feature.
5.71 ///
5.72 int id(const Edge) const { return 0;}
5.73
5.74 @@ -252,18 +252,7 @@
5.75 ///\return the new edge.
5.76 Edge addEdge(Node tail, Node head) { return INVALID;}
5.77
5.78 - /// Deletes a node.
5.79 -
5.80 - ///\warning Not all graph structure provide this feature.
5.81 - ///
5.82 - void erase(Node n) {}
5.83 - /// Deletes an edge.
5.84 -
5.85 - ///\warning Not all graph structure provide this feature.
5.86 - ///
5.87 - void erase(Edge e) {}
5.88 -
5.89 - /// Reset the graph.
5.90 + /// Resets the graph.
5.91
5.92 /// This function deletes all edges and nodes of the graph.
5.93 /// It also frees the memory allocated to store them.
5.94 @@ -271,11 +260,13 @@
5.95
5.96 int nodeNum() const { return 0;}
5.97 int edgeNum() const { return 0;}
5.98 -
5.99 +
5.100 + /// Defalult constructor.
5.101 GraphSkeleton() {}
5.102 + ///Copy consructor.
5.103 GraphSkeleton(const GraphSkeleton &G) {}
5.104
5.105 -
5.106 +
5.107
5.108 ///Read/write/reference map of the nodes to type \c T.
5.109
5.110 @@ -343,6 +334,40 @@
5.111 };
5.112 };
5.113
5.114 + /// An empty eraseable graph class.
5.115 +
5.116 + /// This class provides all the common features of an \e eraseable graph
5.117 + /// structure,
5.118 + /// however completely without implementations and real data structures
5.119 + /// behind the interface.
5.120 + /// All graph algorithms should compile with this class, but it will not
5.121 + /// run properly, of course.
5.122 + ///
5.123 + /// \todo This blabla could be replaced by a sepatate description about
5.124 + /// Skeletons.
5.125 + ///
5.126 + /// It can be used for checking the interface compatibility,
5.127 + /// or it can serve as a skeleton of a new graph structure.
5.128 + ///
5.129 + /// Also, you will find here the full documentation of a certain graph
5.130 + /// feature, the documentation of a real graph imlementation
5.131 + /// like @ref ListGraph or
5.132 + /// @ref SmartGraph will just refer to this structure.
5.133 + class EraseableGraphSkeleton : public GraphSkeleton
5.134 + {
5.135 + public:
5.136 + /// Deletes a node.
5.137 + void erase(Node n) {}
5.138 + /// Deletes an edge.
5.139 + void erase(Edge e) {}
5.140 +
5.141 + /// Defalult constructor.
5.142 + GraphSkeleton() {}
5.143 + ///Copy consructor.
5.144 + GraphSkeleton(const GraphSkeleton &G) {}
5.145 + };
5.146 +
5.147 +
5.148 // @}
5.149
5.150 } //namespace hugo
6.1 --- a/src/work/alpar/invalid.h Wed Mar 24 09:36:21 2004 +0000
6.2 +++ b/src/work/alpar/invalid.h Wed Mar 24 13:06:06 2004 +0000
6.3 @@ -3,6 +3,9 @@
6.4 #ifndef HUGO_INVALID_H
6.5 #define HUGO_INVALID_H
6.6
6.7 +///\file
6.8 +///\brief Definition of INVALID.
6.9 +
6.10 namespace hugo {
6.11
6.12 /// Dummy type to make it easier to make invalid iterators.
7.1 --- a/src/work/alpar/mapskeleton.h Wed Mar 24 09:36:21 2004 +0000
7.2 +++ b/src/work/alpar/mapskeleton.h Wed Mar 24 13:06:06 2004 +0000
7.3 @@ -2,6 +2,9 @@
7.4 #ifndef HUGO_MAPSKELETON_H
7.5 #define HUGO_MAPSKELETON_H
7.6
7.7 +///\file
7.8 +///\brief Map concepts checking classes for testing and documenting.
7.9 +
7.10 namespace hugo {
7.11
7.12 ///Readable map skeleton
8.1 --- a/src/work/alpar/smart_graph.h Wed Mar 24 09:36:21 2004 +0000
8.2 +++ b/src/work/alpar/smart_graph.h Wed Mar 24 13:06:06 2004 +0000
8.3 @@ -3,6 +3,9 @@
8.4 #ifndef HUGO_SMART_GRAPH_H
8.5 #define HUGO_SMART_GRAPH_H
8.6
8.7 +///\file
8.8 +///\brief SmartGraph and SymSmartGraph classes.
8.9 +
8.10 #include <vector>
8.11 #include <limits.h>
8.12
8.13 @@ -14,13 +17,10 @@
8.14
8.15 ///A smart graph class.
8.16
8.17 - /// When you read this for the first time,
8.18 - /// please send an e-mail to alpar\@cs.elte.hu.
8.19 - ///
8.20 ///This is a simple and fast graph implementation.
8.21 ///It is also quite memory efficient, but at the price
8.22 ///that <b> it does not support node and edge deletion</b>.
8.23 - ///Apart from this it conforms to the graph interface documented under
8.24 + ///It conforms to the graph interface documented under
8.25 ///the description of \ref GraphSkeleton.
8.26 ///\sa \ref GraphSkeleton.
8.27 class SmartGraph {
9.1 --- a/src/work/athos/xy/boundingbox.h Wed Mar 24 09:36:21 2004 +0000
9.2 +++ b/src/work/athos/xy/boundingbox.h Wed Mar 24 13:06:06 2004 +0000
9.3 @@ -1,8 +1,4 @@
9.4 // -*- c++ -*-
9.5 -/**
9.6 -Implementation of a bounding box of plainvectors.
9.7 -
9.8 -*/
9.9 #ifndef HUGO_BOUNDINGBOX_H
9.10 #define HUGO_BOUNDINGBOX_H
9.11
9.12 @@ -11,6 +7,10 @@
9.13
9.14 namespace hugo {
9.15
9.16 + /** \brief
9.17 + Implementation of a bounding box of plainvectors.
9.18 +
9.19 + */
9.20 template<typename T>
9.21 class BoundingBox {
9.22 xy<T> bottomleft, topright;
10.1 --- a/src/work/athos/xy/xy.h Wed Mar 24 09:36:21 2004 +0000
10.2 +++ b/src/work/athos/xy/xy.h Wed Mar 24 13:06:06 2004 +0000
10.3 @@ -1,8 +1,4 @@
10.4 // -*- c++ -*-
10.5 -/**
10.6 -2 dimensional vector (plainvector) implementation
10.7 -
10.8 -*/
10.9 #ifndef HUGO_XY_H
10.10 #define HUGO_XY_H
10.11
10.12 @@ -10,6 +6,10 @@
10.13
10.14 namespace hugo {
10.15
10.16 +/** \brief
10.17 +2 dimensional vector (plainvector) implementation
10.18 +
10.19 +*/
10.20 template<typename T>
10.21 class xy {
10.22