Blame cvc3-doc.patch

72c7f33
--- doc/Doxyfile.in.orig	2009-11-20 13:38:54.000000000 -0700
72c7f33
+++ doc/Doxyfile.in	2011-09-06 09:55:26.269553151 -0600
72c7f33
@@ -1,203 +1,242 @@
72c7f33
-# Doxyfile 1.5.2
72c7f33
+# Doxyfile 1.7.4
72c7f33
 
72c7f33
 # This file describes the settings to be used by the documentation system
72c7f33
-# doxygen (www.doxygen.org) for a project
72c7f33
+# doxygen (www.doxygen.org) for a project.
72c7f33
 #
72c7f33
-# All text after a hash (#) is considered a comment and will be ignored
72c7f33
+# All text after a hash (#) is considered a comment and will be ignored.
72c7f33
 # The format is:
72c7f33
 #       TAG = value [value, ...]
72c7f33
 # For lists items can also be appended using:
72c7f33
 #       TAG += value [value, ...]
72c7f33
-# Values that contain spaces should be placed between quotes (" ")
72c7f33
+# Values that contain spaces should be placed between quotes (" ").
72c7f33
 
72c7f33
 #---------------------------------------------------------------------------
72c7f33
 # Project related configuration options
72c7f33
 #---------------------------------------------------------------------------
72c7f33
 
72c7f33
-# This tag specifies the encoding used for all characters in the config file that 
72c7f33
-# follow. The default is UTF-8 which is also the encoding used for all text before 
72c7f33
-# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into 
72c7f33
-# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of 
72c7f33
-# possible encodings.
72c7f33
+# This tag specifies the encoding used for all characters in the config file
72c7f33
+# that follow. The default is UTF-8 which is also the encoding used for all
72c7f33
+# text before the first occurrence of this tag. Doxygen uses libiconv (or the
72c7f33
+# iconv built into libc) for the transcoding. See
72c7f33
+# http://www.gnu.org/software/libiconv for the list of possible encodings.
72c7f33
 
72c7f33
 DOXYFILE_ENCODING      = UTF-8
72c7f33
 
72c7f33
-# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
72c7f33
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
72c7f33
 # by quotes) that should identify the project.
72c7f33
 
72c7f33
 PROJECT_NAME           = CVC3
72c7f33
 
72c7f33
-# The PROJECT_NUMBER tag can be used to enter a project or revision number. 
72c7f33
-# This could be handy for archiving the generated documentation or 
72c7f33
+# The PROJECT_NUMBER tag can be used to enter a project or revision number.
72c7f33
+# This could be handy for archiving the generated documentation or
75fa8e5
 # if some version control system is used.
75fa8e5
 
75fa8e5
-PROJECT_NUMBER         = 
72c7f33
+PROJECT_NUMBER         = 2.4.1
72c7f33
 
72c7f33
-# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
72c7f33
-# base path where the generated documentation will be put. 
72c7f33
-# If a relative path is entered, it will be relative to the location 
72c7f33
+# Using the PROJECT_BRIEF tag one can provide an optional one line description
72c7f33
+# for a project that appears at the top of each page and should give viewer
72c7f33
+# a quick idea about the purpose of the project. Keep the description short.
72c7f33
+
72c7f33
+PROJECT_BRIEF          =
72c7f33
+
72c7f33
+# With the PROJECT_LOGO tag one can specify an logo or icon that is
72c7f33
+# included in the documentation. The maximum height of the logo should not
72c7f33
+# exceed 55 pixels and the maximum width should not exceed 200 pixels.
72c7f33
+# Doxygen will copy the logo to the output directory.
72c7f33
+
72c7f33
+PROJECT_LOGO           =
72c7f33
+
72c7f33
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
72c7f33
+# base path where the generated documentation will be put.
72c7f33
+# If a relative path is entered, it will be relative to the location
72c7f33
 # where doxygen was started. If left blank the current directory will be used.
72c7f33
 
72c7f33
-OUTPUT_DIRECTORY       = 
72c7f33
+OUTPUT_DIRECTORY       =
72c7f33
 
72c7f33
-# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
72c7f33
-# 4096 sub-directories (in 2 levels) under the output directory of each output 
72c7f33
-# format and will distribute the generated files over these directories. 
72c7f33
-# Enabling this option can be useful when feeding doxygen a huge amount of 
72c7f33
-# source files, where putting all generated files in the same directory would 
72c7f33
+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
72c7f33
+# 4096 sub-directories (in 2 levels) under the output directory of each output
72c7f33
+# format and will distribute the generated files over these directories.
72c7f33
+# Enabling this option can be useful when feeding doxygen a huge amount of
72c7f33
+# source files, where putting all generated files in the same directory would
72c7f33
 # otherwise cause performance problems for the file system.
72c7f33
 
72c7f33
 CREATE_SUBDIRS         = NO
72c7f33
 
72c7f33
-# The OUTPUT_LANGUAGE tag is used to specify the language in which all 
72c7f33
-# documentation generated by doxygen is written. Doxygen will use this 
72c7f33
-# information to generate all constant output in the proper language. 
72c7f33
-# The default language is English, other supported languages are: 
72c7f33
-# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
72c7f33
-# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, 
72c7f33
-# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, 
72c7f33
-# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, 
72c7f33
-# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
72c7f33
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
72c7f33
+# documentation generated by doxygen is written. Doxygen will use this
72c7f33
+# information to generate all constant output in the proper language.
72c7f33
+# The default language is English, other supported languages are:
72c7f33
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
72c7f33
+# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
72c7f33
+# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
72c7f33
+# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
72c7f33
+# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
72c7f33
+# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
72c7f33
 
72c7f33
 OUTPUT_LANGUAGE        = English
72c7f33
 
72c7f33
-# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
72c7f33
-# include brief member descriptions after the members that are listed in 
72c7f33
-# the file and class documentation (similar to JavaDoc). 
72c7f33
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
72c7f33
+# include brief member descriptions after the members that are listed in
72c7f33
+# the file and class documentation (similar to JavaDoc).
72c7f33
 # Set to NO to disable this.
72c7f33
 
72c7f33
 BRIEF_MEMBER_DESC      = YES
72c7f33
 
72c7f33
-# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
72c7f33
-# the brief description of a member or function before the detailed description. 
72c7f33
-# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
72c7f33
+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
72c7f33
+# the brief description of a member or function before the detailed description.
72c7f33
+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
72c7f33
 # brief descriptions will be completely suppressed.
72c7f33
 
72c7f33
 REPEAT_BRIEF           = YES
72c7f33
 
72c7f33
-# This tag implements a quasi-intelligent brief description abbreviator 
72c7f33
-# that is used to form the text in various listings. Each string 
72c7f33
-# in this list, if found as the leading text of the brief description, will be 
72c7f33
-# stripped from the text and the result after processing the whole list, is 
72c7f33
-# used as the annotated text. Otherwise, the brief description is used as-is. 
72c7f33
-# If left blank, the following values are used ("$name" is automatically 
72c7f33
-# replaced with the name of the entity): "The $name class" "The $name widget" 
72c7f33
-# "The $name file" "is" "provides" "specifies" "contains" 
72c7f33
+# This tag implements a quasi-intelligent brief description abbreviator
72c7f33
+# that is used to form the text in various listings. Each string
72c7f33
+# in this list, if found as the leading text of the brief description, will be
72c7f33
+# stripped from the text and the result after processing the whole list, is
72c7f33
+# used as the annotated text. Otherwise, the brief description is used as-is.
72c7f33
+# If left blank, the following values are used ("$name" is automatically
72c7f33
+# replaced with the name of the entity): "The $name class" "The $name widget"
72c7f33
+# "The $name file" "is" "provides" "specifies" "contains"
72c7f33
 # "represents" "a" "an" "the"
72c7f33
 
72c7f33
-ABBREVIATE_BRIEF       = 
72c7f33
+ABBREVIATE_BRIEF       =
72c7f33
 
72c7f33
-# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
72c7f33
-# Doxygen will generate a detailed section even if there is only a brief 
72c7f33
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
72c7f33
+# Doxygen will generate a detailed section even if there is only a brief
72c7f33
 # description.
72c7f33
 
72c7f33
 ALWAYS_DETAILED_SEC    = NO
72c7f33
 
72c7f33
-# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
72c7f33
-# inherited members of a class in the documentation of that class as if those 
72c7f33
-# members were ordinary class members. Constructors, destructors and assignment 
72c7f33
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
72c7f33
+# inherited members of a class in the documentation of that class as if those
72c7f33
+# members were ordinary class members. Constructors, destructors and assignment
72c7f33
 # operators of the base classes will not be shown.
72c7f33
 
72c7f33
 INLINE_INHERITED_MEMB  = NO
72c7f33
 
72c7f33
-# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
72c7f33
-# path before files name in the file list and in the header files. If set 
72c7f33
+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
72c7f33
+# path before files name in the file list and in the header files. If set
72c7f33
 # to NO the shortest path that makes the file name unique will be used.
72c7f33
 
72c7f33
 FULL_PATH_NAMES        = NO
72c7f33
 
72c7f33
-# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
72c7f33
-# can be used to strip a user-defined part of the path. Stripping is 
72c7f33
-# only done if one of the specified strings matches the left-hand part of 
72c7f33
-# the path. The tag can be used to show relative paths in the file list. 
72c7f33
-# If left blank the directory from which doxygen is run is used as the 
72c7f33
+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
72c7f33
+# can be used to strip a user-defined part of the path. Stripping is
72c7f33
+# only done if one of the specified strings matches the left-hand part of
72c7f33
+# the path. The tag can be used to show relative paths in the file list.
72c7f33
+# If left blank the directory from which doxygen is run is used as the
72c7f33
 # path to strip.
72c7f33
 
72c7f33
-STRIP_FROM_PATH        = 
72c7f33
+STRIP_FROM_PATH        =
72c7f33
 
72c7f33
-# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
72c7f33
-# the path mentioned in the documentation of a class, which tells 
72c7f33
-# the reader which header file to include in order to use a class. 
72c7f33
-# If left blank only the name of the header file containing the class 
72c7f33
-# definition is used. Otherwise one should specify the include paths that 
72c7f33
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
72c7f33
+# the path mentioned in the documentation of a class, which tells
72c7f33
+# the reader which header file to include in order to use a class.
72c7f33
+# If left blank only the name of the header file containing the class
72c7f33
+# definition is used. Otherwise one should specify the include paths that
72c7f33
 # are normally passed to the compiler using the -I flag.
72c7f33
 
72c7f33
-STRIP_FROM_INC_PATH    = 
72c7f33
+STRIP_FROM_INC_PATH    =
72c7f33
 
72c7f33
-# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
72c7f33
-# (but less readable) file names. This can be useful is your file systems 
72c7f33
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
72c7f33
+# (but less readable) file names. This can be useful if your file system
72c7f33
 # doesn't support long names like on DOS, Mac, or CD-ROM.
72c7f33
 
72c7f33
 SHORT_NAMES            = NO
72c7f33
 
72c7f33
-# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
72c7f33
-# will interpret the first line (until the first dot) of a JavaDoc-style 
72c7f33
-# comment as the brief description. If set to NO, the JavaDoc 
72c7f33
-# comments will behave just like the Qt-style comments (thus requiring an 
72c7f33
-# explicit @brief command for a brief description.
72c7f33
+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
72c7f33
+# will interpret the first line (until the first dot) of a JavaDoc-style
72c7f33
+# comment as the brief description. If set to NO, the JavaDoc
72c7f33
+# comments will behave just like regular Qt-style comments
72c7f33
+# (thus requiring an explicit @brief command for a brief description.)
72c7f33
 
72c7f33
 JAVADOC_AUTOBRIEF      = NO
72c7f33
 
72c7f33
-# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
72c7f33
-# treat a multi-line C++ special comment block (i.e. a block of //! or /// 
72c7f33
-# comments) as a brief description. This used to be the default behaviour. 
72c7f33
-# The new default is to treat a multi-line C++ comment block as a detailed 
72c7f33
-# description. Set this tag to YES if you prefer the old behaviour instead.
72c7f33
+# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
72c7f33
+# interpret the first line (until the first dot) of a Qt-style
72c7f33
+# comment as the brief description. If set to NO, the comments
72c7f33
+# will behave just like regular Qt-style comments (thus requiring
72c7f33
+# an explicit \brief command for a brief description.)
72c7f33
 
72c7f33
-MULTILINE_CPP_IS_BRIEF = NO
72c7f33
+QT_AUTOBRIEF           = NO
72c7f33
 
72c7f33
-# If the DETAILS_AT_TOP tag is set to YES then Doxygen 
72c7f33
-# will output the detailed description near the top, like JavaDoc.
72c7f33
-# If set to NO, the detailed description appears after the member 
72c7f33
-# documentation.
72c7f33
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
72c7f33
+# treat a multi-line C++ special comment block (i.e. a block of //! or ///
72c7f33
+# comments) as a brief description. This used to be the default behaviour.
72c7f33
+# The new default is to treat a multi-line C++ comment block as a detailed
72c7f33
+# description. Set this tag to YES if you prefer the old behaviour instead.
72c7f33
 
72c7f33
-DETAILS_AT_TOP         = NO
72c7f33
+MULTILINE_CPP_IS_BRIEF = NO
72c7f33
 
72c7f33
-# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
72c7f33
-# member inherits the documentation from any documented member that it 
72c7f33
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
72c7f33
+# member inherits the documentation from any documented member that it
72c7f33
 # re-implements.
72c7f33
 
72c7f33
 INHERIT_DOCS           = YES
72c7f33
 
72c7f33
-# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
72c7f33
-# a new page for each member. If set to NO, the documentation of a member will 
72c7f33
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
72c7f33
+# a new page for each member. If set to NO, the documentation of a member will
72c7f33
 # be part of the file/class/namespace that contains it.
72c7f33
 
72c7f33
 SEPARATE_MEMBER_PAGES  = NO
72c7f33
 
72c7f33
-# The TAB_SIZE tag can be used to set the number of spaces in a tab. 
72c7f33
+# The TAB_SIZE tag can be used to set the number of spaces in a tab.
72c7f33
 # Doxygen uses this value to replace tabs by spaces in code fragments.
72c7f33
 
72c7f33
 TAB_SIZE               = 2
72c7f33
 
72c7f33
-# This tag can be used to specify a number of aliases that acts 
72c7f33
-# as commands in the documentation. An alias has the form "name=value". 
72c7f33
-# For example adding "sideeffect=\par Side Effects:\n" will allow you to 
72c7f33
-# put the command \sideeffect (or @sideeffect) in the documentation, which 
72c7f33
-# will result in a user-defined paragraph with heading "Side Effects:". 
72c7f33
+# This tag can be used to specify a number of aliases that acts
72c7f33
+# as commands in the documentation. An alias has the form "name=value".
72c7f33
+# For example adding "sideeffect=\par Side Effects:\n" will allow you to
72c7f33
+# put the command \sideeffect (or @sideeffect) in the documentation, which
72c7f33
+# will result in a user-defined paragraph with heading "Side Effects:".
72c7f33
 # You can put \n's in the value part of an alias to insert newlines.
72c7f33
 
72c7f33
-ALIASES                = 
72c7f33
+ALIASES                =
72c7f33
 
72c7f33
-# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
72c7f33
-# sources only. Doxygen will then generate output that is more tailored for C. 
72c7f33
-# For instance, some of the names that are used will be different. The list 
72c7f33
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
72c7f33
+# sources only. Doxygen will then generate output that is more tailored for C.
72c7f33
+# For instance, some of the names that are used will be different. The list
72c7f33
 # of all members will be omitted, etc.
72c7f33
 
72c7f33
 OPTIMIZE_OUTPUT_FOR_C  = NO
72c7f33
 
72c7f33
-# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
72c7f33
-# sources only. Doxygen will then generate output that is more tailored for Java. 
72c7f33
-# For instance, namespaces will be presented as packages, qualified scopes 
72c7f33
-# will look different, etc.
72c7f33
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
72c7f33
+# sources only. Doxygen will then generate output that is more tailored for
72c7f33
+# Java. For instance, namespaces will be presented as packages, qualified
72c7f33
+# scopes will look different, etc.
72c7f33
 
72c7f33
 OPTIMIZE_OUTPUT_JAVA   = NO
72c7f33
 
72c7f33
-# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to 
72c7f33
-# include (a tag file for) the STL sources as input, then you should 
72c7f33
-# set this tag to YES in order to let doxygen match functions declarations and 
72c7f33
-# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
72c7f33
-# func(std::string) {}). This also make the inheritance and collaboration 
72c7f33
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
72c7f33
+# sources only. Doxygen will then generate output that is more tailored for
72c7f33
+# Fortran.
72c7f33
+
72c7f33
+OPTIMIZE_FOR_FORTRAN   = NO
72c7f33
+
72c7f33
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
72c7f33
+# sources. Doxygen will then generate output that is tailored for
72c7f33
+# VHDL.
72c7f33
+
72c7f33
+OPTIMIZE_OUTPUT_VHDL   = NO
72c7f33
+
72c7f33
+# Doxygen selects the parser to use depending on the extension of the files it
72c7f33
+# parses. With this tag you can assign which parser to use for a given extension.
72c7f33
+# Doxygen has a built-in mapping, but you can override or extend it using this
72c7f33
+# tag. The format is ext=language, where ext is a file extension, and language
72c7f33
+# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
72c7f33
+# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
72c7f33
+# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
72c7f33
+# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
72c7f33
+# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
72c7f33
+
72c7f33
+EXTENSION_MAPPING      =
72c7f33
+
72c7f33
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
72c7f33
+# to include (a tag file for) the STL sources as input, then you should
72c7f33
+# set this tag to YES in order to let doxygen match functions declarations and
72c7f33
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
72c7f33
+# func(std::string) {}). This also makes the inheritance and collaboration
72c7f33
 # diagrams that involve STL classes more complete and accurate.
72c7f33
 
72c7f33
 BUILTIN_STL_SUPPORT    = YES
72c7f33
@@ -207,259 +246,368 @@
72c7f33
 
72c7f33
 CPP_CLI_SUPPORT        = NO
72c7f33
 
72c7f33
-# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
72c7f33
-# tag is set to YES, then doxygen will reuse the documentation of the first 
72c7f33
-# member in the group (if any) for the other members of the group. By default 
72c7f33
+# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
72c7f33
+# Doxygen will parse them like normal C++ but will assume all classes use public
72c7f33
+# instead of private inheritance when no explicit protection keyword is present.
72c7f33
+
72c7f33
+SIP_SUPPORT            = NO
72c7f33
+
72c7f33
+# For Microsoft's IDL there are propget and propput attributes to indicate getter
72c7f33
+# and setter methods for a property. Setting this option to YES (the default)
72c7f33
+# will make doxygen replace the get and set methods by a property in the
72c7f33
+# documentation. This will only work if the methods are indeed getting or
72c7f33
+# setting a simple type. If this is not the case, or you want to show the
72c7f33
+# methods anyway, you should set this option to NO.
72c7f33
+
72c7f33
+IDL_PROPERTY_SUPPORT   = YES
72c7f33
+
72c7f33
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
72c7f33
+# tag is set to YES, then doxygen will reuse the documentation of the first
72c7f33
+# member in the group (if any) for the other members of the group. By default
72c7f33
 # all members of a group must be documented explicitly.
72c7f33
 
72c7f33
 DISTRIBUTE_GROUP_DOC   = YES
72c7f33
 
72c7f33
-# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
72c7f33
-# the same type (for instance a group of public functions) to be put as a 
72c7f33
-# subgroup of that type (e.g. under the Public Functions section). Set it to 
72c7f33
-# NO to prevent subgrouping. Alternatively, this can be done per class using 
72c7f33
+# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
72c7f33
+# the same type (for instance a group of public functions) to be put as a
72c7f33
+# subgroup of that type (e.g. under the Public Functions section). Set it to
72c7f33
+# NO to prevent subgrouping. Alternatively, this can be done per class using
72c7f33
 # the \nosubgrouping command.
72c7f33
 
72c7f33
 SUBGROUPING            = YES
72c7f33
 
72c7f33
+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
72c7f33
+# unions are shown inside the group in which they are included (e.g. using
72c7f33
+# @ingroup) instead of on a separate page (for HTML and Man pages) or
72c7f33
+# section (for LaTeX and RTF).
72c7f33
+
72c7f33
+INLINE_GROUPED_CLASSES = NO
72c7f33
+
72c7f33
+# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
72c7f33
+# is documented as struct, union, or enum with the name of the typedef. So
72c7f33
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
72c7f33
+# with name TypeT. When disabled the typedef will appear as a member of a file,
72c7f33
+# namespace, or class. And the struct will be named TypeS. This can typically
72c7f33
+# be useful for C code in case the coding convention dictates that all compound
72c7f33
+# types are typedef'ed and only the typedef is referenced, never the tag name.
72c7f33
+
72c7f33
+TYPEDEF_HIDES_STRUCT   = NO
72c7f33
+
72c7f33
+# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
72c7f33
+# determine which symbols to keep in memory and which to flush to disk.
72c7f33
+# When the cache is full, less often used symbols will be written to disk.
72c7f33
+# For small to medium size projects (<1000 input files) the default value is
72c7f33
+# probably good enough. For larger projects a too small cache size can cause
72c7f33
+# doxygen to be busy swapping symbols to and from disk most of the time
72c7f33
+# causing a significant performance penalty.
72c7f33
+# If the system has enough physical memory increasing the cache will improve the
72c7f33
+# performance by keeping more symbols in memory. Note that the value works on
72c7f33
+# a logarithmic scale so increasing the size by one will roughly double the
72c7f33
+# memory usage. The cache size is given by this formula:
72c7f33
+# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
72c7f33
+# corresponding to a cache size of 2^16 = 65536 symbols
72c7f33
+
72c7f33
+SYMBOL_CACHE_SIZE      = 0
72c7f33
+
72c7f33
 #---------------------------------------------------------------------------
72c7f33
 # Build related configuration options
72c7f33
 #---------------------------------------------------------------------------
72c7f33
 
72c7f33
-# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
72c7f33
-# documentation are documented, even if no documentation was available. 
72c7f33
-# Private class members and static file members will be hidden unless 
72c7f33
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
72c7f33
+# documentation are documented, even if no documentation was available.
72c7f33
+# Private class members and static file members will be hidden unless
72c7f33
 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
72c7f33
 
72c7f33
 EXTRACT_ALL            = YES
72c7f33
 
72c7f33
-# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
72c7f33
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
72c7f33
 # will be included in the documentation.
72c7f33
 
72c7f33
 EXTRACT_PRIVATE        = YES
72c7f33
 
72c7f33
-# If the EXTRACT_STATIC tag is set to YES all static members of a file 
72c7f33
+# If the EXTRACT_STATIC tag is set to YES all static members of a file
72c7f33
 # will be included in the documentation.
72c7f33
 
72c7f33
 EXTRACT_STATIC         = YES
72c7f33
 
72c7f33
-# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
72c7f33
-# defined locally in source files will be included in the documentation. 
72c7f33
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
72c7f33
+# defined locally in source files will be included in the documentation.
72c7f33
 # If set to NO only classes defined in header files are included.
72c7f33
 
72c7f33
 EXTRACT_LOCAL_CLASSES  = YES
72c7f33
 
72c7f33
-# This flag is only useful for Objective-C code. When set to YES local 
72c7f33
-# methods, which are defined in the implementation section but not in 
72c7f33
-# the interface are included in the documentation. 
72c7f33
+# This flag is only useful for Objective-C code. When set to YES local
72c7f33
+# methods, which are defined in the implementation section but not in
72c7f33
+# the interface are included in the documentation.
72c7f33
 # If set to NO (the default) only methods in the interface are included.
72c7f33
 
72c7f33
 EXTRACT_LOCAL_METHODS  = NO
72c7f33
 
72c7f33
-# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
72c7f33
-# undocumented members of documented classes, files or namespaces. 
72c7f33
-# If set to NO (the default) these members will be included in the 
72c7f33
-# various overviews, but no documentation section is generated. 
72c7f33
+# If this flag is set to YES, the members of anonymous namespaces will be
72c7f33
+# extracted and appear in the documentation as a namespace called
72c7f33
+# 'anonymous_namespace{file}', where file will be replaced with the base
72c7f33
+# name of the file that contains the anonymous namespace. By default
72c7f33
+# anonymous namespaces are hidden.
72c7f33
+
72c7f33
+EXTRACT_ANON_NSPACES   = NO
72c7f33
+
72c7f33
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
72c7f33
+# undocumented members of documented classes, files or namespaces.
72c7f33
+# If set to NO (the default) these members will be included in the
72c7f33
+# various overviews, but no documentation section is generated.
72c7f33
 # This option has no effect if EXTRACT_ALL is enabled.
72c7f33
 
72c7f33
 HIDE_UNDOC_MEMBERS     = NO
72c7f33
 
72c7f33
-# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
72c7f33
-# undocumented classes that are normally visible in the class hierarchy. 
72c7f33
-# If set to NO (the default) these classes will be included in the various 
72c7f33
+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
72c7f33
+# undocumented classes that are normally visible in the class hierarchy.
72c7f33
+# If set to NO (the default) these classes will be included in the various
72c7f33
 # overviews. This option has no effect if EXTRACT_ALL is enabled.
72c7f33
 
72c7f33
 HIDE_UNDOC_CLASSES     = NO
72c7f33
 
72c7f33
-# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
72c7f33
-# friend (class|struct|union) declarations. 
72c7f33
-# If set to NO (the default) these declarations will be included in the 
72c7f33
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
72c7f33
+# friend (class|struct|union) declarations.
72c7f33
+# If set to NO (the default) these declarations will be included in the
72c7f33
 # documentation.
72c7f33
 
72c7f33
 HIDE_FRIEND_COMPOUNDS  = NO
72c7f33
 
72c7f33
-# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
72c7f33
-# documentation blocks found inside the body of a function. 
72c7f33
-# If set to NO (the default) these blocks will be appended to the 
72c7f33
+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
72c7f33
+# documentation blocks found inside the body of a function.
72c7f33
+# If set to NO (the default) these blocks will be appended to the
72c7f33
 # function's detailed documentation block.
72c7f33
 
72c7f33
 HIDE_IN_BODY_DOCS      = NO
72c7f33
 
72c7f33
-# The INTERNAL_DOCS tag determines if documentation 
72c7f33
-# that is typed after a \internal command is included. If the tag is set 
72c7f33
-# to NO (the default) then the documentation will be excluded. 
72c7f33
+# The INTERNAL_DOCS tag determines if documentation
72c7f33
+# that is typed after a \internal command is included. If the tag is set
72c7f33
+# to NO (the default) then the documentation will be excluded.
72c7f33
 # Set it to YES to include the internal documentation.
72c7f33
 
72c7f33
 INTERNAL_DOCS          = NO
72c7f33
 
72c7f33
-# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
72c7f33
-# file names in lower-case letters. If set to YES upper-case letters are also 
72c7f33
-# allowed. This is useful if you have classes or files whose names only differ 
72c7f33
-# in case and if your file system supports case sensitive file names. Windows 
72c7f33
+# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
72c7f33
+# file names in lower-case letters. If set to YES upper-case letters are also
72c7f33
+# allowed. This is useful if you have classes or files whose names only differ
72c7f33
+# in case and if your file system supports case sensitive file names. Windows
72c7f33
 # and Mac users are advised to set this option to NO.
72c7f33
 
72c7f33
 CASE_SENSE_NAMES       = YES
72c7f33
 
72c7f33
-# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
72c7f33
-# will show members with their full class and namespace scopes in the 
72c7f33
+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
72c7f33
+# will show members with their full class and namespace scopes in the
72c7f33
 # documentation. If set to YES the scope will be hidden.
72c7f33
 
72c7f33
 HIDE_SCOPE_NAMES       = NO
72c7f33
 
72c7f33
-# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
72c7f33
-# will put a list of the files that are included by a file in the documentation 
72c7f33
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
72c7f33
+# will put a list of the files that are included by a file in the documentation
72c7f33
 # of that file.
72c7f33
 
72c7f33
 SHOW_INCLUDE_FILES     = YES
72c7f33
 
72c7f33
-# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
72c7f33
+# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
72c7f33
+# will list include files with double quotes in the documentation
72c7f33
+# rather than with sharp brackets.
72c7f33
+
72c7f33
+FORCE_LOCAL_INCLUDES   = NO
72c7f33
+
72c7f33
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
72c7f33
 # is inserted in the documentation for inline members.
72c7f33
 
72c7f33
 INLINE_INFO            = YES
72c7f33
 
72c7f33
-# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
72c7f33
-# will sort the (detailed) documentation of file and class members 
72c7f33
-# alphabetically by member name. If set to NO the members will appear in 
72c7f33
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
72c7f33
+# will sort the (detailed) documentation of file and class members
72c7f33
+# alphabetically by member name. If set to NO the members will appear in
72c7f33
 # declaration order.
72c7f33
 
72c7f33
 SORT_MEMBER_DOCS       = NO
72c7f33
 
72c7f33
-# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
72c7f33
-# brief documentation of file, namespace and class members alphabetically 
72c7f33
-# by member name. If set to NO (the default) the members will appear in 
72c7f33
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
72c7f33
+# brief documentation of file, namespace and class members alphabetically
72c7f33
+# by member name. If set to NO (the default) the members will appear in
72c7f33
 # declaration order.
72c7f33
 
72c7f33
 SORT_BRIEF_DOCS        = NO
72c7f33
 
72c7f33
-# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
72c7f33
-# sorted by fully-qualified names, including namespaces. If set to 
72c7f33
-# NO (the default), the class list will be sorted only by class name, 
72c7f33
-# not including the namespace part. 
72c7f33
+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
72c7f33
+# will sort the (brief and detailed) documentation of class members so that
72c7f33
+# constructors and destructors are listed first. If set to NO (the default)
72c7f33
+# the constructors will appear in the respective orders defined by
72c7f33
+# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
72c7f33
+# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
72c7f33
+# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
72c7f33
+
72c7f33
+SORT_MEMBERS_CTORS_1ST = NO
72c7f33
+
72c7f33
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
72c7f33
+# hierarchy of group names into alphabetical order. If set to NO (the default)
72c7f33
+# the group names will appear in their defined order.
72c7f33
+
72c7f33
+SORT_GROUP_NAMES       = NO
72c7f33
+
72c7f33
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
72c7f33
+# sorted by fully-qualified names, including namespaces. If set to
72c7f33
+# NO (the default), the class list will be sorted only by class name,
72c7f33
+# not including the namespace part.
72c7f33
 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
72c7f33
-# Note: This option applies only to the class list, not to the 
72c7f33
+# Note: This option applies only to the class list, not to the
72c7f33
 # alphabetical list.
72c7f33
 
72c7f33
 SORT_BY_SCOPE_NAME     = NO
72c7f33
 
72c7f33
-# The GENERATE_TODOLIST tag can be used to enable (YES) or 
72c7f33
-# disable (NO) the todo list. This list is created by putting \todo 
72c7f33
+# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
72c7f33
+# do proper type resolution of all parameters of a function it will reject a
72c7f33
+# match between the prototype and the implementation of a member function even
72c7f33
+# if there is only one candidate or it is obvious which candidate to choose
72c7f33
+# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
72c7f33
+# will still accept a match between prototype and implementation in such cases.
72c7f33
+
72c7f33
+STRICT_PROTO_MATCHING  = NO
72c7f33
+
72c7f33
+# The GENERATE_TODOLIST tag can be used to enable (YES) or
72c7f33
+# disable (NO) the todo list. This list is created by putting \todo
72c7f33
 # commands in the documentation.
72c7f33
 
72c7f33
 GENERATE_TODOLIST      = YES
72c7f33
 
72c7f33
-# The GENERATE_TESTLIST tag can be used to enable (YES) or 
72c7f33
-# disable (NO) the test list. This list is created by putting \test 
72c7f33
+# The GENERATE_TESTLIST tag can be used to enable (YES) or
72c7f33
+# disable (NO) the test list. This list is created by putting \test
72c7f33
 # commands in the documentation.
72c7f33
 
72c7f33
 GENERATE_TESTLIST      = YES
72c7f33
 
72c7f33
-# The GENERATE_BUGLIST tag can be used to enable (YES) or 
72c7f33
-# disable (NO) the bug list. This list is created by putting \bug 
72c7f33
+# The GENERATE_BUGLIST tag can be used to enable (YES) or
72c7f33
+# disable (NO) the bug list. This list is created by putting \bug
72c7f33
 # commands in the documentation.
72c7f33
 
72c7f33
 GENERATE_BUGLIST       = YES
72c7f33
 
72c7f33
-# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
72c7f33
-# disable (NO) the deprecated list. This list is created by putting 
72c7f33
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
72c7f33
+# disable (NO) the deprecated list. This list is created by putting
72c7f33
 # \deprecated commands in the documentation.
72c7f33
 
72c7f33
 GENERATE_DEPRECATEDLIST= YES
75fa8e5
 
72c7f33
-# The ENABLED_SECTIONS tag can be used to enable conditional 
72c7f33
+# The ENABLED_SECTIONS tag can be used to enable conditional
72c7f33
 # documentation sections, marked by \if sectionname ... \endif.
72c7f33
 
72c7f33
-ENABLED_SECTIONS       = 
72c7f33
+ENABLED_SECTIONS       =
72c7f33
 
72c7f33
-# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
72c7f33
-# the initial value of a variable or define consists of for it to appear in 
72c7f33
-# the documentation. If the initializer consists of more lines than specified 
72c7f33
-# here it will be hidden. Use a value of 0 to hide initializers completely. 
72c7f33
-# The appearance of the initializer of individual variables and defines in the 
72c7f33
-# documentation can be controlled using \showinitializer or \hideinitializer 
72c7f33
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
72c7f33
+# the initial value of a variable or macro consists of for it to appear in
72c7f33
+# the documentation. If the initializer consists of more lines than specified
72c7f33
+# here it will be hidden. Use a value of 0 to hide initializers completely.
72c7f33
+# The appearance of the initializer of individual variables and macros in the
72c7f33
+# documentation can be controlled using \showinitializer or \hideinitializer
72c7f33
 # command in the documentation regardless of this setting.
72c7f33
 
72c7f33
 MAX_INITIALIZER_LINES  = 30
72c7f33
 
72c7f33
-# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
72c7f33
-# at the bottom of the documentation of classes and structs. If set to YES the 
72c7f33
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
72c7f33
+# at the bottom of the documentation of classes and structs. If set to YES the
72c7f33
 # list will mention the files that were used to generate the documentation.
72c7f33
 
72c7f33
 SHOW_USED_FILES        = YES
72c7f33
 
72c7f33
-# If the sources in your project are distributed over multiple directories 
72c7f33
-# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
72c7f33
+# If the sources in your project are distributed over multiple directories
72c7f33
+# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
72c7f33
 # in the documentation. The default is NO.
72c7f33
 
72c7f33
 SHOW_DIRECTORIES       = NO
72c7f33
 
72c7f33
-# The FILE_VERSION_FILTER tag can be used to specify a program or script that 
72c7f33
-# doxygen should invoke to get the current version for each file (typically from the 
72c7f33
-# version control system). Doxygen will invoke the program by executing (via 
72c7f33
-# popen()) the command <command> <input-file>, where <command> is the value of 
72c7f33
-# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
72c7f33
-# provided by doxygen. Whatever the program writes to standard output 
72c7f33
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
72c7f33
+# This will remove the Files entry from the Quick Index and from the
72c7f33
+# Folder Tree View (if specified). The default is YES.
72c7f33
+
72c7f33
+SHOW_FILES             = YES
72c7f33
+
72c7f33
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
72c7f33
+# Namespaces page.
72c7f33
+# This will remove the Namespaces entry from the Quick Index
72c7f33
+# and from the Folder Tree View (if specified). The default is YES.
72c7f33
+
72c7f33
+SHOW_NAMESPACES        = YES
72c7f33
+
72c7f33
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
72c7f33
+# doxygen should invoke to get the current version for each file (typically from
72c7f33
+# the version control system). Doxygen will invoke the program by executing (via
72c7f33
+# popen()) the command <command> <input-file>, where <command> is the value of
72c7f33
+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
72c7f33
+# provided by doxygen. Whatever the program writes to standard output
72c7f33
 # is used as the file version. See the manual for examples.
72c7f33
 
72c7f33
-FILE_VERSION_FILTER    = 
72c7f33
+FILE_VERSION_FILTER    =
72c7f33
+
72c7f33
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
72c7f33
+# by doxygen. The layout file controls the global structure of the generated
72c7f33
+# output files in an output format independent way. The create the layout file
72c7f33
+# that represents doxygen's defaults, run doxygen with the -l option.
72c7f33
+# You can optionally specify a file name after the option, if omitted
72c7f33
+# DoxygenLayout.xml will be used as the name of the layout file.
72c7f33
+
72c7f33
+LAYOUT_FILE            =
72c7f33
 
72c7f33
 #---------------------------------------------------------------------------
72c7f33
 # configuration options related to warning and progress messages
72c7f33
 #---------------------------------------------------------------------------
72c7f33
 
72c7f33
-# The QUIET tag can be used to turn on/off the messages that are generated 
72c7f33
+# The QUIET tag can be used to turn on/off the messages that are generated
72c7f33
 # by doxygen. Possible values are YES and NO. If left blank NO is used.
72c7f33
 
72c7f33
 QUIET                  = NO
72c7f33
 
72c7f33
-# The WARNINGS tag can be used to turn on/off the warning messages that are 
72c7f33
-# generated by doxygen. Possible values are YES and NO. If left blank 
72c7f33
+# The WARNINGS tag can be used to turn on/off the warning messages that are
72c7f33
+# generated by doxygen. Possible values are YES and NO. If left blank
72c7f33
 # NO is used.
72c7f33
 
72c7f33
 WARNINGS               = YES
72c7f33
 
72c7f33
-# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
72c7f33
-# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
72c7f33
+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
72c7f33
+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
72c7f33
 # automatically be disabled.
72c7f33
 
72c7f33
 WARN_IF_UNDOCUMENTED   = YES
72c7f33
 
72c7f33
-# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
72c7f33
-# potential errors in the documentation, such as not documenting some 
72c7f33
-# parameters in a documented function, or documenting parameters that 
72c7f33
+# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
72c7f33
+# potential errors in the documentation, such as not documenting some
72c7f33
+# parameters in a documented function, or documenting parameters that
72c7f33
 # don't exist or using markup commands wrongly.
72c7f33
 
72c7f33
 WARN_IF_DOC_ERROR      = YES
72c7f33
 
72c7f33
-# This WARN_NO_PARAMDOC option can be abled to get warnings for 
72c7f33
-# functions that are documented, but have no documentation for their parameters 
72c7f33
-# or return value. If set to NO (the default) doxygen will only warn about 
72c7f33
-# wrong or incomplete parameter documentation, but not about the absence of 
72c7f33
+# The WARN_NO_PARAMDOC option can be enabled to get warnings for
72c7f33
+# functions that are documented, but have no documentation for their parameters
72c7f33
+# or return value. If set to NO (the default) doxygen will only warn about
72c7f33
+# wrong or incomplete parameter documentation, but not about the absence of
72c7f33
 # documentation.
72c7f33
 
72c7f33
 WARN_NO_PARAMDOC       = NO
72c7f33
 
72c7f33
-# The WARN_FORMAT tag determines the format of the warning messages that 
72c7f33
-# doxygen can produce. The string should contain the $file, $line, and $text 
72c7f33
-# tags, which will be replaced by the file and line number from which the 
72c7f33
-# warning originated and the warning text. Optionally the format may contain 
72c7f33
-# $version, which will be replaced by the version of the file (if it could 
72c7f33
+# The WARN_FORMAT tag determines the format of the warning messages that
72c7f33
+# doxygen can produce. The string should contain the $file, $line, and $text
72c7f33
+# tags, which will be replaced by the file and line number from which the
72c7f33
+# warning originated and the warning text. Optionally the format may contain
72c7f33
+# $version, which will be replaced by the version of the file (if it could
72c7f33
 # be obtained via FILE_VERSION_FILTER)
72c7f33
 
72c7f33
 WARN_FORMAT            = "$file:$line: $text"
72c7f33
 
72c7f33
-# The WARN_LOGFILE tag can be used to specify a file to which warning 
72c7f33
-# and error messages should be written. If left blank the output is written 
72c7f33
+# The WARN_LOGFILE tag can be used to specify a file to which warning
72c7f33
+# and error messages should be written. If left blank the output is written
72c7f33
 # to stderr.
72c7f33
 
72c7f33
-WARN_LOGFILE           = 
72c7f33
+WARN_LOGFILE           =
72c7f33
 
72c7f33
 #---------------------------------------------------------------------------
72c7f33
 # configuration options related to the input files
72c7f33
 #---------------------------------------------------------------------------
72c7f33
 
72c7f33
-# The INPUT tag can be used to specify the files and/or directories that contain 
72c7f33
-# documented source files. You may enter file names like "myfile.cpp" or 
72c7f33
-# directories like "/usr/src/myproject". Separate the files or directories 
72c7f33
+# The INPUT tag can be used to specify the files and/or directories that contain
72c7f33
+# documented source files. You may enter file names like "myfile.cpp" or
72c7f33
+# directories like "/usr/src/myproject". Separate the files or directories
72c7f33
 # with spaces.
72c7f33
 
72c7f33
 INPUT                  = . \
72c7f33
@@ -467,51 +615,49 @@
72c7f33
                          ../README \
72c7f33
                          ../LICENSE \
72c7f33
                          ../INSTALL
72c7f33
-# \
72c7f33
-#                         ../windows/README \
72c7f33
-#                         ../windows/INSTALL
72c7f33
 
72c7f33
-# This tag can be used to specify the character encoding of the source files that 
72c7f33
-# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default 
72c7f33
-# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. 
72c7f33
-# See http://www.gnu.org/software/libiconv for the list of possible encodings.
72c7f33
+# This tag can be used to specify the character encoding of the source files
72c7f33
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
72c7f33
+# also the default input encoding. Doxygen uses libiconv (or the iconv built
72c7f33
+# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
72c7f33
+# the list of possible encodings.
72c7f33
 
72c7f33
 INPUT_ENCODING         = UTF-8
72c7f33
 
72c7f33
-# If the value of the INPUT tag contains directories, you can use the 
72c7f33
-# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
72c7f33
-# and *.h) to filter out the source-files in the directories. If left 
72c7f33
-# blank the following patterns are tested: 
72c7f33
-# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
72c7f33
-# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
72c7f33
+# If the value of the INPUT tag contains directories, you can use the
72c7f33
+# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
72c7f33
+# and *.h) to filter out the source-files in the directories. If left
72c7f33
+# blank the following patterns are tested:
72c7f33
+# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
72c7f33
+# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
72c7f33
+# *.f90 *.f *.for *.vhd *.vhdl
72c7f33
 
72c7f33
 FILE_PATTERNS          = *.h \
72c7f33
                          *.cpp \
72c7f33
                          *.dox
72c7f33
 
72c7f33
-# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
72c7f33
-# should be searched for input files as well. Possible values are YES and NO. 
72c7f33
+# The RECURSIVE tag can be used to turn specify whether or not subdirectories
72c7f33
+# should be searched for input files as well. Possible values are YES and NO.
72c7f33
 # If left blank NO is used.
72c7f33
 
72c7f33
 RECURSIVE              = YES
72c7f33
 
72c7f33
-# The EXCLUDE tag can be used to specify files and/or directories that should 
72c7f33
-# excluded from the INPUT source files. This way you can easily exclude a 
72c7f33
+# The EXCLUDE tag can be used to specify files and/or directories that should
72c7f33
+# excluded from the INPUT source files. This way you can easily exclude a
75fa8e5
 # subdirectory from a directory tree whose root is specified with the INPUT tag.
75fa8e5
 
75fa8e5
-EXCLUDE                = devel.dox \
75fa8e5
-                         theory_api.dox
75fa8e5
+EXCLUDE                = devel.dox
75fa8e5
 
72c7f33
-# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
72c7f33
-# directories that are symbolic links (a Unix filesystem feature) are excluded 
72c7f33
+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
72c7f33
+# directories that are symbolic links (a Unix file system feature) are excluded
72c7f33
 # from the input.
72c7f33
 
72c7f33
 EXCLUDE_SYMLINKS       = NO
72c7f33
 
72c7f33
-# If the value of the INPUT tag contains directories, you can use the 
72c7f33
-# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
72c7f33
-# certain files from those directories. Note that the wildcards are matched 
72c7f33
-# against the file with absolute path, so to exclude all test directories 
72c7f33
+# If the value of the INPUT tag contains directories, you can use the
72c7f33
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
72c7f33
+# certain files from those directories. Note that the wildcards are matched
72c7f33
+# against the file with absolute path, so to exclude all test directories
72c7f33
 # for example use the pattern */test/*
72c7f33
 
72c7f33
 EXCLUDE_PATTERNS       = parse*.cpp \
72c7f33
@@ -519,94 +665,106 @@
72c7f33
                          lex*.cpp \
72c7f33
                          c_interface*.*
72c7f33
 
72c7f33
-# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
72c7f33
-# (namespaces, classes, functions, etc.) that should be excluded from the output. 
72c7f33
-# The symbol name can be a fully qualified name, a word, or if the wildcard * is used, 
72c7f33
-# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
72c7f33
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
72c7f33
+# (namespaces, classes, functions, etc.) that should be excluded from the
72c7f33
+# output. The symbol name can be a fully qualified name, a word, or if the
72c7f33
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
72c7f33
+# AClass::ANamespace, ANamespace::*Test
72c7f33
 
72c7f33
-EXCLUDE_SYMBOLS        = 
72c7f33
+EXCLUDE_SYMBOLS        =
72c7f33
 
72c7f33
-# The EXAMPLE_PATH tag can be used to specify one or more files or 
72c7f33
-# directories that contain example code fragments that are included (see 
72c7f33
+# The EXAMPLE_PATH tag can be used to specify one or more files or
72c7f33
+# directories that contain example code fragments that are included (see
72c7f33
 # the \include command).
72c7f33
 
72c7f33
-EXAMPLE_PATH           = 
72c7f33
+EXAMPLE_PATH           =
72c7f33
 
72c7f33
-# If the value of the EXAMPLE_PATH tag contains directories, you can use the 
72c7f33
-# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
72c7f33
-# and *.h) to filter out the source-files in the directories. If left 
72c7f33
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
72c7f33
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
72c7f33
+# and *.h) to filter out the source-files in the directories. If left
72c7f33
 # blank all files are included.
72c7f33
 
72c7f33
-EXAMPLE_PATTERNS       = 
72c7f33
+EXAMPLE_PATTERNS       =
72c7f33
 
72c7f33
-# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
72c7f33
-# searched for input files to be used with the \include or \dontinclude 
72c7f33
-# commands irrespective of the value of the RECURSIVE tag. 
72c7f33
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
72c7f33
+# searched for input files to be used with the \include or \dontinclude
72c7f33
+# commands irrespective of the value of the RECURSIVE tag.
72c7f33
 # Possible values are YES and NO. If left blank NO is used.
72c7f33
 
72c7f33
 EXAMPLE_RECURSIVE      = NO
72c7f33
 
72c7f33
-# The IMAGE_PATH tag can be used to specify one or more files or 
72c7f33
-# directories that contain image that are included in the documentation (see 
72c7f33
+# The IMAGE_PATH tag can be used to specify one or more files or
72c7f33
+# directories that contain image that are included in the documentation (see
72c7f33
 # the \image command).
72c7f33
 
72c7f33
 IMAGE_PATH             = @TOP@/doc
72c7f33
 
72c7f33
-# The INPUT_FILTER tag can be used to specify a program that doxygen should 
72c7f33
-# invoke to filter for each input file. Doxygen will invoke the filter program 
72c7f33
-# by executing (via popen()) the command <filter> <input-file>, where <filter> 
72c7f33
-# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
72c7f33
-# input file. Doxygen will then use the output that the filter program writes 
72c7f33
-# to standard output.  If FILTER_PATTERNS is specified, this tag will be 
72c7f33
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
72c7f33
+# invoke to filter for each input file. Doxygen will invoke the filter program
72c7f33
+# by executing (via popen()) the command <filter> <input-file>, where <filter>
72c7f33
+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
72c7f33
+# input file. Doxygen will then use the output that the filter program writes
72c7f33
+# to standard output.
72c7f33
+# If FILTER_PATTERNS is specified, this tag will be
72c7f33
 # ignored.
72c7f33
 
72c7f33
-INPUT_FILTER           = 
72c7f33
+INPUT_FILTER           =
72c7f33
 
72c7f33
-# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
72c7f33
-# basis.  Doxygen will compare the file name with each pattern and apply the 
72c7f33
-# filter if there is a match.  The filters are a list of the form: 
72c7f33
-# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
72c7f33
-# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
72c7f33
-# is applied to all files.
72c7f33
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
72c7f33
+# basis.
72c7f33
+# Doxygen will compare the file name with each pattern and apply the
72c7f33
+# filter if there is a match.
72c7f33
+# The filters are a list of the form:
72c7f33
+# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
72c7f33
+# info on how filters are used. If FILTER_PATTERNS is empty or if
72c7f33
+# non of the patterns match the file name, INPUT_FILTER is applied.
72c7f33
 
72c7f33
-FILTER_PATTERNS        = 
72c7f33
+FILTER_PATTERNS        =
72c7f33
 
72c7f33
-# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
72c7f33
-# INPUT_FILTER) will be used to filter the input files when producing source 
72c7f33
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
72c7f33
+# INPUT_FILTER) will be used to filter the input files when producing source
72c7f33
 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
72c7f33
 
72c7f33
 FILTER_SOURCE_FILES    = NO
72c7f33
 
72c7f33
+# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
72c7f33
+# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
72c7f33
+# and it is also possible to disable source filtering for a specific pattern
72c7f33
+# using *.ext= (so without naming a filter). This option only has effect when
72c7f33
+# FILTER_SOURCE_FILES is enabled.
72c7f33
+
72c7f33
+FILTER_SOURCE_PATTERNS =
72c7f33
+
72c7f33
 #---------------------------------------------------------------------------
72c7f33
 # configuration options related to source browsing
72c7f33
 #---------------------------------------------------------------------------
72c7f33
 
72c7f33
-# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
72c7f33
-# be generated. Documented entities will be cross-referenced with these sources. 
72c7f33
-# Note: To get rid of all source code in the generated output, make sure also 
72c7f33
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will
72c7f33
+# be generated. Documented entities will be cross-referenced with these sources.
72c7f33
+# Note: To get rid of all source code in the generated output, make sure also
72c7f33
 # VERBATIM_HEADERS is set to NO.
72c7f33
 
72c7f33
 SOURCE_BROWSER         = YES
72c7f33
 
72c7f33
-# Setting the INLINE_SOURCES tag to YES will include the body 
72c7f33
+# Setting the INLINE_SOURCES tag to YES will include the body
72c7f33
 # of functions and classes directly in the documentation.
72c7f33
 
72c7f33
 INLINE_SOURCES         = NO
72c7f33
 
72c7f33
-# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
72c7f33
-# doxygen to hide any special comment blocks from generated source code 
72c7f33
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
72c7f33
+# doxygen to hide any special comment blocks from generated source code
72c7f33
 # fragments. Normal C and C++ comments will always remain visible.
72c7f33
 
72c7f33
 STRIP_CODE_COMMENTS    = NO
72c7f33
 
72c7f33
-# If the REFERENCED_BY_RELATION tag is set to YES (the default) 
72c7f33
-# then for each documented function all documented 
72c7f33
+# If the REFERENCED_BY_RELATION tag is set to YES
72c7f33
+# then for each documented function all documented
72c7f33
 # functions referencing it will be listed.
72c7f33
 
72c7f33
 REFERENCED_BY_RELATION = YES
72c7f33
 
72c7f33
-# If the REFERENCES_RELATION tag is set to YES (the default) 
72c7f33
-# then for each documented function all documented entities 
72c7f33
+# If the REFERENCES_RELATION tag is set to YES
72c7f33
+# then for each documented function all documented entities
72c7f33
 # called/used by that function will be listed.
72c7f33
 
72c7f33
 REFERENCES_RELATION    = YES
72c7f33
@@ -614,20 +772,21 @@
72c7f33
 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
72c7f33
 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
72c7f33
 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
72c7f33
-# link to the source code.  Otherwise they will link to the documentstion.
72c7f33
+# link to the source code.
72c7f33
+# Otherwise they will link to the documentation.
72c7f33
 
72c7f33
 REFERENCES_LINK_SOURCE = YES
72c7f33
 
72c7f33
-# If the USE_HTAGS tag is set to YES then the references to source code 
72c7f33
-# will point to the HTML generated by the htags(1) tool instead of doxygen 
72c7f33
-# built-in source browser. The htags tool is part of GNU's global source 
72c7f33
-# tagging system (see http://www.gnu.org/software/global/global.html). You 
72c7f33
+# If the USE_HTAGS tag is set to YES then the references to source code
72c7f33
+# will point to the HTML generated by the htags(1) tool instead of doxygen
72c7f33
+# built-in source browser. The htags tool is part of GNU's global source
72c7f33
+# tagging system (see http://www.gnu.org/software/global/global.html). You
72c7f33
 # will need version 4.8.6 or higher.
72c7f33
 
72c7f33
 USE_HTAGS              = NO
72c7f33
 
72c7f33
-# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
72c7f33
-# will generate a verbatim copy of the header file for each class for 
72c7f33
+# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
72c7f33
+# will generate a verbatim copy of the header file for each class for
72c7f33
 # which an include is specified. Set to NO to disable this.
72c7f33
 
72c7f33
 VERBATIM_HEADERS       = YES
72c7f33
@@ -636,21 +795,21 @@
72c7f33
 # configuration options related to the alphabetical class index
72c7f33
 #---------------------------------------------------------------------------
72c7f33
 
72c7f33
-# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
72c7f33
-# of all compounds will be generated. Enable this if the project 
72c7f33
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
72c7f33
+# of all compounds will be generated. Enable this if the project
72c7f33
 # contains a lot of classes, structs, unions or interfaces.
72c7f33
 
72c7f33
 ALPHABETICAL_INDEX     = YES
72c7f33
 
72c7f33
-# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
72c7f33
-# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
72c7f33
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
72c7f33
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
72c7f33
 # in which this list will be split (can be a number in the range [1..20])
72c7f33
 
72c7f33
 COLS_IN_ALPHA_INDEX    = 5
72c7f33
 
72c7f33
-# In case all classes in a project start with a common prefix, all 
72c7f33
-# classes will be put under the same header in the alphabetical index. 
72c7f33
-# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
72c7f33
+# In case all classes in a project start with a common prefix, all
72c7f33
+# classes will be put under the same header in the alphabetical index.
72c7f33
+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
72c7f33
 # should be ignored while generating the index headers.
72c7f33
 
72c7f33
 IGNORE_PREFIX          = CVC3::
72c7f33
@@ -659,256 +818,513 @@
72c7f33
 # configuration options related to the HTML output
72c7f33
 #---------------------------------------------------------------------------
72c7f33
 
72c7f33
-# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
72c7f33
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
72c7f33
 # generate HTML output.
72c7f33
 
72c7f33
 GENERATE_HTML          = YES
72c7f33
 
72c7f33
-# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
72c7f33
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
72c7f33
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
72c7f33
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
72c7f33
 # put in front of it. If left blank `html' will be used as the default path.
72c7f33
 
72c7f33
 HTML_OUTPUT            = html
72c7f33
 
72c7f33
-# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
72c7f33
-# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
72c7f33
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
72c7f33
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
72c7f33
 # doxygen will generate files with .html extension.
72c7f33
 
72c7f33
 HTML_FILE_EXTENSION    = .html
72c7f33
 
72c7f33
-# The HTML_HEADER tag can be used to specify a personal HTML header for 
72c7f33
-# each generated HTML page. If it is left blank doxygen will generate a 
72c7f33
-# standard header.
72c7f33
+# The HTML_HEADER tag can be used to specify a personal HTML header for
72c7f33
+# each generated HTML page. If it is left blank doxygen will generate a
72c7f33
+# standard header. Note that when using a custom header you are responsible
72c7f33
+# for the proper inclusion of any scripts and style sheets that doxygen
72c7f33
+# needs, which is dependent on the configuration options used.
72c7f33
+# It is adviced to generate a default header using "doxygen -w html
72c7f33
+# header.html footer.html stylesheet.css YourConfigFile" and then modify
72c7f33
+# that header. Note that the header is subject to change so you typically
72c7f33
+# have to redo this when upgrading to a newer version of doxygen or when changing the value of configuration settings such as GENERATE_TREEVIEW!
72c7f33
 
72c7f33
-HTML_HEADER            = 
72c7f33
+HTML_HEADER            =
72c7f33
 
72c7f33
-# The HTML_FOOTER tag can be used to specify a personal HTML footer for 
72c7f33
-# each generated HTML page. If it is left blank doxygen will generate a 
72c7f33
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
72c7f33
+# each generated HTML page. If it is left blank doxygen will generate a
72c7f33
 # standard footer.
72c7f33
 
72c7f33
-HTML_FOOTER            = 
72c7f33
+HTML_FOOTER            =
72c7f33
 
72c7f33
-# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
72c7f33
-# style sheet that is used by each HTML page. It can be used to 
72c7f33
-# fine-tune the look of the HTML output. If the tag is left blank doxygen 
72c7f33
-# will generate a default style sheet. Note that doxygen will try to copy 
72c7f33
-# the style sheet file to the HTML output directory, so don't put your own 
72c7f33
+# If the HTML_TIMESTAMP tag is set to YES then the generated HTML documentation will contain the timesstamp.
72c7f33
+
72c7f33
+HTML_TIMESTAMP         = NO
72c7f33
+
72c7f33
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
72c7f33
+# style sheet that is used by each HTML page. It can be used to
72c7f33
+# fine-tune the look of the HTML output. If the tag is left blank doxygen
72c7f33
+# will generate a default style sheet. Note that doxygen will try to copy
72c7f33
+# the style sheet file to the HTML output directory, so don't put your own
72c7f33
 # stylesheet in the HTML output directory as well, or it will be erased!
72c7f33
 
72c7f33
-HTML_STYLESHEET        = 
72c7f33
+HTML_STYLESHEET        =
72c7f33
 
72c7f33
-# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
72c7f33
-# files or namespaces will be aligned in HTML using tables. If set to 
72c7f33
+# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
72c7f33
+# other source files which should be copied to the HTML output directory. Note
72c7f33
+# that these files will be copied to the base HTML output directory. Use the
72c7f33
+# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
72c7f33
+# files. In the HTML_STYLESHEET file, use the file name only. Also note that
72c7f33
+# the files will be copied as-is; there are no commands or markers available.
72c7f33
+
72c7f33
+HTML_EXTRA_FILES       =
72c7f33
+
72c7f33
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
72c7f33
+# Doxygen will adjust the colors in the stylesheet and background images
72c7f33
+# according to this color. Hue is specified as an angle on a colorwheel,
72c7f33
+# see http://en.wikipedia.org/wiki/Hue for more information.
72c7f33
+# For instance the value 0 represents red, 60 is yellow, 120 is green,
72c7f33
+# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
72c7f33
+# The allowed range is 0 to 359.
72c7f33
+
72c7f33
+HTML_COLORSTYLE_HUE    = 220
72c7f33
+
72c7f33
+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
72c7f33
+# the colors in the HTML output. For a value of 0 the output will use
72c7f33
+# grayscales only. A value of 255 will produce the most vivid colors.
72c7f33
+
72c7f33
+HTML_COLORSTYLE_SAT    = 100
72c7f33
+
72c7f33
+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
72c7f33
+# the luminance component of the colors in the HTML output. Values below
72c7f33
+# 100 gradually make the output lighter, whereas values above 100 make
72c7f33
+# the output darker. The value divided by 100 is the actual gamma applied,
72c7f33
+# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
72c7f33
+# and 100 does not change the gamma.
72c7f33
+
72c7f33
+HTML_COLORSTYLE_GAMMA  = 80
72c7f33
+
72c7f33
+# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
72c7f33
+# page will contain the date and time when the page was generated. Setting
72c7f33
+# this to NO can help when comparing the output of multiple runs.
72c7f33
+
72c7f33
+HTML_TIMESTAMP         = YES
72c7f33
+
72c7f33
+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
72c7f33
+# files or namespaces will be aligned in HTML using tables. If set to
72c7f33
 # NO a bullet list will be used.
72c7f33
 
72c7f33
 HTML_ALIGN_MEMBERS     = NO
72c7f33
 
72c7f33
-# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
72c7f33
-# will be generated that can be used as input for tools like the 
72c7f33
-# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
72c7f33
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
72c7f33
+# documentation will contain sections that can be hidden and shown after the
72c7f33
+# page has loaded. For this to work a browser that supports
72c7f33
+# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
72c7f33
+# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
72c7f33
+
72c7f33
+HTML_DYNAMIC_SECTIONS  = NO
72c7f33
+
72c7f33
+# If the GENERATE_DOCSET tag is set to YES, additional index files
72c7f33
+# will be generated that can be used as input for Apple's Xcode 3
72c7f33
+# integrated development environment, introduced with OSX 10.5 (Leopard).
72c7f33
+# To create a documentation set, doxygen will generate a Makefile in the
72c7f33
+# HTML output directory. Running make will produce the docset in that
72c7f33
+# directory and running "make install" will install the docset in
72c7f33
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
72c7f33
+# it at startup.
72c7f33
+# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
72c7f33
+# for more information.
72c7f33
+
72c7f33
+GENERATE_DOCSET        = NO
72c7f33
+
72c7f33
+# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
72c7f33
+# feed. A documentation feed provides an umbrella under which multiple
72c7f33
+# documentation sets from a single provider (such as a company or product suite)
72c7f33
+# can be grouped.
72c7f33
+
72c7f33
+DOCSET_FEEDNAME        = "Doxygen generated docs"
72c7f33
+
72c7f33
+# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
72c7f33
+# should uniquely identify the documentation set bundle. This should be a
72c7f33
+# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
72c7f33
+# will append .docset to the name.
72c7f33
+
72c7f33
+DOCSET_BUNDLE_ID       = org.doxygen.Project
72c7f33
+
72c7f33
+# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
72c7f33
+# the documentation publisher. This should be a reverse domain-name style
72c7f33
+# string, e.g. com.mycompany.MyDocSet.documentation.
72c7f33
+
72c7f33
+DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
72c7f33
+
72c7f33
+# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
72c7f33
+
72c7f33
+DOCSET_PUBLISHER_NAME  = Publisher
72c7f33
+
72c7f33
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
72c7f33
+# will be generated that can be used as input for tools like the
72c7f33
+# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
72c7f33
 # of the generated HTML documentation.
72c7f33
 
72c7f33
 GENERATE_HTMLHELP      = NO
72c7f33
 
72c7f33
-# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
72c7f33
-# be used to specify the file name of the resulting .chm file. You 
72c7f33
-# can add a path in front of the file if the result should not be 
72c7f33
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
72c7f33
+# be used to specify the file name of the resulting .chm file. You
72c7f33
+# can add a path in front of the file if the result should not be
72c7f33
 # written to the html output directory.
72c7f33
 
72c7f33
-CHM_FILE               = 
72c7f33
+CHM_FILE               =
72c7f33
 
72c7f33
-# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
72c7f33
-# be used to specify the location (absolute path including file name) of 
72c7f33
-# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
72c7f33
+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
72c7f33
+# be used to specify the location (absolute path including file name) of
72c7f33
+# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
72c7f33
 # the HTML help compiler on the generated index.hhp.
72c7f33
 
72c7f33
-HHC_LOCATION           = 
72c7f33
+HHC_LOCATION           =
72c7f33
 
72c7f33
-# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
72c7f33
-# controls if a separate .chi index file is generated (YES) or that 
72c7f33
+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
72c7f33
+# controls if a separate .chi index file is generated (YES) or that
72c7f33
 # it should be included in the master .chm file (NO).
72c7f33
 
72c7f33
 GENERATE_CHI           = NO
72c7f33
 
72c7f33
-# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
72c7f33
-# controls whether a binary table of contents is generated (YES) or a 
72c7f33
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
72c7f33
+# is used to encode HtmlHelp index (hhk), content (hhc) and project file
72c7f33
+# content.
72c7f33
+
72c7f33
+CHM_INDEX_ENCODING     =
72c7f33
+
72c7f33
+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
72c7f33
+# controls whether a binary table of contents is generated (YES) or a
72c7f33
 # normal table of contents (NO) in the .chm file.
72c7f33
 
72c7f33
 BINARY_TOC             = NO
72c7f33
 
72c7f33
-# The TOC_EXPAND flag can be set to YES to add extra items for group members 
72c7f33
+# The TOC_EXPAND flag can be set to YES to add extra items for group members
72c7f33
 # to the contents of the HTML help documentation and to the tree view.
72c7f33
 
72c7f33
 TOC_EXPAND             = NO
72c7f33
 
72c7f33
-# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
72c7f33
-# top of each HTML page. The value NO (the default) enables the index and 
72c7f33
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
72c7f33
+# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
72c7f33
+# that can be used as input for Qt's qhelpgenerator to generate a
72c7f33
+# Qt Compressed Help (.qch) of the generated HTML documentation.
72c7f33
+
72c7f33
+GENERATE_QHP           = NO
72c7f33
+
72c7f33
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
72c7f33
+# be used to specify the file name of the resulting .qch file.
72c7f33
+# The path specified is relative to the HTML output folder.
72c7f33
+
72c7f33
+QCH_FILE               =
72c7f33
+
72c7f33
+# The QHP_NAMESPACE tag specifies the namespace to use when generating
72c7f33
+# Qt Help Project output. For more information please see
72c7f33
+# http://doc.trolltech.com/qthelpproject.html#namespace
72c7f33
+
72c7f33
+QHP_NAMESPACE          = org.doxygen.Project
72c7f33
+
72c7f33
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
72c7f33
+# Qt Help Project output. For more information please see
72c7f33
+# http://doc.trolltech.com/qthelpproject.html#virtual-folders
72c7f33
+
72c7f33
+QHP_VIRTUAL_FOLDER     = doc
72c7f33
+
72c7f33
+# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
72c7f33
+# add. For more information please see
72c7f33
+# http://doc.trolltech.com/qthelpproject.html#custom-filters
72c7f33
+
72c7f33
+QHP_CUST_FILTER_NAME   =
72c7f33
+
72c7f33
+# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
72c7f33
+# custom filter to add. For more information please see
72c7f33
+# 
72c7f33
+# Qt Help Project / Custom Filters.
72c7f33
+
72c7f33
+QHP_CUST_FILTER_ATTRS  =
72c7f33
+
72c7f33
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
72c7f33
+# project's
72c7f33
+# filter section matches.
72c7f33
+# 
72c7f33
+# Qt Help Project / Filter Attributes.
72c7f33
+
72c7f33
+QHP_SECT_FILTER_ATTRS  =
72c7f33
+
72c7f33
+# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
72c7f33
+# be used to specify the location of Qt's qhelpgenerator.
72c7f33
+# If non-empty doxygen will try to run qhelpgenerator on the generated
72c7f33
+# .qhp file.
72c7f33
+
72c7f33
+QHG_LOCATION           =
72c7f33
+
72c7f33
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
72c7f33
+#  will be generated, which together with the HTML files, form an Eclipse help
72c7f33
+# plugin. To install this plugin and make it available under the help contents
72c7f33
+# menu in Eclipse, the contents of the directory containing the HTML and XML
72c7f33
+# files needs to be copied into the plugins directory of eclipse. The name of
72c7f33
+# the directory within the plugins directory should be the same as
72c7f33
+# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
72c7f33
+# the help appears.
72c7f33
+
72c7f33
+GENERATE_ECLIPSEHELP   = NO
72c7f33
+
72c7f33
+# A unique identifier for the eclipse help plugin. When installing the plugin
72c7f33
+# the directory name containing the HTML and XML files should also have
72c7f33
+# this name.
72c7f33
+
72c7f33
+ECLIPSE_DOC_ID         = org.doxygen.Project
72c7f33
+
72c7f33
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
72c7f33
+# top of each HTML page. The value NO (the default) enables the index and
72c7f33
 # the value YES disables it.
72c7f33
 
72c7f33
 DISABLE_INDEX          = NO
72c7f33
 
72c7f33
-# This tag can be used to set the number of enum values (range [1..20]) 
72c7f33
-# that doxygen will group on one line in the generated HTML documentation.
72c7f33
+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
72c7f33
+# (range [0,1..20]) that doxygen will group on one line in the generated HTML
72c7f33
+# documentation. Note that a value of 0 will completely suppress the enum
72c7f33
+# values from appearing in the overview section.
72c7f33
 
72c7f33
 ENUM_VALUES_PER_LINE   = 4
72c7f33
 
72c7f33
-# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
72c7f33
-# generated containing a tree-like index structure (just like the one that 
72c7f33
-# is generated for HTML Help). For this to work a browser that supports 
72c7f33
-# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
72c7f33
-# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
72c7f33
-# probably better off using the HTML help feature.
72c7f33
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
72c7f33
+# structure should be generated to display hierarchical information.
72c7f33
+# If the tag value is set to YES, a side panel will be generated
72c7f33
+# containing a tree-like index structure (just like the one that
72c7f33
+# is generated for HTML Help). For this to work a browser that supports
72c7f33
+# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
72c7f33
+# Windows users are probably better off using the HTML help feature.
72c7f33
 
72c7f33
 GENERATE_TREEVIEW      = NO
72c7f33
 
72c7f33
-# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
72c7f33
-# used to set the initial width (in pixels) of the frame in which the tree 
72c7f33
+# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
72c7f33
+# and Class Hierarchy pages using a tree view instead of an ordered list.
72c7f33
+
72c7f33
+USE_INLINE_TREES       = NO
72c7f33
+
72c7f33
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
72c7f33
+# used to set the initial width (in pixels) of the frame in which the tree
72c7f33
 # is shown.
72c7f33
 
72c7f33
 TREEVIEW_WIDTH         = 250
72c7f33
 
72c7f33
+# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
72c7f33
+# links to external symbols imported via tag files in a separate window.
72c7f33
+
72c7f33
+EXT_LINKS_IN_WINDOW    = NO
72c7f33
+
72c7f33
+# Use this tag to change the font size of Latex formulas included
72c7f33
+# as images in the HTML documentation. The default is 10. Note that
72c7f33
+# when you change the font size after a successful doxygen run you need
72c7f33
+# to manually remove any form_*.png images from the HTML output directory
72c7f33
+# to force them to be regenerated.
72c7f33
+
72c7f33
+FORMULA_FONTSIZE       = 10
72c7f33
+
72c7f33
+# Use the FORMULA_TRANPARENT tag to determine whether or not the images
72c7f33
+# generated for formulas are transparent PNGs. Transparent PNGs are
72c7f33
+# not supported properly for IE 6.0, but are supported on all modern browsers.
72c7f33
+# Note that when changing this option you need to delete any form_*.png files
72c7f33
+# in the HTML output before the changes have effect.
72c7f33
+
72c7f33
+FORMULA_TRANSPARENT    = YES
72c7f33
+
72c7f33
+# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
72c7f33
+# (see http://www.mathjax.org) which uses client side Javascript for the
72c7f33
+# rendering instead of using prerendered bitmaps. Use this if you do not
72c7f33
+# have LaTeX installed or if you want to formulas look prettier in the HTML
72c7f33
+# output. When enabled you also need to install MathJax separately and
72c7f33
+# configure the path to it using the MATHJAX_RELPATH option.
72c7f33
+
72c7f33
+USE_MATHJAX            = NO
72c7f33
+
72c7f33
+# When MathJax is enabled you need to specify the location relative to the
72c7f33
+# HTML output directory using the MATHJAX_RELPATH option. The destination
72c7f33
+# directory should contain the MathJax.js script. For instance, if the mathjax
72c7f33
+# directory is located at the same level as the HTML output directory, then
72c7f33
+# MATHJAX_RELPATH should be ../mathjax. The default value points to the
72c7f33
+# mathjax.org site, so you can quickly see the result without installing
72c7f33
+# MathJax, but it is strongly recommended to install a local copy of MathJax
72c7f33
+# before deployment.
72c7f33
+
72c7f33
+MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
72c7f33
+
72c7f33
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box
72c7f33
+# for the HTML output. The underlying search engine uses javascript
72c7f33
+# and DHTML and should work on any modern browser. Note that when using
72c7f33
+# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
72c7f33
+# (GENERATE_DOCSET) there is already a search function so this one should
72c7f33
+# typically be disabled. For large projects the javascript based search engine
72c7f33
+# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
72c7f33
+
72c7f33
+SEARCHENGINE           = NO
72c7f33
+
72c7f33
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
72c7f33
+# implemented using a PHP enabled web server instead of at the web client
72c7f33
+# using Javascript. Doxygen will generate the search PHP script and index
72c7f33
+# file to put on the web server. The advantage of the server
72c7f33
+# based approach is that it scales better to large projects and allows
72c7f33
+# full text search. The disadvantages are that it is more difficult to setup
72c7f33
+# and does not have live searching capabilities.
72c7f33
+
72c7f33
+SERVER_BASED_SEARCH    = NO
72c7f33
+
72c7f33
 #---------------------------------------------------------------------------
72c7f33
 # configuration options related to the LaTeX output
72c7f33
 #---------------------------------------------------------------------------
72c7f33
 
72c7f33
-# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
72c7f33
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
72c7f33
 # generate Latex output.
72c7f33
 
72c7f33
 GENERATE_LATEX         = NO
72c7f33
 
72c7f33
-# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
72c7f33
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
72c7f33
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
72c7f33
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
72c7f33
 # put in front of it. If left blank `latex' will be used as the default path.
72c7f33
 
72c7f33
 LATEX_OUTPUT           = latex
72c7f33
 
72c7f33
-# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
72c7f33
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
72c7f33
 # invoked. If left blank `latex' will be used as the default command name.
72c7f33
+# Note that when enabling USE_PDFLATEX this option is only used for
72c7f33
+# generating bitmaps for formulas in the HTML output, but not in the
72c7f33
+# Makefile that is written to the output directory.
72c7f33
 
72c7f33
 LATEX_CMD_NAME         = latex
72c7f33
 
72c7f33
-# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
72c7f33
-# generate index for LaTeX. If left blank `makeindex' will be used as the 
72c7f33
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
72c7f33
+# generate index for LaTeX. If left blank `makeindex' will be used as the
72c7f33
 # default command name.
72c7f33
 
72c7f33
 MAKEINDEX_CMD_NAME     = makeindex
72c7f33
 
72c7f33
-# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
72c7f33
-# LaTeX documents. This may be useful for small projects and may help to 
72c7f33
+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
72c7f33
+# LaTeX documents. This may be useful for small projects and may help to
72c7f33
 # save some trees in general.
72c7f33
 
72c7f33
 COMPACT_LATEX          = NO
72c7f33
 
72c7f33
-# The PAPER_TYPE tag can be used to set the paper type that is used 
72c7f33
-# by the printer. Possible values are: a4, a4wide, letter, legal and 
72c7f33
+# The PAPER_TYPE tag can be used to set the paper type that is used
72c7f33
+# by the printer. Possible values are: a4, letter, legal and
72c7f33
 # executive. If left blank a4wide will be used.
72c7f33
 
72c7f33
 PAPER_TYPE             = letter
72c7f33
 
72c7f33
-# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
72c7f33
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
72c7f33
 # packages that should be included in the LaTeX output.
72c7f33
 
72c7f33
 EXTRA_PACKAGES         = amsmath
72c7f33
 
72c7f33
-# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
72c7f33
-# the generated latex document. The header should contain everything until 
72c7f33
-# the first chapter. If it is left blank doxygen will generate a 
72c7f33
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
72c7f33
+# the generated latex document. The header should contain everything until
72c7f33
+# the first chapter. If it is left blank doxygen will generate a
72c7f33
 # standard header. Notice: only use this tag if you know what you are doing!
72c7f33
 
72c7f33
-LATEX_HEADER           = 
72c7f33
+LATEX_HEADER           =
72c7f33
 
72c7f33
-# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
72c7f33
-# is prepared for conversion to pdf (using ps2pdf). The pdf file will 
72c7f33
-# contain links (just like the HTML output) instead of page references 
72c7f33
+# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
72c7f33
+# the generated latex document. The footer should contain everything after
72c7f33
+# the last chapter. If it is left blank doxygen will generate a
72c7f33
+# standard footer. Notice: only use this tag if you know what you are doing!
72c7f33
+
72c7f33
+LATEX_FOOTER           =
72c7f33
+
72c7f33
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
72c7f33
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
72c7f33
+# contain links (just like the HTML output) instead of page references
72c7f33
 # This makes the output suitable for online browsing using a pdf viewer.
72c7f33
 
72c7f33
 PDF_HYPERLINKS         = NO
72c7f33
 
72c7f33
-# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
72c7f33
-# plain latex in the generated Makefile. Set this option to YES to get a 
72c7f33
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
72c7f33
+# plain latex in the generated Makefile. Set this option to YES to get a
72c7f33
 # higher quality PDF documentation.
72c7f33
 
72c7f33
 USE_PDFLATEX           = NO
72c7f33
 
72c7f33
-# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
72c7f33
-# command to the generated LaTeX files. This will instruct LaTeX to keep 
72c7f33
-# running if errors occur, instead of asking the user for help. 
72c7f33
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
72c7f33
+# command to the generated LaTeX files. This will instruct LaTeX to keep
72c7f33
+# running if errors occur, instead of asking the user for help.
72c7f33
 # This option is also used when generating formulas in HTML.
72c7f33
 
72c7f33
 LATEX_BATCHMODE        = NO
72c7f33
 
72c7f33
-# If LATEX_HIDE_INDICES is set to YES then doxygen will not 
72c7f33
-# include the index chapters (such as File Index, Compound Index, etc.) 
72c7f33
+# If LATEX_HIDE_INDICES is set to YES then doxygen will not
72c7f33
+# include the index chapters (such as File Index, Compound Index, etc.)
72c7f33
 # in the output.
72c7f33
 
72c7f33
 LATEX_HIDE_INDICES     = NO
72c7f33
 
72c7f33
+# If LATEX_SOURCE_CODE is set to YES then doxygen will include
72c7f33
+# source code with syntax highlighting in the LaTeX output.
72c7f33
+# Note that which sources are shown also depends on other settings
72c7f33
+# such as SOURCE_BROWSER.
72c7f33
+
72c7f33
+LATEX_SOURCE_CODE      = NO
72c7f33
+
72c7f33
 #---------------------------------------------------------------------------
72c7f33
 # configuration options related to the RTF output
72c7f33
 #---------------------------------------------------------------------------
72c7f33
 
72c7f33
-# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
72c7f33
-# The RTF output is optimized for Word 97 and may not look very pretty with 
72c7f33
+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
72c7f33
+# The RTF output is optimized for Word 97 and may not look very pretty with
72c7f33
 # other RTF readers or editors.
72c7f33
 
72c7f33
 GENERATE_RTF           = NO
72c7f33
 
72c7f33
-# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
72c7f33
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
72c7f33
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
72c7f33
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
72c7f33
 # put in front of it. If left blank `rtf' will be used as the default path.
72c7f33
 
72c7f33
 RTF_OUTPUT             = rtf
72c7f33
 
72c7f33
-# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
72c7f33
-# RTF documents. This may be useful for small projects and may help to 
72c7f33
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
72c7f33
+# RTF documents. This may be useful for small projects and may help to
72c7f33
 # save some trees in general.
72c7f33
 
72c7f33
 COMPACT_RTF            = NO
72c7f33
 
72c7f33
-# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
72c7f33
-# will contain hyperlink fields. The RTF file will 
72c7f33
-# contain links (just like the HTML output) instead of page references. 
72c7f33
-# This makes the output suitable for online browsing using WORD or other 
72c7f33
-# programs which support those fields. 
72c7f33
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
72c7f33
+# will contain hyperlink fields. The RTF file will
72c7f33
+# contain links (just like the HTML output) instead of page references.
72c7f33
+# This makes the output suitable for online browsing using WORD or other
72c7f33
+# programs which support those fields.
72c7f33
 # Note: wordpad (write) and others do not support links.
72c7f33
 
72c7f33
 RTF_HYPERLINKS         = NO
72c7f33
 
72c7f33
-# Load stylesheet definitions from file. Syntax is similar to doxygen's 
72c7f33
-# config file, i.e. a series of assignments. You only have to provide 
72c7f33
+# Load stylesheet definitions from file. Syntax is similar to doxygen's
72c7f33
+# config file, i.e. a series of assignments. You only have to provide
72c7f33
 # replacements, missing definitions are set to their default value.
72c7f33
 
72c7f33
-RTF_STYLESHEET_FILE    = 
72c7f33
+RTF_STYLESHEET_FILE    =
72c7f33
 
72c7f33
-# Set optional variables used in the generation of an rtf document. 
72c7f33
+# Set optional variables used in the generation of an rtf document.
72c7f33
 # Syntax is similar to doxygen's config file.
72c7f33
 
72c7f33
-RTF_EXTENSIONS_FILE    = 
72c7f33
+RTF_EXTENSIONS_FILE    =
72c7f33
 
72c7f33
 #---------------------------------------------------------------------------
72c7f33
 # configuration options related to the man page output
72c7f33
 #---------------------------------------------------------------------------
72c7f33
 
72c7f33
-# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
72c7f33
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
72c7f33
 # generate man pages
72c7f33
 
72c7f33
 GENERATE_MAN           = NO
72c7f33
 
72c7f33
-# The MAN_OUTPUT tag is used to specify where the man pages will be put. 
72c7f33
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
72c7f33
+# The MAN_OUTPUT tag is used to specify where the man pages will be put.
72c7f33
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
72c7f33
 # put in front of it. If left blank `man' will be used as the default path.
72c7f33
 
72c7f33
 MAN_OUTPUT             = man
72c7f33
 
72c7f33
-# The MAN_EXTENSION tag determines the extension that is added to 
72c7f33
+# The MAN_EXTENSION tag determines the extension that is added to
72c7f33
 # the generated man pages (default is the subroutine's section .3)
72c7f33
 
72c7f33
 MAN_EXTENSION          = .3
72c7f33
 
72c7f33
-# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
72c7f33
-# then it will generate one additional man file for each entity 
72c7f33
-# documented in the real man page(s). These additional files 
72c7f33
-# only source the real man page, but without them the man command 
72c7f33
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
72c7f33
+# then it will generate one additional man file for each entity
72c7f33
+# documented in the real man page(s). These additional files
72c7f33
+# only source the real man page, but without them the man command
72c7f33
 # would be unable to find the correct page. The default is NO.
72c7f33
 
72c7f33
 MAN_LINKS              = NO
72c7f33
@@ -917,33 +1333,33 @@
72c7f33
 # configuration options related to the XML output
72c7f33
 #---------------------------------------------------------------------------
72c7f33
 
72c7f33
-# If the GENERATE_XML tag is set to YES Doxygen will 
72c7f33
-# generate an XML file that captures the structure of 
72c7f33
+# If the GENERATE_XML tag is set to YES Doxygen will
72c7f33
+# generate an XML file that captures the structure of
72c7f33
 # the code including all documentation.
72c7f33
 
72c7f33
 GENERATE_XML           = NO
72c7f33
 
72c7f33
-# The XML_OUTPUT tag is used to specify where the XML pages will be put. 
72c7f33
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
72c7f33
+# The XML_OUTPUT tag is used to specify where the XML pages will be put.
72c7f33
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
72c7f33
 # put in front of it. If left blank `xml' will be used as the default path.
72c7f33
 
72c7f33
 XML_OUTPUT             = xml
72c7f33
 
72c7f33
-# The XML_SCHEMA tag can be used to specify an XML schema, 
72c7f33
-# which can be used by a validating XML parser to check the 
72c7f33
+# The XML_SCHEMA tag can be used to specify an XML schema,
72c7f33
+# which can be used by a validating XML parser to check the
72c7f33
 # syntax of the XML files.
72c7f33
 
72c7f33
-XML_SCHEMA             = 
72c7f33
+XML_SCHEMA             =
72c7f33
 
72c7f33
-# The XML_DTD tag can be used to specify an XML DTD, 
72c7f33
-# which can be used by a validating XML parser to check the 
72c7f33
+# The XML_DTD tag can be used to specify an XML DTD,
72c7f33
+# which can be used by a validating XML parser to check the
72c7f33
 # syntax of the XML files.
72c7f33
 
72c7f33
-XML_DTD                = 
72c7f33
+XML_DTD                =
72c7f33
 
72c7f33
-# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
72c7f33
-# dump the program listings (including syntax highlighting 
72c7f33
-# and cross-referencing information) to the XML output. Note that 
72c7f33
+# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
72c7f33
+# dump the program listings (including syntax highlighting
72c7f33
+# and cross-referencing information) to the XML output. Note that
72c7f33
 # enabling this will significantly increase the size of the XML output.
72c7f33
 
72c7f33
 XML_PROGRAMLISTING     = YES
72c7f33
@@ -952,10 +1368,10 @@
72c7f33
 # configuration options for the AutoGen Definitions output
72c7f33
 #---------------------------------------------------------------------------
72c7f33
 
72c7f33
-# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
72c7f33
-# generate an AutoGen Definitions (see autogen.sf.net) file 
72c7f33
-# that captures the structure of the code including all 
72c7f33
-# documentation. Note that this feature is still experimental 
72c7f33
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
72c7f33
+# generate an AutoGen Definitions (see autogen.sf.net) file
72c7f33
+# that captures the structure of the code including all
72c7f33
+# documentation. Note that this feature is still experimental
72c7f33
 # and incomplete at the moment.
72c7f33
 
72c7f33
 GENERATE_AUTOGEN_DEF   = NO
72c7f33
@@ -964,308 +1380,350 @@
72c7f33
 # configuration options related to the Perl module output
72c7f33
 #---------------------------------------------------------------------------
72c7f33
 
72c7f33
-# If the GENERATE_PERLMOD tag is set to YES Doxygen will 
72c7f33
-# generate a Perl module file that captures the structure of 
72c7f33
-# the code including all documentation. Note that this 
72c7f33
-# feature is still experimental and incomplete at the 
72c7f33
+# If the GENERATE_PERLMOD tag is set to YES Doxygen will
72c7f33
+# generate a Perl module file that captures the structure of
72c7f33
+# the code including all documentation. Note that this
72c7f33
+# feature is still experimental and incomplete at the
72c7f33
 # moment.
72c7f33
 
72c7f33
 GENERATE_PERLMOD       = NO
72c7f33
 
72c7f33
-# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
72c7f33
-# the necessary Makefile rules, Perl scripts and LaTeX code to be able 
72c7f33
+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
72c7f33
+# the necessary Makefile rules, Perl scripts and LaTeX code to be able
72c7f33
 # to generate PDF and DVI output from the Perl module output.
72c7f33
 
72c7f33
 PERLMOD_LATEX          = NO
72c7f33
 
72c7f33
-# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
72c7f33
-# nicely formatted so it can be parsed by a human reader.  This is useful 
72c7f33
-# if you want to understand what is going on.  On the other hand, if this 
72c7f33
-# tag is set to NO the size of the Perl module output will be much smaller 
72c7f33
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
72c7f33
+# nicely formatted so it can be parsed by a human reader.
72c7f33
+# This is useful
72c7f33
+# if you want to understand what is going on.
72c7f33
+# On the other hand, if this
72c7f33
+# tag is set to NO the size of the Perl module output will be much smaller
72c7f33
 # and Perl will parse it just the same.
72c7f33
 
72c7f33
 PERLMOD_PRETTY         = YES
72c7f33
 
72c7f33
-# The names of the make variables in the generated doxyrules.make file 
72c7f33
-# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
72c7f33
-# This is useful so different doxyrules.make files included by the same 
72c7f33
+# The names of the make variables in the generated doxyrules.make file
72c7f33
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
72c7f33
+# This is useful so different doxyrules.make files included by the same
72c7f33
 # Makefile don't overwrite each other's variables.
72c7f33
 
72c7f33
-PERLMOD_MAKEVAR_PREFIX = 
72c7f33
+PERLMOD_MAKEVAR_PREFIX =
72c7f33
 
72c7f33
 #---------------------------------------------------------------------------
72c7f33
-# Configuration options related to the preprocessor   
72c7f33
+# Configuration options related to the preprocessor
72c7f33
 #---------------------------------------------------------------------------
72c7f33
 
72c7f33
-# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
72c7f33
-# evaluate all C-preprocessor directives found in the sources and include 
72c7f33
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
72c7f33
+# evaluate all C-preprocessor directives found in the sources and include
72c7f33
 # files.
72c7f33
 
72c7f33
 ENABLE_PREPROCESSING   = YES
72c7f33
 
72c7f33
-# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
72c7f33
-# names in the source code. If set to NO (the default) only conditional 
72c7f33
-# compilation will be performed. Macro expansion can be done in a controlled 
72c7f33
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
72c7f33
+# names in the source code. If set to NO (the default) only conditional
72c7f33
+# compilation will be performed. Macro expansion can be done in a controlled
72c7f33
 # way by setting EXPAND_ONLY_PREDEF to YES.
72c7f33
 
72c7f33
 MACRO_EXPANSION        = YES
72c7f33
 
72c7f33
-# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
72c7f33
-# then the macro expansion is limited to the macros specified with the 
72c7f33
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
72c7f33
+# then the macro expansion is limited to the macros specified with the
72c7f33
 # PREDEFINED and EXPAND_AS_DEFINED tags.
72c7f33
 
72c7f33
 EXPAND_ONLY_PREDEF     = YES
72c7f33
 
72c7f33
-# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
72c7f33
-# in the INCLUDE_PATH (see below) will be search if a #include is found.
72c7f33
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
72c7f33
+# pointed to by INCLUDE_PATH will be searched when a #include is found.
72c7f33
 
72c7f33
 SEARCH_INCLUDES        = YES
72c7f33
 
72c7f33
-# The INCLUDE_PATH tag can be used to specify one or more directories that 
72c7f33
-# contain include files that are not input files but should be processed by 
72c7f33
+# The INCLUDE_PATH tag can be used to specify one or more directories that
72c7f33
+# contain include files that are not input files but should be processed by
72c7f33
 # the preprocessor.
72c7f33
 
72c7f33
-INCLUDE_PATH           = 
72c7f33
+INCLUDE_PATH           =
72c7f33
 
72c7f33
-# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
72c7f33
-# patterns (like *.h and *.hpp) to filter out the header-files in the 
72c7f33
-# directories. If left blank, the patterns specified with FILE_PATTERNS will 
72c7f33
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
72c7f33
+# patterns (like *.h and *.hpp) to filter out the header-files in the
72c7f33
+# directories. If left blank, the patterns specified with FILE_PATTERNS will
72c7f33
 # be used.
72c7f33
 
72c7f33
-INCLUDE_FILE_PATTERNS  = 
72c7f33
+INCLUDE_FILE_PATTERNS  =
72c7f33
 
72c7f33
-# The PREDEFINED tag can be used to specify one or more macro names that 
72c7f33
-# are defined before the preprocessor is started (similar to the -D option of 
72c7f33
-# gcc). The argument of the tag is a list of macros of the form: name 
72c7f33
-# or name=definition (no spaces). If the definition and the = are 
72c7f33
-# omitted =1 is assumed. To prevent a macro definition from being 
72c7f33
-# undefined via #undef or recursively expanded use the := operator 
72c7f33
+# The PREDEFINED tag can be used to specify one or more macro names that
72c7f33
+# are defined before the preprocessor is started (similar to the -D option of
72c7f33
+# gcc). The argument of the tag is a list of macros of the form: name
72c7f33
+# or name=definition (no spaces). If the definition and the = are
72c7f33
+# omitted =1 is assumed. To prevent a macro definition from being
72c7f33
+# undefined via #undef or recursively expanded use the := operator
75fa8e5
 # instead of the = operator.
75fa8e5
 
75fa8e5
-PREDEFINED             = DEBUG \
75fa8e5
-                         DOXYGEN
75fa8e5
+PREDEFINED             = DOXYGEN
75fa8e5
 
72c7f33
-# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
72c7f33
-# this tag can be used to specify a list of macro names that should be expanded. 
72c7f33
-# The macro definition that is found in the sources will be used. 
72c7f33
-# Use the PREDEFINED tag if you want to use a different macro definition.
72c7f33
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
72c7f33
+# this tag can be used to specify a list of macro names that should be expanded.
72c7f33
+# The macro definition that is found in the sources will be used.
72c7f33
+# Use the PREDEFINED tag if you want to use a different macro definition that
72c7f33
+# overrules the definition found in the source code.
72c7f33
 
72c7f33
 EXPAND_AS_DEFINED      = IF_DEBUG
72c7f33
 
72c7f33
-# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
72c7f33
-# doxygen's preprocessor will remove all function-like macros that are alone 
72c7f33
-# on a line, have an all uppercase name, and do not end with a semicolon. Such 
72c7f33
-# function macros are typically used for boiler-plate code, and will confuse 
72c7f33
-# the parser if not removed.
72c7f33
+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
72c7f33
+# doxygen's preprocessor will remove all references to function-like macros
72c7f33
+# that are alone on a line, have an all uppercase name, and do not end with a
72c7f33
+# semicolon, because these will confuse the parser if not removed.
72c7f33
 
72c7f33
 SKIP_FUNCTION_MACROS   = YES
72c7f33
 
72c7f33
 #---------------------------------------------------------------------------
72c7f33
-# Configuration::additions related to external references   
72c7f33
+# Configuration::additions related to external references
72c7f33
 #---------------------------------------------------------------------------
72c7f33
 
72c7f33
-# The TAGFILES option can be used to specify one or more tagfiles. 
72c7f33
-# Optionally an initial location of the external documentation 
72c7f33
-# can be added for each tagfile. The format of a tag file without 
72c7f33
-# this location is as follows: 
72c7f33
-#   TAGFILES = file1 file2 ... 
72c7f33
-# Adding location for the tag files is done as follows: 
72c7f33
-#   TAGFILES = file1=loc1 "file2 = loc2" ... 
72c7f33
-# where "loc1" and "loc2" can be relative or absolute paths or 
72c7f33
-# URLs. If a location is present for each tag, the installdox tool 
72c7f33
+# The TAGFILES option can be used to specify one or more tagfiles.
72c7f33
+# Optionally an initial location of the external documentation
72c7f33
+# can be added for each tagfile. The format of a tag file without
72c7f33
+# this location is as follows:
72c7f33
+#
72c7f33
+# TAGFILES = file1 file2 ...
72c7f33
+# Adding location for the tag files is done as follows:
72c7f33
+#
72c7f33
+# TAGFILES = file1=loc1 "file2 = loc2" ...
72c7f33
+# where "loc1" and "loc2" can be relative or absolute paths or
72c7f33
+# URLs. If a location is present for each tag, the installdox tool
72c7f33
 # does not have to be run to correct the links.
72c7f33
 # Note that each tag file must have a unique name
72c7f33
 # (where the name does NOT include the path)
72c7f33
-# If a tag file is not located in the directory in which doxygen 
72c7f33
+# If a tag file is not located in the directory in which doxygen
72c7f33
 # is run, you must also specify the path to the tagfile here.
72c7f33
 
72c7f33
-TAGFILES               = 
72c7f33
+TAGFILES               =
72c7f33
 
72c7f33
-# When a file name is specified after GENERATE_TAGFILE, doxygen will create 
72c7f33
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
72c7f33
 # a tag file that is based on the input files it reads.
72c7f33
 
72c7f33
-GENERATE_TAGFILE       = 
72c7f33
+GENERATE_TAGFILE       =
72c7f33
 
72c7f33
-# If the ALLEXTERNALS tag is set to YES all external classes will be listed 
72c7f33
-# in the class index. If set to NO only the inherited external classes 
72c7f33
+# If the ALLEXTERNALS tag is set to YES all external classes will be listed
72c7f33
+# in the class index. If set to NO only the inherited external classes
72c7f33
 # will be listed.
72c7f33
 
72c7f33
 ALLEXTERNALS           = NO
72c7f33
 
72c7f33
-# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
72c7f33
-# in the modules index. If set to NO, only the current project's groups will 
72c7f33
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
72c7f33
+# in the modules index. If set to NO, only the current project's groups will
72c7f33
 # be listed.
72c7f33
 
72c7f33
 EXTERNAL_GROUPS        = YES
72c7f33
 
72c7f33
-# The PERL_PATH should be the absolute path and name of the perl script 
72c7f33
+# The PERL_PATH should be the absolute path and name of the perl script
72c7f33
 # interpreter (i.e. the result of `which perl').
72c7f33
 
72c7f33
 PERL_PATH              = /usr/bin/perl
72c7f33
 
72c7f33
 #---------------------------------------------------------------------------
72c7f33
-# Configuration options related to the dot tool   
72c7f33
+# Configuration options related to the dot tool
72c7f33
 #---------------------------------------------------------------------------
72c7f33
 
72c7f33
-# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
72c7f33
-# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
72c7f33
-# or super classes. Setting the tag to NO turns the diagrams off. Note that 
72c7f33
-# this option is superseded by the HAVE_DOT option below. This is only a 
72c7f33
-# fallback. It is recommended to install and use dot, since it yields more 
72c7f33
-# powerful graphs.
72c7f33
+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
72c7f33
+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
72c7f33
+# or super classes. Setting the tag to NO turns the diagrams off. Note that
72c7f33
+# this option also works with HAVE_DOT disabled, but it is recommended to
72c7f33
+# install and use dot, since it yields more powerful graphs.
72c7f33
 
72c7f33
 CLASS_DIAGRAMS         = YES
72c7f33
 
72c7f33
-# You can define message sequence charts within doxygen comments using the \msc 
72c7f33
-# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to 
72c7f33
-# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to 
72c7f33
-# specify the directory where the mscgen tool resides. If left empty the tool is assumed to 
72c7f33
-# be found in the default search path.
72c7f33
+# You can define message sequence charts within doxygen comments using the \msc
72c7f33
+# command. Doxygen will then run the mscgen tool (see
72c7f33
+# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
72c7f33
+# documentation. The MSCGEN_PATH tag allows you to specify the directory where
72c7f33
+# the mscgen tool resides. If left empty the tool is assumed to be found in the
72c7f33
+# default search path.
72c7f33
 
72c7f33
-MSCGEN_PATH            = 
72c7f33
+MSCGEN_PATH            =
72c7f33
 
72c7f33
-# If set to YES, the inheritance and collaboration graphs will hide 
72c7f33
-# inheritance and usage relations if the target is undocumented 
72c7f33
+# If set to YES, the inheritance and collaboration graphs will hide
72c7f33
+# inheritance and usage relations if the target is undocumented
72c7f33
 # or is not a class.
72c7f33
 
72c7f33
 HIDE_UNDOC_RELATIONS   = YES
72c7f33
 
72c7f33
-# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
72c7f33
-# available from the path. This tool is part of Graphviz, a graph visualization 
72c7f33
-# toolkit from AT&T and Lucent Bell Labs. The other options in this section 
72c7f33
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
72c7f33
+# available from the path. This tool is part of Graphviz, a graph visualization
72c7f33
+# toolkit from AT&T and Lucent Bell Labs. The other options in this section
72c7f33
 # have no effect if this option is set to NO (the default)
75fa8e5
 
75fa8e5
 HAVE_DOT               = @HAVE_DOT@
75fa8e5
 
72c7f33
-# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
72c7f33
-# will generate a graph for each documented class showing the direct and 
72c7f33
-# indirect inheritance relations. Setting this tag to YES will force the 
72c7f33
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
72c7f33
+# allowed to run in parallel. When set to 0 (the default) doxygen will
72c7f33
+# base this on the number of processors available in the system. You can set it
72c7f33
+# explicitly to a value larger than 0 to get control over the balance
72c7f33
+# between CPU load and processing speed.
72c7f33
+
72c7f33
+DOT_NUM_THREADS        = 0
72c7f33
+
72c7f33
+# By default doxygen will write a font called Helvetica to the output
72c7f33
+# directory and reference it in all dot files that doxygen generates.
72c7f33
+# When you want a differently looking font you can specify the font name
72c7f33
+# using DOT_FONTNAME. You need to make sure dot is able to find the font,
72c7f33
+# which can be done by putting it in a standard location or by setting the
72c7f33
+# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
75fa8e5
+# containing the font.
75fa8e5
+
72c7f33
+DOT_FONTNAME           = Helvetica
72c7f33
+
72c7f33
+# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
72c7f33
+# The default size is 10pt.
75fa8e5
+
72c7f33
+DOT_FONTSIZE           = 10
72c7f33
+
72c7f33
+# By default doxygen will tell dot to use the output directory to look for the
72c7f33
+# FreeSans.ttf font (which doxygen will put there itself). If you specify a
72c7f33
+# different font using DOT_FONTNAME you can set the path where dot
75fa8e5
+# can find it using this tag.
75fa8e5
+
72c7f33
+DOT_FONTPATH           =
75fa8e5
+
72c7f33
+# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
72c7f33
+# will generate a graph for each documented class showing the direct and
72c7f33
+# indirect inheritance relations. Setting this tag to YES will force the
72c7f33
 # the CLASS_DIAGRAMS tag to NO.
72c7f33
 
72c7f33
 CLASS_GRAPH            = YES
72c7f33
 
72c7f33
-# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
72c7f33
-# will generate a graph for each documented class showing the direct and 
72c7f33
-# indirect implementation dependencies (inheritance, containment, and 
72c7f33
+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
72c7f33
+# will generate a graph for each documented class showing the direct and
72c7f33
+# indirect implementation dependencies (inheritance, containment, and
72c7f33
 # class references variables) of the class with other documented classes.
72c7f33
 
72c7f33
 COLLABORATION_GRAPH    = YES
72c7f33
 
72c7f33
-# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
72c7f33
+# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
72c7f33
 # will generate a graph for groups, showing the direct groups dependencies
72c7f33
 
72c7f33
 GROUP_GRAPHS           = YES
72c7f33
 
72c7f33
-# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
72c7f33
-# collaboration diagrams in a style similar to the OMG's Unified Modeling 
72c7f33
+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
72c7f33
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
72c7f33
 # Language.
72c7f33
 
72c7f33
 UML_LOOK               = YES
72c7f33
 
72c7f33
-# If set to YES, the inheritance and collaboration graphs will show the 
72c7f33
+# If set to YES, the inheritance and collaboration graphs will show the
72c7f33
 # relations between templates and their instances.
72c7f33
 
72c7f33
 TEMPLATE_RELATIONS     = YES
72c7f33
 
72c7f33
-# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
72c7f33
-# tags are set to YES then doxygen will generate a graph for each documented 
72c7f33
-# file showing the direct and indirect include dependencies of the file with 
72c7f33
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
72c7f33
+# tags are set to YES then doxygen will generate a graph for each documented
72c7f33
+# file showing the direct and indirect include dependencies of the file with
72c7f33
 # other documented files.
72c7f33
 
72c7f33
 INCLUDE_GRAPH          = YES
72c7f33
 
72c7f33
-# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
72c7f33
-# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
72c7f33
-# documented header file showing the documented files that directly or 
72c7f33
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
72c7f33
+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
72c7f33
+# documented header file showing the documented files that directly or
72c7f33
 # indirectly include this file.
72c7f33
 
72c7f33
 INCLUDED_BY_GRAPH      = YES
72c7f33
 
72c7f33
-# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 
72c7f33
-# generate a call dependency graph for every global function or class method. 
72c7f33
-# Note that enabling this option will significantly increase the time of a run. 
72c7f33
-# So in most cases it will be better to enable call graphs for selected 
72c7f33
-# functions only using the \callgraph command.
72c7f33
+# If the CALL_GRAPH and HAVE_DOT options are set to YES then
72c7f33
+# doxygen will generate a call dependency graph for every global function
72c7f33
+# or class method. Note that enabling this option will significantly increase
72c7f33
+# the time of a run. So in most cases it will be better to enable call graphs
72c7f33
+# for selected functions only using the \callgraph command.
72c7f33
 
72c7f33
 CALL_GRAPH             = NO
72c7f33
 
72c7f33
-# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will 
72c7f33
-# generate a caller dependency graph for every global function or class method. 
72c7f33
-# Note that enabling this option will significantly increase the time of a run. 
72c7f33
-# So in most cases it will be better to enable caller graphs for selected 
72c7f33
-# functions only using the \callergraph command.
72c7f33
+# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
72c7f33
+# doxygen will generate a caller dependency graph for every global function
72c7f33
+# or class method. Note that enabling this option will significantly increase
72c7f33
+# the time of a run. So in most cases it will be better to enable caller
72c7f33
+# graphs for selected functions only using the \callergraph command.
72c7f33
 
72c7f33
 CALLER_GRAPH           = NO
72c7f33
 
72c7f33
-# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
72c7f33
-# will graphical hierarchy of all classes instead of a textual one.
72c7f33
+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
72c7f33
+# will generate a graphical hierarchy of all classes instead of a textual one.
72c7f33
 
72c7f33
 GRAPHICAL_HIERARCHY    = YES
72c7f33
 
72c7f33
-# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
72c7f33
-# then doxygen will show the dependencies a directory has on other directories 
72c7f33
+# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
72c7f33
+# then doxygen will show the dependencies a directory has on other directories
72c7f33
 # in a graphical way. The dependency relations are determined by the #include
72c7f33
 # relations between the files in the directories.
72c7f33
 
72c7f33
 DIRECTORY_GRAPH        = YES
72c7f33
 
72c7f33
-# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
72c7f33
-# generated by dot. Possible values are png, jpg, or gif
72c7f33
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
72c7f33
+# generated by dot. Possible values are svg, png, jpg, or gif.
75fa8e5
 # If left blank png will be used.
75fa8e5
 
75fa8e5
-DOT_IMAGE_FORMAT       = gif
75fa8e5
+DOT_IMAGE_FORMAT       = png
75fa8e5
 
72c7f33
-# The tag DOT_PATH can be used to specify the path where the dot tool can be 
72c7f33
+# The tag DOT_PATH can be used to specify the path where the dot tool can be
75fa8e5
 # found. If left blank, it is assumed the dot tool can be found in the path.
72c7f33
 
72c7f33
-DOT_PATH               = 
72c7f33
+DOT_PATH               =
72c7f33
 
72c7f33
-# The DOTFILE_DIRS tag can be used to specify one or more directories that 
72c7f33
-# contain dot files that are included in the documentation (see the 
72c7f33
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
72c7f33
+# contain dot files that are included in the documentation (see the
72c7f33
 # \dotfile command).
72c7f33
 
72c7f33
-DOTFILE_DIRS           = 
72c7f33
+DOTFILE_DIRS           =
72c7f33
 
72c7f33
-# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
72c7f33
-# nodes that will be shown in the graph. If the number of nodes in a graph 
72c7f33
-# becomes larger than this value, doxygen will truncate the graph, which is 
72c7f33
-# visualized by representing a node as a red box. Note that doxygen will always 
72c7f33
-# show the root nodes and its direct children regardless of this setting.
72c7f33
+# The MSCFILE_DIRS tag can be used to specify one or more directories that
72c7f33
+# contain msc files that are included in the documentation (see the
72c7f33
+# \mscfile command).
72c7f33
+
72c7f33
+MSCFILE_DIRS           =
72c7f33
+
72c7f33
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
72c7f33
+# nodes that will be shown in the graph. If the number of nodes in a graph
72c7f33
+# becomes larger than this value, doxygen will truncate the graph, which is
72c7f33
+# visualized by representing a node as a red box. Note that doxygen if the
72c7f33
+# number of direct children of the root node in a graph is already larger than
72c7f33
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
72c7f33
+# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
72c7f33
 
72c7f33
 DOT_GRAPH_MAX_NODES    = 1
72c7f33
 
72c7f33
-# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
72c7f33
-# background. This is disabled by default, which results in a white background. 
72c7f33
-# Warning: Depending on the platform used, enabling this option may lead to 
72c7f33
-# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 
72c7f33
-# read).
72c7f33
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
72c7f33
+# graphs generated by dot. A depth value of 3 means that only nodes reachable
72c7f33
+# from the root by following a path via at most 3 edges will be shown. Nodes
72c7f33
+# that lay further from the root node will be omitted. Note that setting this
72c7f33
+# option to 1 or 2 may greatly reduce the computation time needed for large
72c7f33
+# code bases. Also note that the size of a graph can be further restricted by
72c7f33
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
72c7f33
+
72c7f33
+MAX_DOT_GRAPH_DEPTH    = 0
72c7f33
+
72c7f33
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
72c7f33
+# background. This is disabled by default, because dot on Windows does not
72c7f33
+# seem to support this out of the box. Warning: Depending on the platform used,
72c7f33
+# enabling this option may lead to badly anti-aliased labels on the edges of
72c7f33
+# a graph (i.e. they become hard to read).
72c7f33
 
72c7f33
 DOT_TRANSPARENT        = NO
72c7f33
 
72c7f33
-# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
72c7f33
-# files in one run (i.e. multiple -o and -T options on the command line). This 
72c7f33
-# makes dot run faster, but since only newer versions of dot (>1.8.10) 
72c7f33
+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
72c7f33
+# files in one run (i.e. multiple -o and -T options on the command line). This
72c7f33
+# makes dot run faster, but since only newer versions of dot (>1.8.10)
75fa8e5
 # support this, this feature is disabled by default.
75fa8e5
 
75fa8e5
-DOT_MULTI_TARGETS      = NO
75fa8e5
+DOT_MULTI_TARGETS      = YES
75fa8e5
 
72c7f33
-# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
72c7f33
-# generate a legend page explaining the meaning of the various boxes and 
72c7f33
+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
72c7f33
+# generate a legend page explaining the meaning of the various boxes and
72c7f33
 # arrows in the dot generated graphs.
72c7f33
 
72c7f33
 GENERATE_LEGEND        = YES
72c7f33
 
72c7f33
-# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
72c7f33
-# remove the intermediate dot files that are used to generate 
72c7f33
+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
72c7f33
+# remove the intermediate dot files that are used to generate
72c7f33
 # the various graphs.
72c7f33
 
72c7f33
 DOT_CLEANUP            = YES
72c7f33
-
72c7f33
-#---------------------------------------------------------------------------
72c7f33
-# Configuration::additions related to the search engine   
72c7f33
-#---------------------------------------------------------------------------
72c7f33
-
72c7f33
-# The SEARCHENGINE tag specifies whether or not a search engine should be 
72c7f33
-# used. If set to NO the values of all tags below this one will be ignored.
72c7f33
-
72c7f33
-SEARCHENGINE           = NO