a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Doxyfile 1.6.1
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# This file describes the settings to be used by the documentation system
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# doxygen (www.doxygen.org) for a project
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# All text after a hash (#) is considered a comment and will be ignored
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The format is:
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# TAG = value [value, ...]
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# For lists items can also be appended using:
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# TAG += value [value, ...]
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Values that contain spaces should be placed between quotes (" ")
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Project related configuration options
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# This tag specifies the encoding used for all characters in the config file
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# that follow. The default is UTF-8 which is also the encoding used for all
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# text before the first occurrence of this tag. Doxygen uses libiconv (or the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# iconv built into libc) for the transcoding. See
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# http://www.gnu.org/software/libiconv for the list of possible encodings.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaDOXYFILE_ENCODING = UTF-8
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# by quotes) that should identify the project.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaPROJECT_NAME = sss_simpleifp
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The PROJECT_NUMBER tag can be used to enter a project or revision number.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# This could be handy for archiving the generated documentation or
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# if some version control system is used.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaPROJECT_NUMBER = @PACKAGE_VERSION@
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# base path where the generated documentation will be put.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If a relative path is entered, it will be relative to the location
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# where doxygen was started. If left blank the current directory will be used.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaOUTPUT_DIRECTORY = sss_simpleifp_doc
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# 4096 sub-directories (in 2 levels) under the output directory of each output
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# format and will distribute the generated files over these directories.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Enabling this option can be useful when feeding doxygen a huge amount of
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# source files, where putting all generated files in the same directory would
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# otherwise cause performance problems for the file system.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaCREATE_SUBDIRS = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The OUTPUT_LANGUAGE tag is used to specify the language in which all
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# documentation generated by doxygen is written. Doxygen will use this
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# information to generate all constant output in the proper language.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The default language is English, other supported languages are:
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaOUTPUT_LANGUAGE = English
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# include brief member descriptions after the members that are listed in
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the file and class documentation (similar to JavaDoc).
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Set to NO to disable this.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaBRIEF_MEMBER_DESC = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the brief description of a member or function before the detailed description.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# brief descriptions will be completely suppressed.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaREPEAT_BRIEF = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# This tag implements a quasi-intelligent brief description abbreviator
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# that is used to form the text in various listings. Each string
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# in this list, if found as the leading text of the brief description, will be
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# stripped from the text and the result after processing the whole list, is
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# used as the annotated text. Otherwise, the brief description is used as-is.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If left blank, the following values are used ("$name" is automatically
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# replaced with the name of the entity): "The $name class" "The $name widget"
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# "The $name file" "is" "provides" "specifies" "contains"
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# "represents" "a" "an" "the"
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaABBREVIATE_BRIEF = "The $name class" \
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina "The $name widget" \
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina "The $name file" \
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Doxygen will generate a detailed section even if there is only a brief
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# description.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaALWAYS_DETAILED_SEC = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# inherited members of a class in the documentation of that class as if those
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# members were ordinary class members. Constructors, destructors and assignment
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# operators of the base classes will not be shown.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaINLINE_INHERITED_MEMB = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# path before files name in the file list and in the header files. If set
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# to NO the shortest path that makes the file name unique will be used.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaFULL_PATH_NAMES = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# can be used to strip a user-defined part of the path. Stripping is
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# only done if one of the specified strings matches the left-hand part of
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the path. The tag can be used to show relative paths in the file list.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If left blank the directory from which doxygen is run is used as the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# path to strip.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaSTRIP_FROM_PATH =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the path mentioned in the documentation of a class, which tells
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the reader which header file to include in order to use a class.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If left blank only the name of the header file containing the class
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# definition is used. Otherwise one should specify the include paths that
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# are normally passed to the compiler using the -I flag.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaSTRIP_FROM_INC_PATH =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# (but less readable) file names. This can be useful is your file systems
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# doesn't support long names like on DOS, Mac, or CD-ROM.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaSHORT_NAMES = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# will interpret the first line (until the first dot) of a JavaDoc-style
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# comment as the brief description. If set to NO, the JavaDoc
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# comments will behave just like regular Qt-style comments
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# (thus requiring an explicit @brief command for a brief description.)
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaJAVADOC_AUTOBRIEF = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# interpret the first line (until the first dot) of a Qt-style
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# comment as the brief description. If set to NO, the comments
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# will behave just like regular Qt-style comments (thus requiring
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# an explicit \brief command for a brief description.)
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaQT_AUTOBRIEF = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# treat a multi-line C++ special comment block (i.e. a block of //! or ///
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# comments) as a brief description. This used to be the default behaviour.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The new default is to treat a multi-line C++ comment block as a detailed
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# description. Set this tag to YES if you prefer the old behaviour instead.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaMULTILINE_CPP_IS_BRIEF = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# member inherits the documentation from any documented member that it
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# re-implements.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaINHERIT_DOCS = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# a new page for each member. If set to NO, the documentation of a member will
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# be part of the file/class/namespace that contains it.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaSEPARATE_MEMBER_PAGES = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The TAB_SIZE tag can be used to set the number of spaces in a tab.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Doxygen uses this value to replace tabs by spaces in code fragments.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# This tag can be used to specify a number of aliases that acts
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# as commands in the documentation. An alias has the form "name=value".
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# For example adding "sideeffect=\par Side Effects:\n" will allow you to
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# put the command \sideeffect (or @sideeffect) in the documentation, which
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# will result in a user-defined paragraph with heading "Side Effects:".
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# You can put \n's in the value part of an alias to insert newlines.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# sources only. Doxygen will then generate output that is more tailored for C.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# For instance, some of the names that are used will be different. The list
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# of all members will be omitted, etc.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaOPTIMIZE_OUTPUT_FOR_C = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# sources only. Doxygen will then generate output that is more tailored for
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Java. For instance, namespaces will be presented as packages, qualified
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# scopes will look different, etc.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaOPTIMIZE_OUTPUT_JAVA = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# sources only. Doxygen will then generate output that is more tailored for
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaOPTIMIZE_FOR_FORTRAN = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# sources. Doxygen will then generate output that is tailored for
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaOPTIMIZE_OUTPUT_VHDL = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Doxygen selects the parser to use depending on the extension of the files it parses.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# With this tag you can assign which parser to use for a given extension.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Doxygen has a built-in mapping, but you can override or extend it using this tag.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The format is ext=language, where ext is a file extension, and language is one of
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaEXTENSION_MAPPING =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# to include (a tag file for) the STL sources as input, then you should
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# set this tag to YES in order to let doxygen match functions declarations and
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# func(std::string) {}). This also make the inheritance and collaboration
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# diagrams that involve STL classes more complete and accurate.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaBUILTIN_STL_SUPPORT = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If you use Microsoft's C++/CLI language, you should set this option to YES to
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# enable parsing support.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaCPP_CLI_SUPPORT = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Doxygen will parse them like normal C++ but will assume all classes use public
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# instead of private inheritance when no explicit protection keyword is present.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaSIP_SUPPORT = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# For Microsoft's IDL there are propget and propput attributes to indicate getter
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# and setter methods for a property. Setting this option to YES (the default)
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# will make doxygen to replace the get and set methods by a property in the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# documentation. This will only work if the methods are indeed getting or
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# setting a simple type. If this is not the case, or you want to show the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# methods anyway, you should set this option to NO.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaIDL_PROPERTY_SUPPORT = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# tag is set to YES, then doxygen will reuse the documentation of the first
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# member in the group (if any) for the other members of the group. By default
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# all members of a group must be documented explicitly.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaDISTRIBUTE_GROUP_DOC = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the same type (for instance a group of public functions) to be put as a
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# subgroup of that type (e.g. under the Public Functions section). Set it to
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# NO to prevent subgrouping. Alternatively, this can be done per class using
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the \nosubgrouping command.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaSUBGROUPING = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# is documented as struct, union, or enum with the name of the typedef. So
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# with name TypeT. When disabled the typedef will appear as a member of a file,
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# namespace, or class. And the struct will be named TypeS. This can typically
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# be useful for C code in case the coding convention dictates that all compound
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# types are typedef'ed and only the typedef is referenced, never the tag name.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaTYPEDEF_HIDES_STRUCT = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# determine which symbols to keep in memory and which to flush to disk.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# When the cache is full, less often used symbols will be written to disk.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# For small to medium size projects (<1000 input files) the default value is
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# probably good enough. For larger projects a too small cache size can cause
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# doxygen to be busy swapping symbols to and from disk most of the time
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# causing a significant performance penality.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the system has enough physical memory increasing the cache will improve the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# performance by keeping more symbols in memory. Note that the value works on
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# a logarithmic scale so increasing the size by one will rougly double the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# memory usage. The cache size is given by this formula:
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# corresponding to a cache size of 2^16 = 65536 symbols
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaSYMBOL_CACHE_SIZE = 0
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Build related configuration options
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# documentation are documented, even if no documentation was available.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Private class members and static file members will be hidden unless
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaEXTRACT_ALL = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# will be included in the documentation.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaEXTRACT_PRIVATE = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the EXTRACT_STATIC tag is set to YES all static members of a file
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# will be included in the documentation.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaEXTRACT_STATIC = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# defined locally in source files will be included in the documentation.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If set to NO only classes defined in header files are included.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaEXTRACT_LOCAL_CLASSES = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# This flag is only useful for Objective-C code. When set to YES local
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# methods, which are defined in the implementation section but not in
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the interface are included in the documentation.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If set to NO (the default) only methods in the interface are included.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaEXTRACT_LOCAL_METHODS = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If this flag is set to YES, the members of anonymous namespaces will be
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# extracted and appear in the documentation as a namespace called
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# 'anonymous_namespace{file}', where file will be replaced with the base
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# name of the file that contains the anonymous namespace. By default
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# anonymous namespace are hidden.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaEXTRACT_ANON_NSPACES = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# undocumented members of documented classes, files or namespaces.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If set to NO (the default) these members will be included in the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# various overviews, but no documentation section is generated.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# This option has no effect if EXTRACT_ALL is enabled.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaHIDE_UNDOC_MEMBERS = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# undocumented classes that are normally visible in the class hierarchy.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If set to NO (the default) these classes will be included in the various
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# overviews. This option has no effect if EXTRACT_ALL is enabled.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaHIDE_UNDOC_CLASSES = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# friend (class|struct|union) declarations.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If set to NO (the default) these declarations will be included in the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# documentation.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaHIDE_FRIEND_COMPOUNDS = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# documentation blocks found inside the body of a function.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If set to NO (the default) these blocks will be appended to the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# function's detailed documentation block.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaHIDE_IN_BODY_DOCS = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The INTERNAL_DOCS tag determines if documentation
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# that is typed after a \internal command is included. If the tag is set
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# to NO (the default) then the documentation will be excluded.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Set it to YES to include the internal documentation.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaINTERNAL_DOCS = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# file names in lower-case letters. If set to YES upper-case letters are also
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# allowed. This is useful if you have classes or files whose names only differ
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# in case and if your file system supports case sensitive file names. Windows
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# and Mac users are advised to set this option to NO.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaCASE_SENSE_NAMES = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# will show members with their full class and namespace scopes in the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# documentation. If set to YES the scope will be hidden.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaHIDE_SCOPE_NAMES = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# will put a list of the files that are included by a file in the documentation
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# of that file.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaSHOW_INCLUDE_FILES = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# is inserted in the documentation for inline members.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaINLINE_INFO = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# will sort the (detailed) documentation of file and class members
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# alphabetically by member name. If set to NO the members will appear in
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# declaration order.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaSORT_MEMBER_DOCS = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# brief documentation of file, namespace and class members alphabetically
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# by member name. If set to NO (the default) the members will appear in
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# declaration order.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaSORT_BRIEF_DOCS = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaSORT_MEMBERS_CTORS_1ST = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# hierarchy of group names into alphabetical order. If set to NO (the default)
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the group names will appear in their defined order.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaSORT_GROUP_NAMES = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# sorted by fully-qualified names, including namespaces. If set to
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# NO (the default), the class list will be sorted only by class name,
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# not including the namespace part.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Note: This option applies only to the class list, not to the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# alphabetical list.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaSORT_BY_SCOPE_NAME = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The GENERATE_TODOLIST tag can be used to enable (YES) or
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# disable (NO) the todo list. This list is created by putting \todo
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# commands in the documentation.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaGENERATE_TODOLIST = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The GENERATE_TESTLIST tag can be used to enable (YES) or
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# disable (NO) the test list. This list is created by putting \test
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# commands in the documentation.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaGENERATE_TESTLIST = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The GENERATE_BUGLIST tag can be used to enable (YES) or
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# disable (NO) the bug list. This list is created by putting \bug
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# commands in the documentation.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaGENERATE_BUGLIST = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# disable (NO) the deprecated list. This list is created by putting
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# \deprecated commands in the documentation.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaGENERATE_DEPRECATEDLIST= YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The ENABLED_SECTIONS tag can be used to enable conditional
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# documentation sections, marked by \if sectionname ... \endif.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaENABLED_SECTIONS =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the initial value of a variable or define consists of for it to appear in
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the documentation. If the initializer consists of more lines than specified
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# here it will be hidden. Use a value of 0 to hide initializers completely.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The appearance of the initializer of individual variables and defines in the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# documentation can be controlled using \showinitializer or \hideinitializer
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# command in the documentation regardless of this setting.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaMAX_INITIALIZER_LINES = 30
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# at the bottom of the documentation of classes and structs. If set to YES the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# list will mention the files that were used to generate the documentation.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaSHOW_USED_FILES = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the sources in your project are distributed over multiple directories
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# in the documentation. The default is NO.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaSHOW_DIRECTORIES = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# This will remove the Files entry from the Quick Index and from the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Folder Tree View (if specified). The default is YES.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaSHOW_FILES = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Namespaces page.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# This will remove the Namespaces entry from the Quick Index
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# and from the Folder Tree View (if specified). The default is YES.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaSHOW_NAMESPACES = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The FILE_VERSION_FILTER tag can be used to specify a program or script that
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# doxygen should invoke to get the current version for each file (typically from
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the version control system). Doxygen will invoke the program by executing (via
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# popen()) the command <command> <input-file>, where <command> is the value of
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# provided by doxygen. Whatever the program writes to standard output
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# is used as the file version. See the manual for examples.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaFILE_VERSION_FILTER =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# doxygen. The layout file controls the global structure of the generated output files
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# in an output format independent way. The create the layout file that represents
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# file name after the option, if omitted DoxygenLayout.xml will be used as the name
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# of the layout file.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# configuration options related to warning and progress messages
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The QUIET tag can be used to turn on/off the messages that are generated
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# by doxygen. Possible values are YES and NO. If left blank NO is used.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The WARNINGS tag can be used to turn on/off the warning messages that are
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# generated by doxygen. Possible values are YES and NO. If left blank
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaWARNINGS = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# automatically be disabled.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaWARN_IF_UNDOCUMENTED = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# potential errors in the documentation, such as not documenting some
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# parameters in a documented function, or documenting parameters that
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# don't exist or using markup commands wrongly.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaWARN_IF_DOC_ERROR = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# This WARN_NO_PARAMDOC option can be abled to get warnings for
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# functions that are documented, but have no documentation for their parameters
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# or return value. If set to NO (the default) doxygen will only warn about
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# wrong or incomplete parameter documentation, but not about the absence of
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# documentation.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaWARN_NO_PARAMDOC = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The WARN_FORMAT tag determines the format of the warning messages that
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# doxygen can produce. The string should contain the $file, $line, and $text
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# tags, which will be replaced by the file and line number from which the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# warning originated and the warning text. Optionally the format may contain
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# $version, which will be replaced by the version of the file (if it could
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# be obtained via FILE_VERSION_FILTER)
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaWARN_FORMAT = "$file:$line: $text"
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The WARN_LOGFILE tag can be used to specify a file to which warning
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# and error messages should be written. If left blank the output is written
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaWARN_LOGFILE =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# configuration options related to the input files
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The INPUT tag can be used to specify the files and/or directories that contain
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# documented source files. You may enter file names like "myfile.cpp" or
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# directories like "/usr/src/myproject". Separate the files or directories
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# with spaces.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaINPUT = @abs_top_srcdir@/src/lib/sifp/sss_sifp.h
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# This tag can be used to specify the character encoding of the source files
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# also the default input encoding. Doxygen uses libiconv (or the iconv built
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the list of possible encodings.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaINPUT_ENCODING = UTF-8
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the value of the INPUT tag contains directories, you can use the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# and *.h) to filter out the source-files in the directories. If left
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# blank the following patterns are tested:
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaFILE_PATTERNS = *.cpp \
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The RECURSIVE tag can be used to turn specify whether or not subdirectories
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# should be searched for input files as well. Possible values are YES and NO.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If left blank NO is used.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaRECURSIVE = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The EXCLUDE tag can be used to specify files and/or directories that should
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# excluded from the INPUT source files. This way you can easily exclude a
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# subdirectory from a directory tree whose root is specified with the INPUT tag.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# directories that are symbolic links (a Unix filesystem feature) are excluded
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# from the input.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaEXCLUDE_SYMLINKS = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the value of the INPUT tag contains directories, you can use the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# certain files from those directories. Note that the wildcards are matched
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# against the file with absolute path, so to exclude all test directories
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# for example use the pattern */test/*
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaEXCLUDE_PATTERNS = */.git/* \
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# (namespaces, classes, functions, etc.) that should be excluded from the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# output. The symbol name can be a fully qualified name, a word, or if the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# wildcard * is used, a substring. Examples: ANamespace, AClass,
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# AClass::ANamespace, ANamespace::*Test
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaEXCLUDE_SYMBOLS =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The EXAMPLE_PATH tag can be used to specify one or more files or
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# directories that contain example code fragments that are included (see
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the \include command).
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaEXAMPLE_PATH =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the value of the EXAMPLE_PATH tag contains directories, you can use the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# and *.h) to filter out the source-files in the directories. If left
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# blank all files are included.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaEXAMPLE_PATTERNS =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# searched for input files to be used with the \include or \dontinclude
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# commands irrespective of the value of the RECURSIVE tag.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Possible values are YES and NO. If left blank NO is used.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaEXAMPLE_RECURSIVE = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The IMAGE_PATH tag can be used to specify one or more files or
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# directories that contain image that are included in the documentation (see
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the \image command).
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The INPUT_FILTER tag can be used to specify a program that doxygen should
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# invoke to filter for each input file. Doxygen will invoke the filter program
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# by executing (via popen()) the command <filter> <input-file>, where <filter>
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# input file. Doxygen will then use the output that the filter program writes
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# to standard output.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If FILTER_PATTERNS is specified, this tag will be
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaINPUT_FILTER =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Doxygen will compare the file name with each pattern and apply the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# filter if there is a match.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The filters are a list of the form:
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# is applied to all files.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaFILTER_PATTERNS =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# INPUT_FILTER) will be used to filter the input files when producing source
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# files to browse (i.e. when SOURCE_BROWSER is set to YES).
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaFILTER_SOURCE_FILES = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# configuration options related to source browsing
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the SOURCE_BROWSER tag is set to YES then a list of source files will
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# be generated. Documented entities will be cross-referenced with these sources.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Note: To get rid of all source code in the generated output, make sure also
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# VERBATIM_HEADERS is set to NO.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaSOURCE_BROWSER = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Setting the INLINE_SOURCES tag to YES will include the body
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# of functions and classes directly in the documentation.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaINLINE_SOURCES = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# doxygen to hide any special comment blocks from generated source code
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# fragments. Normal C and C++ comments will always remain visible.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaSTRIP_CODE_COMMENTS = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the REFERENCED_BY_RELATION tag is set to YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# then for each documented function all documented
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# functions referencing it will be listed.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaREFERENCED_BY_RELATION = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the REFERENCES_RELATION tag is set to YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# then for each documented function all documented entities
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# called/used by that function will be listed.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaREFERENCES_RELATION = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# link to the source code.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Otherwise they will link to the documentation.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaREFERENCES_LINK_SOURCE = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the USE_HTAGS tag is set to YES then the references to source code
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# will point to the HTML generated by the htags(1) tool instead of doxygen
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# built-in source browser. The htags tool is part of GNU's global source
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# tagging system (see http://www.gnu.org/software/global/global.html). You
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# will need version 4.8.6 or higher.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaUSE_HTAGS = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# will generate a verbatim copy of the header file for each class for
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# which an include is specified. Set to NO to disable this.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaVERBATIM_HEADERS = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# configuration options related to the alphabetical class index
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# of all compounds will be generated. Enable this if the project
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# contains a lot of classes, structs, unions or interfaces.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaALPHABETICAL_INDEX = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# in which this list will be split (can be a number in the range [1..20])
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaCOLS_IN_ALPHA_INDEX = 5
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# In case all classes in a project start with a common prefix, all
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# classes will be put under the same header in the alphabetical index.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# should be ignored while generating the index headers.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaIGNORE_PREFIX =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# configuration options related to the HTML output
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# generate HTML output.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaGENERATE_HTML = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# HTML page will contain the date and time when the page was generated. Setting
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# this to NO can help when comparing the output of multiple runs.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaHTML_TIMESTAMP = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If a relative path is entered the value of OUTPUT_DIRECTORY will be
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# put in front of it. If left blank `html' will be used as the default path.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaHTML_OUTPUT = html
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# doxygen will generate files with .html extension.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaHTML_FILE_EXTENSION = .html
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The HTML_HEADER tag can be used to specify a personal HTML header for
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# each generated HTML page. If it is left blank doxygen will generate a
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# standard header.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The HTML_FOOTER tag can be used to specify a personal HTML footer for
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# each generated HTML page. If it is left blank doxygen will generate a
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# standard footer.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# style sheet that is used by each HTML page. It can be used to
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# fine-tune the look of the HTML output. If the tag is left blank doxygen
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# will generate a default style sheet. Note that doxygen will try to copy
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the style sheet file to the HTML output directory, so don't put your own
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# stylesheet in the HTML output directory as well, or it will be erased!
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaHTML_STYLESHEET =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# files or namespaces will be aligned in HTML using tables. If set to
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# NO a bullet list will be used.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaHTML_ALIGN_MEMBERS = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# documentation will contain sections that can be hidden and shown after the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# page has loaded. For this to work a browser that supports
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaHTML_DYNAMIC_SECTIONS = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the GENERATE_DOCSET tag is set to YES, additional index files
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# will be generated that can be used as input for Apple's Xcode 3
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# integrated development environment, introduced with OSX 10.5 (Leopard).
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# To create a documentation set, doxygen will generate a Makefile in the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# HTML output directory. Running make will produce the docset in that
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# directory and running "make install" will install the docset in
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# it at startup.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaGENERATE_DOCSET = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# feed. A documentation feed provides an umbrella under which multiple
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# documentation sets from a single provider (such as a company or product suite)
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# can be grouped.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaDOCSET_FEEDNAME = "Doxygen generated docs"
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# should uniquely identify the documentation set bundle. This should be a
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# will append .docset to the name.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaDOCSET_BUNDLE_ID = org.doxygen.Project
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the GENERATE_HTMLHELP tag is set to YES, additional index files
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# will be generated that can be used as input for tools like the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# of the generated HTML documentation.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaGENERATE_HTMLHELP = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# be used to specify the file name of the resulting .chm file. You
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# can add a path in front of the file if the result should not be
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# written to the html output directory.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# be used to specify the location (absolute path including file name) of
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the HTML help compiler on the generated index.hhp.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaHHC_LOCATION =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# controls if a separate .chi index file is generated (YES) or that
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# it should be included in the master .chm file (NO).
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaGENERATE_CHI = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# is used to encode HtmlHelp index (hhk), content (hhc) and project file
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaCHM_INDEX_ENCODING =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# controls whether a binary table of contents is generated (YES) or a
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# normal table of contents (NO) in the .chm file.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaBINARY_TOC = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The TOC_EXPAND flag can be set to YES to add extra items for group members
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# to the contents of the HTML help documentation and to the tree view.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaTOC_EXPAND = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# are set, an additional index file will be generated that can be used as input for
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# HTML documentation.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaGENERATE_QHP = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# be used to specify the file name of the resulting .qch file.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The path specified is relative to the HTML output folder.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The QHP_NAMESPACE tag specifies the namespace to use when generating
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Qt Help Project output. For more information please see
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# http://doc.trolltech.com/qthelpproject.html#namespace
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaQHP_NAMESPACE =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Qt Help Project output. For more information please see
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# http://doc.trolltech.com/qthelpproject.html#virtual-folders
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaQHP_VIRTUAL_FOLDER = doc
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# For more information please see
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# http://doc.trolltech.com/qthelpproject.html#custom-filters
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaQHP_CUST_FILTER_NAME =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaQHP_CUST_FILTER_ATTRS =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# filter section matches.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaQHP_SECT_FILTER_ATTRS =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# be used to specify the location of Qt's qhelpgenerator.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If non-empty doxygen will try to run qhelpgenerator on the generated
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaQHG_LOCATION =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# top of each HTML page. The value NO (the default) enables the index and
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the value YES disables it.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaDISABLE_INDEX = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# This tag can be used to set the number of enum values (range [1..20])
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# that doxygen will group on one line in the generated HTML documentation.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaENUM_VALUES_PER_LINE = 4
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# structure should be generated to display hierarchical information.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the tag value is set to YES, a side panel will be generated
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# containing a tree-like index structure (just like the one that
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# is generated for HTML Help). For this to work a browser that supports
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Windows users are probably better off using the HTML help feature.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaGENERATE_TREEVIEW = NONE
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# and Class Hierarchy pages using a tree view instead of an ordered list.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaUSE_INLINE_TREES = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# used to set the initial width (in pixels) of the frame in which the tree
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaTREEVIEW_WIDTH = 250
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Use this tag to change the font size of Latex formulas included
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# as images in the HTML documentation. The default is 10. Note that
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# when you change the font size after a successful doxygen run you need
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# to manually remove any form_*.png images from the HTML output directory
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# to force them to be regenerated.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaFORMULA_FONTSIZE = 10
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# there is already a search function so this one should typically
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# be disabled.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaSEARCHENGINE = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# configuration options related to the LaTeX output
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# generate Latex output.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaGENERATE_LATEX = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If a relative path is entered the value of OUTPUT_DIRECTORY will be
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# put in front of it. If left blank `latex' will be used as the default path.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaLATEX_OUTPUT = latex
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# invoked. If left blank `latex' will be used as the default command name.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaLATEX_CMD_NAME = latex
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# generate index for LaTeX. If left blank `makeindex' will be used as the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# default command name.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaMAKEINDEX_CMD_NAME = makeindex
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# LaTeX documents. This may be useful for small projects and may help to
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# save some trees in general.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaCOMPACT_LATEX = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The PAPER_TYPE tag can be used to set the paper type that is used
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# by the printer. Possible values are: a4, a4wide, letter, legal and
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# executive. If left blank a4wide will be used.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaPAPER_TYPE = a4wide
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# packages that should be included in the LaTeX output.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaEXTRA_PACKAGES =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the generated latex document. The header should contain everything until
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the first chapter. If it is left blank doxygen will generate a
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# standard header. Notice: only use this tag if you know what you are doing!
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaLATEX_HEADER =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# is prepared for conversion to pdf (using ps2pdf). The pdf file will
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# contain links (just like the HTML output) instead of page references
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# This makes the output suitable for online browsing using a pdf viewer.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaPDF_HYPERLINKS = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# plain latex in the generated Makefile. Set this option to YES to get a
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# higher quality PDF documentation.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaUSE_PDFLATEX = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# command to the generated LaTeX files. This will instruct LaTeX to keep
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# running if errors occur, instead of asking the user for help.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# This option is also used when generating formulas in HTML.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaLATEX_BATCHMODE = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If LATEX_HIDE_INDICES is set to YES then doxygen will not
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# include the index chapters (such as File Index, Compound Index, etc.)
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# in the output.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaLATEX_HIDE_INDICES = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaLATEX_SOURCE_CODE = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# configuration options related to the RTF output
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The RTF output is optimized for Word 97 and may not look very pretty with
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# other RTF readers or editors.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaGENERATE_RTF = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If a relative path is entered the value of OUTPUT_DIRECTORY will be
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# put in front of it. If left blank `rtf' will be used as the default path.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaRTF_OUTPUT = rtf
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# RTF documents. This may be useful for small projects and may help to
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# save some trees in general.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaCOMPACT_RTF = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# will contain hyperlink fields. The RTF file will
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# contain links (just like the HTML output) instead of page references.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# This makes the output suitable for online browsing using WORD or other
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# programs which support those fields.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Note: wordpad (write) and others do not support links.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaRTF_HYPERLINKS = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Load stylesheet definitions from file. Syntax is similar to doxygen's
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# config file, i.e. a series of assignments. You only have to provide
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# replacements, missing definitions are set to their default value.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaRTF_STYLESHEET_FILE =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Set optional variables used in the generation of an rtf document.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Syntax is similar to doxygen's config file.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaRTF_EXTENSIONS_FILE =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# configuration options related to the man page output
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# generate man pages
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaGENERATE_MAN = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The MAN_OUTPUT tag is used to specify where the man pages will be put.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If a relative path is entered the value of OUTPUT_DIRECTORY will be
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# put in front of it. If left blank `man' will be used as the default path.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaMAN_OUTPUT = man
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The MAN_EXTENSION tag determines the extension that is added to
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the generated man pages (default is the subroutine's section .3)
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaMAN_EXTENSION = .3
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# then it will generate one additional man file for each entity
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# documented in the real man page(s). These additional files
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# only source the real man page, but without them the man command
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# would be unable to find the correct page. The default is NO.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaMAN_LINKS = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# configuration options related to the XML output
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the GENERATE_XML tag is set to YES Doxygen will
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# generate an XML file that captures the structure of
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the code including all documentation.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaGENERATE_XML = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The XML_OUTPUT tag is used to specify where the XML pages will be put.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If a relative path is entered the value of OUTPUT_DIRECTORY will be
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# put in front of it. If left blank `xml' will be used as the default path.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaXML_OUTPUT = xml
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The XML_SCHEMA tag can be used to specify an XML schema,
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# which can be used by a validating XML parser to check the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# syntax of the XML files.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The XML_DTD tag can be used to specify an XML DTD,
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# which can be used by a validating XML parser to check the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# syntax of the XML files.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# dump the program listings (including syntax highlighting
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# and cross-referencing information) to the XML output. Note that
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# enabling this will significantly increase the size of the XML output.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaXML_PROGRAMLISTING = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# configuration options for the AutoGen Definitions output
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# generate an AutoGen Definitions (see autogen.sf.net) file
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# that captures the structure of the code including all
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# documentation. Note that this feature is still experimental
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# and incomplete at the moment.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaGENERATE_AUTOGEN_DEF = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# configuration options related to the Perl module output
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the GENERATE_PERLMOD tag is set to YES Doxygen will
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# generate a Perl module file that captures the structure of
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the code including all documentation. Note that this
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# feature is still experimental and incomplete at the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaGENERATE_PERLMOD = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the necessary Makefile rules, Perl scripts and LaTeX code to be able
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# to generate PDF and DVI output from the Perl module output.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaPERLMOD_LATEX = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# nicely formatted so it can be parsed by a human reader.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# This is useful
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# if you want to understand what is going on.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# On the other hand, if this
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# tag is set to NO the size of the Perl module output will be much smaller
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# and Perl will parse it just the same.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaPERLMOD_PRETTY = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The names of the make variables in the generated doxyrules.make file
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# This is useful so different doxyrules.make files included by the same
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Makefile don't overwrite each other's variables.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaPERLMOD_MAKEVAR_PREFIX =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Configuration options related to the preprocessor
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# evaluate all C-preprocessor directives found in the sources and include
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaENABLE_PREPROCESSING = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# names in the source code. If set to NO (the default) only conditional
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# compilation will be performed. Macro expansion can be done in a controlled
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# way by setting EXPAND_ONLY_PREDEF to YES.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaMACRO_EXPANSION = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# then the macro expansion is limited to the macros specified with the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# PREDEFINED and EXPAND_AS_DEFINED tags.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaEXPAND_ONLY_PREDEF = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# in the INCLUDE_PATH (see below) will be search if a #include is found.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaSEARCH_INCLUDES = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The INCLUDE_PATH tag can be used to specify one or more directories that
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# contain include files that are not input files but should be processed by
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the preprocessor.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaINCLUDE_PATH =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# patterns (like *.h and *.hpp) to filter out the header-files in the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# directories. If left blank, the patterns specified with FILE_PATTERNS will
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaINCLUDE_FILE_PATTERNS =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The PREDEFINED tag can be used to specify one or more macro names that
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# are defined before the preprocessor is started (similar to the -D option of
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# gcc). The argument of the tag is a list of macros of the form: name
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# or name=definition (no spaces). If the definition and the = are
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# omitted =1 is assumed. To prevent a macro definition from being
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# undefined via #undef or recursively expanded use the := operator
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# instead of the = operator.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaPREDEFINED = DOXYGEN
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# this tag can be used to specify a list of macro names that should be expanded.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The macro definition that is found in the sources will be used.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Use the PREDEFINED tag if you want to use a different macro definition.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaEXPAND_AS_DEFINED =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# doxygen's preprocessor will remove all function-like macros that are alone
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# on a line, have an all uppercase name, and do not end with a semicolon. Such
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# function macros are typically used for boiler-plate code, and will confuse
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the parser if not removed.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaSKIP_FUNCTION_MACROS = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Configuration::additions related to external references
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The TAGFILES option can be used to specify one or more tagfiles.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Optionally an initial location of the external documentation
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# can be added for each tagfile. The format of a tag file without
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# this location is as follows:
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# TAGFILES = file1 file2 ...
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Adding location for the tag files is done as follows:
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# TAGFILES = file1=loc1 "file2 = loc2" ...
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# where "loc1" and "loc2" can be relative or absolute paths or
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# URLs. If a location is present for each tag, the installdox tool
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# does not have to be run to correct the links.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Note that each tag file must have a unique name
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# (where the name does NOT include the path)
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If a tag file is not located in the directory in which doxygen
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# is run, you must also specify the path to the tagfile here.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# When a file name is specified after GENERATE_TAGFILE, doxygen will create
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# a tag file that is based on the input files it reads.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaGENERATE_TAGFILE =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the ALLEXTERNALS tag is set to YES all external classes will be listed
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# in the class index. If set to NO only the inherited external classes
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# will be listed.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaALLEXTERNALS = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# in the modules index. If set to NO, only the current project's groups will
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaEXTERNAL_GROUPS = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The PERL_PATH should be the absolute path and name of the perl script
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# interpreter (i.e. the result of `which perl').
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Configuration options related to the dot tool
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina#---------------------------------------------------------------------------
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# or super classes. Setting the tag to NO turns the diagrams off. Note that
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# this option is superseded by the HAVE_DOT option below. This is only a
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# fallback. It is recommended to install and use dot, since it yields more
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# powerful graphs.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaCLASS_DIAGRAMS = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# You can define message sequence charts within doxygen comments using the \msc
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# command. Doxygen will then run the mscgen tool (see
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# documentation. The MSCGEN_PATH tag allows you to specify the directory where
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the mscgen tool resides. If left empty the tool is assumed to be found in the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# default search path.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If set to YES, the inheritance and collaboration graphs will hide
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# inheritance and usage relations if the target is undocumented
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# or is not a class.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaHIDE_UNDOC_RELATIONS = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# available from the path. This tool is part of Graphviz, a graph visualization
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# toolkit from AT&T and Lucent Bell Labs. The other options in this section
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# have no effect if this option is set to NO (the default)
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# By default doxygen will write a font called FreeSans.ttf to the output
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# directory and reference it in all dot files that doxygen generates. This
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# font does not include all possible unicode characters however, so when you need
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# these (or just want a differently looking font) you can specify the font name
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# which can be done by putting it in a standard location or by setting the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# containing the font.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaDOT_FONTNAME = FreeSans
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The default size is 10pt.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaDOT_FONTSIZE = 10
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# By default doxygen will tell dot to use the output directory to look for the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# FreeSans.ttf font (which doxygen will put there itself). If you specify a
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# different font using DOT_FONTNAME you can set the path where dot
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# can find it using this tag.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaDOT_FONTPATH =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# will generate a graph for each documented class showing the direct and
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# indirect inheritance relations. Setting this tag to YES will force the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the CLASS_DIAGRAMS tag to NO.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaCLASS_GRAPH = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# will generate a graph for each documented class showing the direct and
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# indirect implementation dependencies (inheritance, containment, and
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# class references variables) of the class with other documented classes.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaCOLLABORATION_GRAPH = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# will generate a graph for groups, showing the direct groups dependencies
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaGROUP_GRAPHS = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# collaboration diagrams in a style similar to the OMG's Unified Modeling
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If set to YES, the inheritance and collaboration graphs will show the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# relations between templates and their instances.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaTEMPLATE_RELATIONS = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# tags are set to YES then doxygen will generate a graph for each documented
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# file showing the direct and indirect include dependencies of the file with
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# other documented files.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaINCLUDE_GRAPH = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# documented header file showing the documented files that directly or
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# indirectly include this file.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaINCLUDED_BY_GRAPH = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the CALL_GRAPH and HAVE_DOT options are set to YES then
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# doxygen will generate a call dependency graph for every global function
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# or class method. Note that enabling this option will significantly increase
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the time of a run. So in most cases it will be better to enable call graphs
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# for selected functions only using the \callgraph command.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaCALL_GRAPH = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# doxygen will generate a caller dependency graph for every global function
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# or class method. Note that enabling this option will significantly increase
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the time of a run. So in most cases it will be better to enable caller
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# graphs for selected functions only using the \callergraph command.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaCALLER_GRAPH = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# will graphical hierarchy of all classes instead of a textual one.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaGRAPHICAL_HIERARCHY = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# then doxygen will show the dependencies a directory has on other directories
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# in a graphical way. The dependency relations are determined by the #include
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# relations between the files in the directories.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaDIRECTORY_GRAPH = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# generated by dot. Possible values are png, jpg, or gif
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If left blank png will be used.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaDOT_IMAGE_FORMAT = png
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The tag DOT_PATH can be used to specify the path where the dot tool can be
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# found. If left blank, it is assumed the dot tool can be found in the path.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The DOTFILE_DIRS tag can be used to specify one or more directories that
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# contain dot files that are included in the documentation (see the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# \dotfile command).
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaDOTFILE_DIRS =
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# nodes that will be shown in the graph. If the number of nodes in a graph
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# becomes larger than this value, doxygen will truncate the graph, which is
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# visualized by representing a node as a red box. Note that doxygen if the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# number of direct children of the root node in a graph is already larger than
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaDOT_GRAPH_MAX_NODES = 50
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# graphs generated by dot. A depth value of 3 means that only nodes reachable
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# from the root by following a path via at most 3 edges will be shown. Nodes
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# that lay further from the root node will be omitted. Note that setting this
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# option to 1 or 2 may greatly reduce the computation time needed for large
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# code bases. Also note that the size of a graph can be further restricted by
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaMAX_DOT_GRAPH_DEPTH = 0
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# background. This is disabled by default, because dot on Windows does not
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# seem to support this out of the box. Warning: Depending on the platform used,
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# enabling this option may lead to badly anti-aliased labels on the edges of
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# a graph (i.e. they become hard to read).
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaDOT_TRANSPARENT = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# files in one run (i.e. multiple -o and -T options on the command line). This
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# makes dot run faster, but since only newer versions of dot (>1.8.10)
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# support this, this feature is disabled by default.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaDOT_MULTI_TARGETS = NO
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# generate a legend page explaining the meaning of the various boxes and
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# arrows in the dot generated graphs.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaGENERATE_LEGEND = YES
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# remove the intermediate dot files that are used to generate
a7e27c11866a48742bb70564b88e15bf15e9367dPavel Březina# the various graphs.
a7e27c11866a48742bb70564b88e15bf15e9367dPavel BřezinaDOT_CLEANUP = YES