4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Doxyfile 1.5.6
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# This file describes the settings to be used by the documentation system
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# doxygen (www.doxygen.org) for a project
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# All text after a hash (#) is considered a comment and will be ignored
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The format is:
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# TAG = value [value, ...]
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# For lists items can also be appended using:
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# TAG += value [value, ...]
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Values that contain spaces should be placed between quotes (" ")
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Project related configuration options
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# This tag specifies the encoding used for all characters in the config file
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# that follow. The default is UTF-8 which is also the encoding used for all
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# text before the first occurrence of this tag. Doxygen uses libiconv (or the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# iconv built into libc) for the transcoding. See
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# http://www.gnu.org/software/libiconv for the list of possible encodings.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncDOXYFILE_ENCODING = UTF-8
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# by quotes) that should identify the project.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncPROJECT_NAME = VirtualBox Qt GUI
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The PROJECT_NUMBER tag can be used to enter a project or revision number.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# This could be handy for archiving the generated documentation or
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# if some version control system is used.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncPROJECT_NUMBER =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# base path where the generated documentation will be put.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If a relative path is entered, it will be relative to the location
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# where doxygen was started. If left blank the current directory will be used.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#OUTPUT_DIRECTORY =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# 4096 sub-directories (in 2 levels) under the output directory of each output
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# format and will distribute the generated files over these directories.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Enabling this option can be useful when feeding doxygen a huge amount of
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# source files, where putting all generated files in the same directory would
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# otherwise cause performance problems for the file system.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncCREATE_SUBDIRS = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The OUTPUT_LANGUAGE tag is used to specify the language in which all
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# documentation generated by doxygen is written. Doxygen will use this
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# information to generate all constant output in the proper language.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The default language is English, other supported languages are:
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# and Ukrainian.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncOUTPUT_LANGUAGE = English
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# include brief member descriptions after the members that are listed in
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the file and class documentation (similar to JavaDoc).
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Set to NO to disable this.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncBRIEF_MEMBER_DESC = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the brief description of a member or function before the detailed description.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# brief descriptions will be completely suppressed.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncREPEAT_BRIEF = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# This tag implements a quasi-intelligent brief description abbreviator
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# that is used to form the text in various listings. Each string
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# in this list, if found as the leading text of the brief description, will be
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# stripped from the text and the result after processing the whole list, is
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# used as the annotated text. Otherwise, the brief description is used as-is.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If left blank, the following values are used ("$name" is automatically
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# replaced with the name of the entity): "The $name class" "The $name widget"
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# "The $name file" "is" "provides" "specifies" "contains"
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# "represents" "a" "an" "the"
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncABBREVIATE_BRIEF =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Doxygen will generate a detailed section even if there is only a brief
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# description.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncALWAYS_DETAILED_SEC = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# inherited members of a class in the documentation of that class as if those
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# members were ordinary class members. Constructors, destructors and assignment
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# operators of the base classes will not be shown.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncINLINE_INHERITED_MEMB = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# path before files name in the file list and in the header files. If set
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# to NO the shortest path that makes the file name unique will be used.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncFULL_PATH_NAMES = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# can be used to strip a user-defined part of the path. Stripping is
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# only done if one of the specified strings matches the left-hand part of
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the path. The tag can be used to show relative paths in the file list.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If left blank the directory from which doxygen is run is used as the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# path to strip.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncSTRIP_FROM_PATH =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the path mentioned in the documentation of a class, which tells
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the reader which header file to include in order to use a class.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If left blank only the name of the header file containing the class
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# definition is used. Otherwise one should specify the include paths that
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# are normally passed to the compiler using the -I flag.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncSTRIP_FROM_INC_PATH =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# (but less readable) file names. This can be useful is your file systems
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# doesn't support long names like on DOS, Mac, or CD-ROM.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncSHORT_NAMES = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# will interpret the first line (until the first dot) of a JavaDoc-style
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# comment as the brief description. If set to NO, the JavaDoc
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# comments will behave just like regular Qt-style comments
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# (thus requiring an explicit @brief command for a brief description.)
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncJAVADOC_AUTOBRIEF = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# interpret the first line (until the first dot) of a Qt-style
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# comment as the brief description. If set to NO, the comments
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# will behave just like regular Qt-style comments (thus requiring
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# an explicit \brief command for a brief description.)
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncQT_AUTOBRIEF = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# treat a multi-line C++ special comment block (i.e. a block of //! or ///
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# comments) as a brief description. This used to be the default behaviour.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The new default is to treat a multi-line C++ comment block as a detailed
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# description. Set this tag to YES if you prefer the old behaviour instead.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncMULTILINE_CPP_IS_BRIEF = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the DETAILS_AT_TOP tag is set to YES then Doxygen
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# will output the detailed description near the top, like JavaDoc.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If set to NO, the detailed description appears after the member
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# documentation.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncDETAILS_AT_TOP = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# member inherits the documentation from any documented member that it
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# re-implements.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncINHERIT_DOCS = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# a new page for each member. If set to NO, the documentation of a member will
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# be part of the file/class/namespace that contains it.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncSEPARATE_MEMBER_PAGES = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The TAB_SIZE tag can be used to set the number of spaces in a tab.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Doxygen uses this value to replace tabs by spaces in code fragments.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncTAB_SIZE = 4
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# This tag can be used to specify a number of aliases that acts
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# as commands in the documentation. An alias has the form "name=value".
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# For example adding "sideeffect=\par Side Effects:\n" will allow you to
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# put the command \sideeffect (or @sideeffect) in the documentation, which
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# will result in a user-defined paragraph with heading "Side Effects:".
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# You can put \n's in the value part of an alias to insert newlines.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync "note=@remark"
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Interface method implementation macros.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncALIASES += \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync interface_method_impl{2}="Implements \1 method \link \1::\2 \2 \endlink @copydoc \1::\2 "
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncALIASES += \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync interface_method_impl{3}="\3. \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncImplements \1 method \link \1::\2 \2 \endlink @copydoc \1::\2 "
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Callback method implementation macros.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncALIASES += \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync callback_method_impl{1}="Implements the callback \link \1 \1 \endlink @copydoc \1 "
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncALIASES += \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync callback_method_impl{2}="\2. \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncImplements the callback \link \1 \1 "
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# sources only. Doxygen will then generate output that is more tailored for C.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# For instance, some of the names that are used will be different. The list
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# of all members will be omitted, etc.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncOPTIMIZE_OUTPUT_FOR_C = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# sources only. Doxygen will then generate output that is more tailored for
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Java. For instance, namespaces will be presented as packages, qualified
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# scopes will look different, etc.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncOPTIMIZE_OUTPUT_JAVA = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# sources only. Doxygen will then generate output that is more tailored for
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncOPTIMIZE_FOR_FORTRAN = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# sources. Doxygen will then generate output that is tailored for
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncOPTIMIZE_OUTPUT_VHDL = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# to include (a tag file for) the STL sources as input, then you should
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# set this tag to YES in order to let doxygen match functions declarations and
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# func(std::string) {}). This also make the inheritance and collaboration
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# diagrams that involve STL classes more complete and accurate.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncBUILTIN_STL_SUPPORT = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If you use Microsoft's C++/CLI language, you should set this option to YES to
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# enable parsing support.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncCPP_CLI_SUPPORT = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Doxygen will parse them like normal C++ but will assume all classes use public
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# instead of private inheritance when no explicit protection keyword is present.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncSIP_SUPPORT = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# For Microsoft's IDL there are propget and propput attributes to indicate getter
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# and setter methods for a property. Setting this option to YES (the default)
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# will make doxygen to replace the get and set methods by a property in the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# documentation. This will only work if the methods are indeed getting or
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# setting a simple type. If this is not the case, or you want to show the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# methods anyway, you should set this option to NO.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncIDL_PROPERTY_SUPPORT = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# tag is set to YES, then doxygen will reuse the documentation of the first
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# member in the group (if any) for the other members of the group. By default
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# all members of a group must be documented explicitly.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncDISTRIBUTE_GROUP_DOC = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the same type (for instance a group of public functions) to be put as a
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# subgroup of that type (e.g. under the Public Functions section). Set it to
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# NO to prevent subgrouping. Alternatively, this can be done per class using
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the \nosubgrouping command.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncSUBGROUPING = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# is documented as struct, union, or enum with the name of the typedef. So
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# with name TypeT. When disabled the typedef will appear as a member of a file,
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# namespace, or class. And the struct will be named TypeS. This can typically
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# be useful for C code in case the coding convention dictates that all compound
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# types are typedef'ed and only the typedef is referenced, never the tag name.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncTYPEDEF_HIDES_STRUCT = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Build related configuration options
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# documentation are documented, even if no documentation was available.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Private class members and static file members will be hidden unless
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncEXTRACT_ALL = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# will be included in the documentation.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncEXTRACT_PRIVATE = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the EXTRACT_STATIC tag is set to YES all static members of a file
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# will be included in the documentation.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncEXTRACT_STATIC = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# defined locally in source files will be included in the documentation.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If set to NO only classes defined in header files are included.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncEXTRACT_LOCAL_CLASSES = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# This flag is only useful for Objective-C code. When set to YES local
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# methods, which are defined in the implementation section but not in
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the interface are included in the documentation.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If set to NO (the default) only methods in the interface are included.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncEXTRACT_LOCAL_METHODS = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If this flag is set to YES, the members of anonymous namespaces will be
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# extracted and appear in the documentation as a namespace called
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# 'anonymous_namespace{file}', where file will be replaced with the base
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# name of the file that contains the anonymous namespace. By default
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# anonymous namespace are hidden.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncEXTRACT_ANON_NSPACES = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# undocumented members of documented classes, files or namespaces.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If set to NO (the default) these members will be included in the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# various overviews, but no documentation section is generated.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# This option has no effect if EXTRACT_ALL is enabled.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncHIDE_UNDOC_MEMBERS = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# undocumented classes that are normally visible in the class hierarchy.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If set to NO (the default) these classes will be included in the various
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# overviews. This option has no effect if EXTRACT_ALL is enabled.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncHIDE_UNDOC_CLASSES = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# friend (class|struct|union) declarations.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If set to NO (the default) these declarations will be included in the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# documentation.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncHIDE_FRIEND_COMPOUNDS = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# documentation blocks found inside the body of a function.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If set to NO (the default) these blocks will be appended to the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# function's detailed documentation block.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncHIDE_IN_BODY_DOCS = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The INTERNAL_DOCS tag determines if documentation
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# that is typed after a \internal command is included. If the tag is set
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# to NO (the default) then the documentation will be excluded.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Set it to YES to include the internal documentation.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncINTERNAL_DOCS = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# file names in lower-case letters. If set to YES upper-case letters are also
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# allowed. This is useful if you have classes or files whose names only differ
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# in case and if your file system supports case sensitive file names. Windows
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# and Mac users are advised to set this option to NO.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncCASE_SENSE_NAMES = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# will show members with their full class and namespace scopes in the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# documentation. If set to YES the scope will be hidden.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncHIDE_SCOPE_NAMES = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# will put a list of the files that are included by a file in the documentation
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# of that file.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncSHOW_INCLUDE_FILES = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# is inserted in the documentation for inline members.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncINLINE_INFO = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# will sort the (detailed) documentation of file and class members
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# alphabetically by member name. If set to NO the members will appear in
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# declaration order.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncSORT_MEMBER_DOCS = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# brief documentation of file, namespace and class members alphabetically
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# by member name. If set to NO (the default) the members will appear in
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# declaration order.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncSORT_BRIEF_DOCS = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# hierarchy of group names into alphabetical order. If set to NO (the default)
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the group names will appear in their defined order.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncSORT_GROUP_NAMES = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# sorted by fully-qualified names, including namespaces. If set to
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# NO (the default), the class list will be sorted only by class name,
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# not including the namespace part.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Note: This option applies only to the class list, not to the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# alphabetical list.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncSORT_BY_SCOPE_NAME = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The GENERATE_TODOLIST tag can be used to enable (YES) or
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# disable (NO) the todo list. This list is created by putting \todo
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# commands in the documentation.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncGENERATE_TODOLIST = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The GENERATE_TESTLIST tag can be used to enable (YES) or
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# disable (NO) the test list. This list is created by putting \test
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# commands in the documentation.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncGENERATE_TESTLIST = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The GENERATE_BUGLIST tag can be used to enable (YES) or
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# disable (NO) the bug list. This list is created by putting \bug
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# commands in the documentation.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncGENERATE_BUGLIST = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# disable (NO) the deprecated list. This list is created by putting
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# \deprecated commands in the documentation.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncGENERATE_DEPRECATEDLIST= YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The ENABLED_SECTIONS tag can be used to enable conditional
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# documentation sections, marked by \if sectionname ... \endif.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncENABLED_SECTIONS =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the initial value of a variable or define consists of for it to appear in
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the documentation. If the initializer consists of more lines than specified
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# here it will be hidden. Use a value of 0 to hide initializers completely.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The appearance of the initializer of individual variables and defines in the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# documentation can be controlled using \showinitializer or \hideinitializer
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# command in the documentation regardless of this setting.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncMAX_INITIALIZER_LINES = 30
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# at the bottom of the documentation of classes and structs. If set to YES the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# list will mention the files that were used to generate the documentation.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncSHOW_USED_FILES = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the sources in your project are distributed over multiple directories
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# in the documentation. The default is NO.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncSHOW_DIRECTORIES = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# This will remove the Files entry from the Quick Index and from the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Folder Tree View (if specified). The default is YES.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncSHOW_FILES = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Namespaces page. This will remove the Namespaces entry from the Quick Index
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# and from the Folder Tree View (if specified). The default is YES.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncSHOW_NAMESPACES = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The FILE_VERSION_FILTER tag can be used to specify a program or script that
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# doxygen should invoke to get the current version for each file (typically from
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the version control system). Doxygen will invoke the program by executing (via
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# popen()) the command <command> <input-file>, where <command> is the value of
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# provided by doxygen. Whatever the program writes to standard output
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# is used as the file version. See the manual for examples.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncFILE_VERSION_FILTER =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# configuration options related to warning and progress messages
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The QUIET tag can be used to turn on/off the messages that are generated
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# by doxygen. Possible values are YES and NO. If left blank NO is used.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The WARNINGS tag can be used to turn on/off the warning messages that are
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# generated by doxygen. Possible values are YES and NO. If left blank
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# NO is used.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncWARNINGS = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# automatically be disabled.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncWARN_IF_UNDOCUMENTED = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# potential errors in the documentation, such as not documenting some
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# parameters in a documented function, or documenting parameters that
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# don't exist or using markup commands wrongly.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncWARN_IF_DOC_ERROR = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# This WARN_NO_PARAMDOC option can be abled to get warnings for
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# functions that are documented, but have no documentation for their parameters
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# or return value. If set to NO (the default) doxygen will only warn about
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# wrong or incomplete parameter documentation, but not about the absence of
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# documentation.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncWARN_NO_PARAMDOC = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The WARN_FORMAT tag determines the format of the warning messages that
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# doxygen can produce. The string should contain the $file, $line, and $text
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# tags, which will be replaced by the file and line number from which the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# warning originated and the warning text. Optionally the format may contain
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# $version, which will be replaced by the version of the file (if it could
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# be obtained via FILE_VERSION_FILTER)
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncWARN_FORMAT = "$file:$line: $text"
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The WARN_LOGFILE tag can be used to specify a file to which warning
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# and error messages should be written. If left blank the output is written
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# to stderr.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#WARN_LOGFILE =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# configuration options related to the input files
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The INPUT tag can be used to specify the files and/or directories that contain
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# documented source files. You may enter file names like "myfile.cpp" or
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# directories like "/usr/src/myproject". Separate the files or directories
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# with spaces.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# This tag can be used to specify the character encoding of the source files
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# also the default input encoding. Doxygen uses libiconv (or the iconv built
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the list of possible encodings.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncINPUT_ENCODING = UTF-8
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the value of the INPUT tag contains directories, you can use the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# and *.h) to filter out the source-files in the directories. If left
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# blank the following patterns are tested:
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#FILE_PATTERNS =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The RECURSIVE tag can be used to turn specify whether or not subdirectories
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# should be searched for input files as well. Possible values are YES and NO.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If left blank NO is used.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncRECURSIVE = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The EXCLUDE tag can be used to specify files and/or directories that should
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# excluded from the INPUT source files. This way you can easily exclude a
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# subdirectory from a directory tree whose root is specified with the INPUT tag.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# directories that are symbolic links (a Unix filesystem feature) are excluded
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# from the input.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncEXCLUDE_SYMLINKS = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the value of the INPUT tag contains directories, you can use the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# certain files from those directories. Note that the wildcards are matched
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# against the file with absolute path, so to exclude all test directories
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# for example use the pattern */test/*
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncEXCLUDE_PATTERNS =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# (namespaces, classes, functions, etc.) that should be excluded from the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# output. The symbol name can be a fully qualified name, a word, or if the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# wildcard * is used, a substring. Examples: ANamespace, AClass,
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# AClass::ANamespace, ANamespace::*Test
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncEXCLUDE_SYMBOLS =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The EXAMPLE_PATH tag can be used to specify one or more files or
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# directories that contain example code fragments that are included (see
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the \include command).
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncEXAMPLE_PATH =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the value of the EXAMPLE_PATH tag contains directories, you can use the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# and *.h) to filter out the source-files in the directories. If left
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# blank all files are included.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncEXAMPLE_PATTERNS =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# searched for input files to be used with the \include or \dontinclude
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# commands irrespective of the value of the RECURSIVE tag.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Possible values are YES and NO. If left blank NO is used.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncEXAMPLE_RECURSIVE = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The IMAGE_PATH tag can be used to specify one or more files or
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# directories that contain image that are included in the documentation (see
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the \image command).
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncIMAGE_PATH =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The INPUT_FILTER tag can be used to specify a program that doxygen should
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# invoke to filter for each input file. Doxygen will invoke the filter program
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# by executing (via popen()) the command <filter> <input-file>, where <filter>
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# input file. Doxygen will then use the output that the filter program writes
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# to standard output. If FILTER_PATTERNS is specified, this tag will be
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncINPUT_FILTER =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# basis. Doxygen will compare the file name with each pattern and apply the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# filter if there is a match. The filters are a list of the form:
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# is applied to all files.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncFILTER_PATTERNS =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# INPUT_FILTER) will be used to filter the input files when producing source
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# files to browse (i.e. when SOURCE_BROWSER is set to YES).
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncFILTER_SOURCE_FILES = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# configuration options related to source browsing
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the SOURCE_BROWSER tag is set to YES then a list of source files will
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# be generated. Documented entities will be cross-referenced with these sources.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Note: To get rid of all source code in the generated output, make sure also
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# VERBATIM_HEADERS is set to NO.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncSOURCE_BROWSER = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Setting the INLINE_SOURCES tag to YES will include the body
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# of functions and classes directly in the documentation.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncINLINE_SOURCES = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# doxygen to hide any special comment blocks from generated source code
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# fragments. Normal C and C++ comments will always remain visible.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncSTRIP_CODE_COMMENTS = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the REFERENCED_BY_RELATION tag is set to YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# then for each documented function all documented
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# functions referencing it will be listed.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncREFERENCED_BY_RELATION = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the REFERENCES_RELATION tag is set to YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# then for each documented function all documented entities
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# called/used by that function will be listed.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncREFERENCES_RELATION = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# link to the source code. Otherwise they will link to the documentstion.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncREFERENCES_LINK_SOURCE = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the USE_HTAGS tag is set to YES then the references to source code
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# will point to the HTML generated by the htags(1) tool instead of doxygen
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# built-in source browser. The htags tool is part of GNU's global source
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# tagging system (see http://www.gnu.org/software/global/global.html). You
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# will need version 4.8.6 or higher.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncUSE_HTAGS = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# will generate a verbatim copy of the header file for each class for
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# which an include is specified. Set to NO to disable this.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncVERBATIM_HEADERS = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# configuration options related to the alphabetical class index
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# of all compounds will be generated. Enable this if the project
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# contains a lot of classes, structs, unions or interfaces.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncALPHABETICAL_INDEX = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# in which this list will be split (can be a number in the range [1..20])
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncCOLS_IN_ALPHA_INDEX = 5
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# In case all classes in a project start with a common prefix, all
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# classes will be put under the same header in the alphabetical index.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# should be ignored while generating the index headers.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncIGNORE_PREFIX =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# configuration options related to the HTML output
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# generate HTML output.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncGENERATE_HTML = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If a relative path is entered the value of OUTPUT_DIRECTORY will be
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# put in front of it. If left blank `html' will be used as the default path.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncHTML_OUTPUT = html
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# doxygen will generate files with .html extension.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncHTML_FILE_EXTENSION = .html
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The HTML_HEADER tag can be used to specify a personal HTML header for
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# each generated HTML page. If it is left blank doxygen will generate a
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# standard header.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncHTML_HEADER =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The HTML_FOOTER tag can be used to specify a personal HTML footer for
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# each generated HTML page. If it is left blank doxygen will generate a
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# standard footer.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncHTML_FOOTER =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# style sheet that is used by each HTML page. It can be used to
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# fine-tune the look of the HTML output. If the tag is left blank doxygen
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# will generate a default style sheet. Note that doxygen will try to copy
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the style sheet file to the HTML output directory, so don't put your own
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# stylesheet in the HTML output directory as well, or it will be erased!
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncHTML_STYLESHEET =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# files or namespaces will be aligned in HTML using tables. If set to
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# NO a bullet list will be used.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncHTML_ALIGN_MEMBERS = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the GENERATE_HTMLHELP tag is set to YES, additional index files
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# will be generated that can be used as input for tools like the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# of the generated HTML documentation.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncGENERATE_HTMLHELP = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the GENERATE_DOCSET tag is set to YES, additional index files
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# will be generated that can be used as input for Apple's Xcode 3
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# integrated development environment, introduced with OSX 10.5 (Leopard).
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# To create a documentation set, doxygen will generate a Makefile in the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# HTML output directory. Running make will produce the docset in that
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# directory and running "make install" will install the docset in
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# it at startup.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncGENERATE_DOCSET = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# feed. A documentation feed provides an umbrella under which multiple
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# documentation sets from a single provider (such as a company or product suite)
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# can be grouped.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncDOCSET_FEEDNAME = "Doxygen generated docs"
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# should uniquely identify the documentation set bundle. This should be a
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# will append .docset to the name.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncDOCSET_BUNDLE_ID = org.doxygen.Project
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# documentation will contain sections that can be hidden and shown after the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# page has loaded. For this to work a browser that supports
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncHTML_DYNAMIC_SECTIONS = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# be used to specify the file name of the resulting .chm file. You
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# can add a path in front of the file if the result should not be
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# written to the html output directory.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# be used to specify the location (absolute path including file name) of
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the HTML help compiler on the generated index.hhp.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncHHC_LOCATION =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# controls if a separate .chi index file is generated (YES) or that
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# it should be included in the master .chm file (NO).
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncGENERATE_CHI = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# is used to encode HtmlHelp index (hhk), content (hhc) and project file
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncCHM_INDEX_ENCODING =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# controls whether a binary table of contents is generated (YES) or a
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# normal table of contents (NO) in the .chm file.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncBINARY_TOC = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The TOC_EXPAND flag can be set to YES to add extra items for group members
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# to the contents of the HTML help documentation and to the tree view.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncTOC_EXPAND = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# top of each HTML page. The value NO (the default) enables the index and
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the value YES disables it.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncDISABLE_INDEX = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# This tag can be used to set the number of enum values (range [1..20])
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# that doxygen will group on one line in the generated HTML documentation.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncENUM_VALUES_PER_LINE = 4
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# structure should be generated to display hierarchical information.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the tag value is set to FRAME, a side panel will be generated
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# containing a tree-like index structure (just like the one that
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# is generated for HTML Help). For this to work a browser that supports
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# probably better off using the HTML help feature. Other possible values
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# and Class Hierarchy pages using a tree view instead of an ordered list;
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# disables this behavior completely. For backwards compatibility with previous
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# respectively.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncGENERATE_TREEVIEW = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# used to set the initial width (in pixels) of the frame in which the tree
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncTREEVIEW_WIDTH = 250
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Use this tag to change the font size of Latex formulas included
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# as images in the HTML documentation. The default is 10. Note that
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# when you change the font size after a successful doxygen run you need
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# to manually remove any form_*.png images from the HTML output directory
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# to force them to be regenerated.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncFORMULA_FONTSIZE = 10
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# configuration options related to the LaTeX output
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# generate Latex output.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncGENERATE_LATEX = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If a relative path is entered the value of OUTPUT_DIRECTORY will be
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# put in front of it. If left blank `latex' will be used as the default path.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncLATEX_OUTPUT = latex
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# invoked. If left blank `latex' will be used as the default command name.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncLATEX_CMD_NAME = latex
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# generate index for LaTeX. If left blank `makeindex' will be used as the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# default command name.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncMAKEINDEX_CMD_NAME = makeindex
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# LaTeX documents. This may be useful for small projects and may help to
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# save some trees in general.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncCOMPACT_LATEX = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The PAPER_TYPE tag can be used to set the paper type that is used
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# by the printer. Possible values are: a4, a4wide, letter, legal and
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# executive. If left blank a4wide will be used.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncPAPER_TYPE = a4wide
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# packages that should be included in the LaTeX output.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncEXTRA_PACKAGES =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the generated latex document. The header should contain everything until
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the first chapter. If it is left blank doxygen will generate a
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# standard header. Notice: only use this tag if you know what you are doing!
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncLATEX_HEADER =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# is prepared for conversion to pdf (using ps2pdf). The pdf file will
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# contain links (just like the HTML output) instead of page references
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# This makes the output suitable for online browsing using a pdf viewer.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncPDF_HYPERLINKS = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# plain latex in the generated Makefile. Set this option to YES to get a
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# higher quality PDF documentation.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncUSE_PDFLATEX = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# command to the generated LaTeX files. This will instruct LaTeX to keep
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# running if errors occur, instead of asking the user for help.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# This option is also used when generating formulas in HTML.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncLATEX_BATCHMODE = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If LATEX_HIDE_INDICES is set to YES then doxygen will not
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# include the index chapters (such as File Index, Compound Index, etc.)
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# in the output.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncLATEX_HIDE_INDICES = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# configuration options related to the RTF output
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The RTF output is optimized for Word 97 and may not look very pretty with
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# other RTF readers or editors.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncGENERATE_RTF = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If a relative path is entered the value of OUTPUT_DIRECTORY will be
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# put in front of it. If left blank `rtf' will be used as the default path.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncRTF_OUTPUT = rtf
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# RTF documents. This may be useful for small projects and may help to
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# save some trees in general.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncCOMPACT_RTF = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# will contain hyperlink fields. The RTF file will
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# contain links (just like the HTML output) instead of page references.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# This makes the output suitable for online browsing using WORD or other
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# programs which support those fields.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Note: wordpad (write) and others do not support links.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncRTF_HYPERLINKS = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Load stylesheet definitions from file. Syntax is similar to doxygen's
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# config file, i.e. a series of assignments. You only have to provide
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# replacements, missing definitions are set to their default value.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncRTF_STYLESHEET_FILE =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Set optional variables used in the generation of an rtf document.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Syntax is similar to doxygen's config file.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncRTF_EXTENSIONS_FILE =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# configuration options related to the man page output
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# generate man pages
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncGENERATE_MAN = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The MAN_OUTPUT tag is used to specify where the man pages will be put.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If a relative path is entered the value of OUTPUT_DIRECTORY will be
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# put in front of it. If left blank `man' will be used as the default path.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncMAN_OUTPUT = man
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The MAN_EXTENSION tag determines the extension that is added to
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the generated man pages (default is the subroutine's section .3)
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncMAN_EXTENSION = .3
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# then it will generate one additional man file for each entity
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# documented in the real man page(s). These additional files
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# only source the real man page, but without them the man command
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# would be unable to find the correct page. The default is NO.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncMAN_LINKS = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# configuration options related to the XML output
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the GENERATE_XML tag is set to YES Doxygen will
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# generate an XML file that captures the structure of
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the code including all documentation.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncGENERATE_XML = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The XML_OUTPUT tag is used to specify where the XML pages will be put.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If a relative path is entered the value of OUTPUT_DIRECTORY will be
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# put in front of it. If left blank `xml' will be used as the default path.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncXML_OUTPUT = xml
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The XML_SCHEMA tag can be used to specify an XML schema,
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# which can be used by a validating XML parser to check the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# syntax of the XML files.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncXML_SCHEMA =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The XML_DTD tag can be used to specify an XML DTD,
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# which can be used by a validating XML parser to check the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# syntax of the XML files.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# dump the program listings (including syntax highlighting
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# and cross-referencing information) to the XML output. Note that
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# enabling this will significantly increase the size of the XML output.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncXML_PROGRAMLISTING = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# configuration options for the AutoGen Definitions output
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# generate an AutoGen Definitions (see autogen.sf.net) file
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# that captures the structure of the code including all
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# documentation. Note that this feature is still experimental
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# and incomplete at the moment.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncGENERATE_AUTOGEN_DEF = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# configuration options related to the Perl module output
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the GENERATE_PERLMOD tag is set to YES Doxygen will
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# generate a Perl module file that captures the structure of
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the code including all documentation. Note that this
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# feature is still experimental and incomplete at the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncGENERATE_PERLMOD = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the necessary Makefile rules, Perl scripts and LaTeX code to be able
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# to generate PDF and DVI output from the Perl module output.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncPERLMOD_LATEX = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# nicely formatted so it can be parsed by a human reader. This is useful
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# if you want to understand what is going on. On the other hand, if this
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# tag is set to NO the size of the Perl module output will be much smaller
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# and Perl will parse it just the same.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncPERLMOD_PRETTY = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The names of the make variables in the generated doxyrules.make file
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# This is useful so different doxyrules.make files included by the same
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Makefile don't overwrite each other's variables.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncPERLMOD_MAKEVAR_PREFIX =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Configuration options related to the preprocessor
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# evaluate all C-preprocessor directives found in the sources and include
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncENABLE_PREPROCESSING = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# names in the source code. If set to NO (the default) only conditional
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# compilation will be performed. Macro expansion can be done in a controlled
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# way by setting EXPAND_ONLY_PREDEF to YES.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncMACRO_EXPANSION = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# then the macro expansion is limited to the macros specified with the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# PREDEFINED and EXPAND_AS_DEFINED tags.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncEXPAND_ONLY_PREDEF = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# in the INCLUDE_PATH (see below) will be search if a #include is found.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncSEARCH_INCLUDES = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The INCLUDE_PATH tag can be used to specify one or more directories that
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# contain include files that are not input files but should be processed by
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the preprocessor.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#INCLUDE_PATH =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# patterns (like *.h and *.hpp) to filter out the header-files in the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# directories. If left blank, the patterns specified with FILE_PATTERNS will
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#INCLUDE_FILE_PATTERNS =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The PREDEFINED tag can be used to specify one or more macro names that
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# are defined before the preprocessor is started (similar to the -D option of
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# gcc). The argument of the tag is a list of macros of the form: name
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# or name=definition (no spaces). If the definition and the = are
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# omitted =1 is assumed. To prevent a macro definition from being
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# undefined via #undef or recursively expanded use the := operator
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# instead of the = operator.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncPREDEFINED = \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync DOXYGEN_RUNNING \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync RT_C_DECLS_END= \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync RT_C_DECLS_BEGIN= \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync RT_STRICT=1 \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync __cplusplus=1 \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync ARCH_BITS=HC_ARCH_BITS \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync R3_ARCH_BITS=HC_ARCH_BITS \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync R0_ARCH_BITS=HC_ARCH_BITS \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync RTDECL(type)=type \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync RT_EXPORT_SYMBOL(name)= \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync "DECLINLINE(type)=inline type" \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync DECL_FORCE_INLINE(type)=DECLINLINE(type) \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync AssertCompile(expr) \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync AssertCompileSize(a,b) \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync AssertCompileSizeAlignment(a,b) \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync AssertCompileMemberSizeAlignment(a,b,c) \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync AssertCompileMemberAlignment(a,b,c) \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync AssertCompileMemberOffset(a,b,c) \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync AssertCompile2MemberOffsets(a,b,c) \
6716c5c35f6e4987aecd2ad2f65f3ecebf235f6bvboxsync RT_OS_DARWIN \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# this tag can be used to specify a list of macro names that should be expanded.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The macro definition that is found in the sources will be used.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Use the PREDEFINED tag if you want to use a different macro definition.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncEXPAND_AS_DEFINED = \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync ARCH_BITS \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync GC_ARCH_BITS \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync HC_ARCH_BITS \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync R3_ARCH_BITS \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync R0_ARCH_BITS \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync GCPTRTYPE \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync HCPTRTYPE \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync R0PTRTYPE \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync R3PTRTYPE \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync R3R0PTRTYPE \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync DECLEXPORT \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync DECLIMPORT \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync DECLHIDDEN \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync DECLASMTYPE \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync DECLCALLBACK \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync DECLCALLBACKMEMBER \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync DECLHCCALLBACKMEMBER \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync DECLRCCALLBACKMEMBER \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync DECLR3CALLBACKMEMBER \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync DECLR0CALLBACKMEMBER \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync RTDATADECL \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync OTHERCTXSUFF \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync OTHERCTXMID \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync RT_SRC_POS \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync RT_SRC_POS_ARGS \
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync RT_SRC_POS_DECL
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# doxygen's preprocessor will remove all function-like macros that are alone
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# on a line, have an all uppercase name, and do not end with a semicolon. Such
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# function macros are typically used for boiler-plate code, and will confuse
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the parser if not removed.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#SKIP_FUNCTION_MACROS = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Configuration::additions related to external references
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The TAGFILES option can be used to specify one or more tagfiles.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Optionally an initial location of the external documentation
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# can be added for each tagfile. The format of a tag file without
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# this location is as follows:
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# TAGFILES = file1 file2 ...
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Adding location for the tag files is done as follows:
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# TAGFILES = file1=loc1 "file2 = loc2" ...
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# where "loc1" and "loc2" can be relative or absolute paths or
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# URLs. If a location is present for each tag, the installdox tool
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# does not have to be run to correct the links.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Note that each tag file must have a unique name
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# (where the name does NOT include the path)
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If a tag file is not located in the directory in which doxygen
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# is run, you must also specify the path to the tagfile here.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# When a file name is specified after GENERATE_TAGFILE, doxygen will create
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# a tag file that is based on the input files it reads.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncGENERATE_TAGFILE =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the ALLEXTERNALS tag is set to YES all external classes will be listed
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# in the class index. If set to NO only the inherited external classes
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# will be listed.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncALLEXTERNALS = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# in the modules index. If set to NO, only the current project's groups will
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# be listed.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncEXTERNAL_GROUPS = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The PERL_PATH should be the absolute path and name of the perl script
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# interpreter (i.e. the result of `which perl').
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Configuration options related to the dot tool
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# or super classes. Setting the tag to NO turns the diagrams off. Note that
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# this option is superseded by the HAVE_DOT option below. This is only a
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# fallback. It is recommended to install and use dot, since it yields more
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# powerful graphs.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncCLASS_DIAGRAMS = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# You can define message sequence charts within doxygen comments using the \msc
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# command. Doxygen will then run the mscgen tool (see
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# documentation. The MSCGEN_PATH tag allows you to specify the directory where
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the mscgen tool resides. If left empty the tool is assumed to be found in the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# default search path.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncMSCGEN_PATH =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If set to YES, the inheritance and collaboration graphs will hide
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# inheritance and usage relations if the target is undocumented
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# or is not a class.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncHIDE_UNDOC_RELATIONS = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# available from the path. This tool is part of Graphviz, a graph visualization
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# toolkit from AT&T and Lucent Bell Labs. The other options in this section
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# have no effect if this option is set to NO (the default)
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncHAVE_DOT = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# By default doxygen will write a font called FreeSans.ttf to the output
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# directory and reference it in all dot files that doxygen generates. This
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# font does not include all possible unicode characters however, so when you need
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# these (or just want a differently looking font) you can specify the font name
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# which can be done by putting it in a standard location or by setting the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# containing the font.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncDOT_FONTNAME = FreeSans
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# By default doxygen will tell dot to use the output directory to look for the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# FreeSans.ttf font (which doxygen will put there itself). If you specify a
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# different font using DOT_FONTNAME you can set the path where dot
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# can find it using this tag.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncDOT_FONTPATH =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# will generate a graph for each documented class showing the direct and
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# indirect inheritance relations. Setting this tag to YES will force the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the CLASS_DIAGRAMS tag to NO.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncCLASS_GRAPH = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# will generate a graph for each documented class showing the direct and
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# indirect implementation dependencies (inheritance, containment, and
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# class references variables) of the class with other documented classes.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncCOLLABORATION_GRAPH = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# will generate a graph for groups, showing the direct groups dependencies
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncGROUP_GRAPHS = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# collaboration diagrams in a style similar to the OMG's Unified Modeling
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncUML_LOOK = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If set to YES, the inheritance and collaboration graphs will show the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# relations between templates and their instances.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncTEMPLATE_RELATIONS = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# tags are set to YES then doxygen will generate a graph for each documented
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# file showing the direct and indirect include dependencies of the file with
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# other documented files.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncINCLUDE_GRAPH = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# documented header file showing the documented files that directly or
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# indirectly include this file.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncINCLUDED_BY_GRAPH = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the CALL_GRAPH and HAVE_DOT options are set to YES then
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# doxygen will generate a call dependency graph for every global function
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# or class method. Note that enabling this option will significantly increase
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the time of a run. So in most cases it will be better to enable call graphs
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# for selected functions only using the \callgraph command.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncCALL_GRAPH = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# doxygen will generate a caller dependency graph for every global function
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# or class method. Note that enabling this option will significantly increase
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the time of a run. So in most cases it will be better to enable caller
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# graphs for selected functions only using the \callergraph command.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncCALLER_GRAPH = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# will graphical hierarchy of all classes instead of a textual one.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncGRAPHICAL_HIERARCHY = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# then doxygen will show the dependencies a directory has on other directories
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# in a graphical way. The dependency relations are determined by the #include
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# relations between the files in the directories.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncDIRECTORY_GRAPH = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# generated by dot. Possible values are png, jpg, or gif
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If left blank png will be used.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncDOT_IMAGE_FORMAT = png
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The tag DOT_PATH can be used to specify the path where the dot tool can be
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# found. If left blank, it is assumed the dot tool can be found in the path.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The DOTFILE_DIRS tag can be used to specify one or more directories that
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# contain dot files that are included in the documentation (see the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# \dotfile command).
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncDOTFILE_DIRS =
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# nodes that will be shown in the graph. If the number of nodes in a graph
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# becomes larger than this value, doxygen will truncate the graph, which is
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# visualized by representing a node as a red box. Note that doxygen if the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# number of direct children of the root node in a graph is already larger than
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncDOT_GRAPH_MAX_NODES = 50
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# graphs generated by dot. A depth value of 3 means that only nodes reachable
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# from the root by following a path via at most 3 edges will be shown. Nodes
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# that lay further from the root node will be omitted. Note that setting this
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# option to 1 or 2 may greatly reduce the computation time needed for large
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# code bases. Also note that the size of a graph can be further restricted by
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncMAX_DOT_GRAPH_DEPTH = 0
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# background. This is enabled by default, which results in a transparent
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# background. Warning: Depending on the platform used, enabling this option
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# may lead to badly anti-aliased labels on the edges of a graph (i.e. they
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# become hard to read).
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncDOT_TRANSPARENT = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# files in one run (i.e. multiple -o and -T options on the command line). This
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# makes dot run faster, but since only newer versions of dot (>1.8.10)
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# support this, this feature is disabled by default.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncDOT_MULTI_TARGETS = NO
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# generate a legend page explaining the meaning of the various boxes and
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# arrows in the dot generated graphs.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncGENERATE_LEGEND = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# remove the intermediate dot files that are used to generate
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# the various graphs.
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsyncDOT_CLEANUP = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# Configuration::additions related to the search engine
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync#---------------------------------------------------------------------------
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The SEARCHENGINE tag specifies whether or not a search engine should be
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# used. If set to NO the values of all tags below this one will be ignored.
ac2f474cb351240b8a8e5e2049b0b7badb99fffavboxsyncSEARCHENGINE = YES
4d70901ea82628b9ad4f093d47bb048b8bbd207evboxsync# The next bit is generated by the Makefile.