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