f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Doxyfile 1.8.3
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# This file describes the settings to be used by the documentation system
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# doxygen (www.doxygen.org) for a project.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# All text after a hash (#) is considered a comment and will be ignored.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The format is:
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# TAG = value [value, ...]
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# For lists items can also be appended using:
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# TAG += value [value, ...]
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Values that contain spaces should be placed between quotes (" ").
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Project related configuration options
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# This tag specifies the encoding used for all characters in the config file
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# that follow. The default is UTF-8 which is also the encoding used for all
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# text before the first occurrence of this tag. Doxygen uses libiconv (or the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# iconv built into libc) for the transcoding. See
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# http://www.gnu.org/software/libiconv for the list of possible encodings.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseDOXYFILE_ENCODING = UTF-8
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The PROJECT_NAME tag is a single word (or sequence of words) that should
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# identify the project. Note that if you do not use Doxywizard you need
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# to put quotes around the project name if it contains spaces.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BosePROJECT_NAME = sss_idmap
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The PROJECT_NUMBER tag can be used to enter a project or revision number.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# This could be handy for archiving the generated documentation or
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# if some version control system is used.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BosePROJECT_NUMBER = @PACKAGE_VERSION@
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Using the PROJECT_BRIEF tag one can provide an optional one line description
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# for a project that appears at the top of each page and should give viewer
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# a quick idea about the purpose of the project. Keep the description short.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfPROJECT_BRIEF =
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# With the PROJECT_LOGO tag one can specify an logo or icon that is
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# included in the documentation. The maximum height of the logo should not
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# exceed 55 pixels and the maximum width should not exceed 200 pixels.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Doxygen will copy the logo to the output directory.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfPROJECT_LOGO =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# base path where the generated documentation will be put.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If a relative path is entered, it will be relative to the location
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# where doxygen was started. If left blank the current directory will be used.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseOUTPUT_DIRECTORY = idmap_doc
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# 4096 sub-directories (in 2 levels) under the output directory of each output
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# format and will distribute the generated files over these directories.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Enabling this option can be useful when feeding doxygen a huge amount of
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# source files, where putting all generated files in the same directory would
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# otherwise cause performance problems for the file system.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseCREATE_SUBDIRS = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The OUTPUT_LANGUAGE tag is used to specify the language in which all
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# documentation generated by doxygen is written. Doxygen will use this
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# information to generate all constant output in the proper language.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The default language is English, other supported languages are:
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseOUTPUT_LANGUAGE = English
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# include brief member descriptions after the members that are listed in
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the file and class documentation (similar to JavaDoc).
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Set to NO to disable this.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseBRIEF_MEMBER_DESC = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the brief description of a member or function before the detailed description.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# brief descriptions will be completely suppressed.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseREPEAT_BRIEF = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# This tag implements a quasi-intelligent brief description abbreviator
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# that is used to form the text in various listings. Each string
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# in this list, if found as the leading text of the brief description, will be
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# stripped from the text and the result after processing the whole list, is
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# used as the annotated text. Otherwise, the brief description is used as-is.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If left blank, the following values are used ("$name" is automatically
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# replaced with the name of the entity): "The $name class" "The $name widget"
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# "The $name file" "is" "provides" "specifies" "contains"
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# "represents" "a" "an" "the"
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseABBREVIATE_BRIEF = "The $name class" \
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose "The $name widget" \
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose "The $name file" \
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose represents \
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Doxygen will generate a detailed section even if there is only a brief
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# description.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseALWAYS_DETAILED_SEC = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# inherited members of a class in the documentation of that class as if those
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# members were ordinary class members. Constructors, destructors and assignment
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# operators of the base classes will not be shown.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseINLINE_INHERITED_MEMB = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# path before files name in the file list and in the header files. If set
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# to NO the shortest path that makes the file name unique will be used.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseFULL_PATH_NAMES = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# can be used to strip a user-defined part of the path. Stripping is
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# only done if one of the specified strings matches the left-hand part of
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the path. The tag can be used to show relative paths in the file list.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If left blank the directory from which doxygen is run is used as the
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# path to strip. Note that you specify absolute paths here, but also
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# relative paths, which will be relative from the directory where doxygen is
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseSTRIP_FROM_PATH =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the path mentioned in the documentation of a class, which tells
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the reader which header file to include in order to use a class.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If left blank only the name of the header file containing the class
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# definition is used. Otherwise one should specify the include paths that
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# are normally passed to the compiler using the -I flag.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseSTRIP_FROM_INC_PATH =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# (but less readable) file names. This can be useful if your file system
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# doesn't support long names like on DOS, Mac, or CD-ROM.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseSHORT_NAMES = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# will interpret the first line (until the first dot) of a JavaDoc-style
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# comment as the brief description. If set to NO, the JavaDoc
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# comments will behave just like regular Qt-style comments
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# (thus requiring an explicit @brief command for a brief description.)
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseJAVADOC_AUTOBRIEF = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# interpret the first line (until the first dot) of a Qt-style
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# comment as the brief description. If set to NO, the comments
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# will behave just like regular Qt-style comments (thus requiring
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# an explicit \brief command for a brief description.)
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseQT_AUTOBRIEF = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# treat a multi-line C++ special comment block (i.e. a block of //! or ///
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# comments) as a brief description. This used to be the default behaviour.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The new default is to treat a multi-line C++ comment block as a detailed
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# description. Set this tag to YES if you prefer the old behaviour instead.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseMULTILINE_CPP_IS_BRIEF = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# member inherits the documentation from any documented member that it
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# re-implements.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseINHERIT_DOCS = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# a new page for each member. If set to NO, the documentation of a member will
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# be part of the file/class/namespace that contains it.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseSEPARATE_MEMBER_PAGES = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The TAB_SIZE tag can be used to set the number of spaces in a tab.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Doxygen uses this value to replace tabs by spaces in code fragments.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# This tag can be used to specify a number of aliases that acts
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# as commands in the documentation. An alias has the form "name=value".
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# For example adding "sideeffect=\par Side Effects:\n" will allow you to
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# put the command \sideeffect (or @sideeffect) in the documentation, which
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# will result in a user-defined paragraph with heading "Side Effects:".
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# You can put \n's in the value part of an alias to insert newlines.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# This tag can be used to specify a number of word-keyword mappings (TCL only).
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# A mapping has the form "name=value". For example adding
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# "class=itcl::class" will allow you to use the command class in the
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# itcl::class meaning.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# sources only. Doxygen will then generate output that is more tailored for C.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# For instance, some of the names that are used will be different. The list
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# of all members will be omitted, etc.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseOPTIMIZE_OUTPUT_FOR_C = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# sources only. Doxygen will then generate output that is more tailored for
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Java. For instance, namespaces will be presented as packages, qualified
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# scopes will look different, etc.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseOPTIMIZE_OUTPUT_JAVA = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# sources only. Doxygen will then generate output that is more tailored for
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseOPTIMIZE_FOR_FORTRAN = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# sources. Doxygen will then generate output that is tailored for
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseOPTIMIZE_OUTPUT_VHDL = NO
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Doxygen selects the parser to use depending on the extension of the files it
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# parses. With this tag you can assign which parser to use for a given
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# extension. Doxygen has a built-in mapping, but you can override or extend it
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# using this tag. The format is ext=language, where ext is a file extension,
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# and language is one of the parsers supported by doxygen: IDL, Java,
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# C++. For instance to make doxygen treat .inc files as Fortran files (default
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# that for custom extensions you also need to set FILE_PATTERNS otherwise the
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# files are not read by doxygen.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseEXTENSION_MAPPING =
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# comments according to the Markdown format, which allows for more readable
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# documentation. See http://daringfireball.net/projects/markdown/ for details.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The output of markdown processing is further processed by doxygen, so you
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# can mix doxygen, HTML, and XML commands with Markdown formatting.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Disable only in case of backward compatibilities issues.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfMARKDOWN_SUPPORT = YES
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# When enabled doxygen tries to link words that correspond to documented classes,
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# or namespaces to their corresponding documentation. Such a link can be
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# prevented in individual cases by by putting a % sign in front of the word or
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# globally by setting AUTOLINK_SUPPORT to NO.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfAUTOLINK_SUPPORT = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# to include (a tag file for) the STL sources as input, then you should
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# set this tag to YES in order to let doxygen match functions declarations and
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# func(std::string) {}). This also makes the inheritance and collaboration
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# diagrams that involve STL classes more complete and accurate.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseBUILTIN_STL_SUPPORT = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If you use Microsoft's C++/CLI language, you should set this option to YES to
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# enable parsing support.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseCPP_CLI_SUPPORT = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Doxygen will parse them like normal C++ but will assume all classes use public
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# instead of private inheritance when no explicit protection keyword is present.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseSIP_SUPPORT = NO
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# For Microsoft's IDL there are propget and propput attributes to indicate
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# getter and setter methods for a property. Setting this option to YES (the
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# default) will make doxygen replace the get and set methods by a property in
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# the documentation. This will only work if the methods are indeed getting or
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# setting a simple type. If this is not the case, or you want to show the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# methods anyway, you should set this option to NO.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseIDL_PROPERTY_SUPPORT = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# tag is set to YES, then doxygen will reuse the documentation of the first
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# member in the group (if any) for the other members of the group. By default
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# all members of a group must be documented explicitly.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseDISTRIBUTE_GROUP_DOC = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the same type (for instance a group of public functions) to be put as a
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# subgroup of that type (e.g. under the Public Functions section). Set it to
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# NO to prevent subgrouping. Alternatively, this can be done per class using
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the \nosubgrouping command.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseSUBGROUPING = YES
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# unions are shown inside the group in which they are included (e.g. using
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# @ingroup) instead of on a separate page (for HTML and Man pages) or
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# section (for LaTeX and RTF).
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfINLINE_GROUPED_CLASSES = NO
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# unions with only public data fields will be shown inline in the documentation
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# of the scope in which they are defined (i.e. file, namespace, or group
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# documentation), provided this scope is documented. If set to NO (the default),
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# structs, classes, and unions are shown on a separate page (for HTML and Man
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# pages) or section (for LaTeX and RTF).
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfINLINE_SIMPLE_STRUCTS = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# is documented as struct, union, or enum with the name of the typedef. So
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# with name TypeT. When disabled the typedef will appear as a member of a file,
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# namespace, or class. And the struct will be named TypeS. This can typically
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# be useful for C code in case the coding convention dictates that all compound
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# types are typedef'ed and only the typedef is referenced, never the tag name.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseTYPEDEF_HIDES_STRUCT = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# determine which symbols to keep in memory and which to flush to disk.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# When the cache is full, less often used symbols will be written to disk.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# For small to medium size projects (<1000 input files) the default value is
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# probably good enough. For larger projects a too small cache size can cause
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# doxygen to be busy swapping symbols to and from disk most of the time
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# causing a significant performance penalty.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the system has enough physical memory increasing the cache will improve the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# performance by keeping more symbols in memory. Note that the value works on
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# a logarithmic scale so increasing the size by one will roughly double the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# memory usage. The cache size is given by this formula:
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# corresponding to a cache size of 2^16 = 65536 symbols.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseSYMBOL_CACHE_SIZE = 0
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# their name and scope. Since this can be an expensive process and often the
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# same symbol appear multiple times in the code, doxygen keeps a cache of
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# pre-resolved symbols. If the cache is too small doxygen will become slower.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# If the cache is too large, memory is wasted. The cache size is given by this
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# corresponding to a cache size of 2^16 = 65536 symbols.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfLOOKUP_CACHE_SIZE = 0
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Build related configuration options
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# documentation are documented, even if no documentation was available.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Private class members and static file members will be hidden unless
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseEXTRACT_ALL = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# will be included in the documentation.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseEXTRACT_PRIVATE = NO
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# scope will be included in the documentation.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfEXTRACT_PACKAGE = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the EXTRACT_STATIC tag is set to YES all static members of a file
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# will be included in the documentation.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseEXTRACT_STATIC = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# defined locally in source files will be included in the documentation.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If set to NO only classes defined in header files are included.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseEXTRACT_LOCAL_CLASSES = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# This flag is only useful for Objective-C code. When set to YES local
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# methods, which are defined in the implementation section but not in
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the interface are included in the documentation.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If set to NO (the default) only methods in the interface are included.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseEXTRACT_LOCAL_METHODS = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If this flag is set to YES, the members of anonymous namespaces will be
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# extracted and appear in the documentation as a namespace called
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# 'anonymous_namespace{file}', where file will be replaced with the base
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# name of the file that contains the anonymous namespace. By default
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# anonymous namespaces are hidden.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseEXTRACT_ANON_NSPACES = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# undocumented members of documented classes, files or namespaces.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If set to NO (the default) these members will be included in the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# various overviews, but no documentation section is generated.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# This option has no effect if EXTRACT_ALL is enabled.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseHIDE_UNDOC_MEMBERS = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# undocumented classes that are normally visible in the class hierarchy.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If set to NO (the default) these classes will be included in the various
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# overviews. This option has no effect if EXTRACT_ALL is enabled.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseHIDE_UNDOC_CLASSES = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# friend (class|struct|union) declarations.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If set to NO (the default) these declarations will be included in the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# documentation.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseHIDE_FRIEND_COMPOUNDS = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# documentation blocks found inside the body of a function.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If set to NO (the default) these blocks will be appended to the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# function's detailed documentation block.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseHIDE_IN_BODY_DOCS = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The INTERNAL_DOCS tag determines if documentation
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# that is typed after a \internal command is included. If the tag is set
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# to NO (the default) then the documentation will be excluded.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Set it to YES to include the internal documentation.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseINTERNAL_DOCS = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# file names in lower-case letters. If set to YES upper-case letters are also
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# allowed. This is useful if you have classes or files whose names only differ
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# in case and if your file system supports case sensitive file names. Windows
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# and Mac users are advised to set this option to NO.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseCASE_SENSE_NAMES = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# will show members with their full class and namespace scopes in the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# documentation. If set to YES the scope will be hidden.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseHIDE_SCOPE_NAMES = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# will put a list of the files that are included by a file in the documentation
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# of that file.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseSHOW_INCLUDE_FILES = YES
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# will list include files with double quotes in the documentation
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# rather than with sharp brackets.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfFORCE_LOCAL_INCLUDES = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# is inserted in the documentation for inline members.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseINLINE_INFO = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# will sort the (detailed) documentation of file and class members
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# alphabetically by member name. If set to NO the members will appear in
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# declaration order.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseSORT_MEMBER_DOCS = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# brief documentation of file, namespace and class members alphabetically
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# by member name. If set to NO (the default) the members will appear in
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# declaration order.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseSORT_BRIEF_DOCS = NO
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# will sort the (brief and detailed) documentation of class members so that
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# constructors and destructors are listed first. If set to NO (the default)
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# the constructors will appear in the respective orders defined by
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseSORT_MEMBERS_CTORS_1ST = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# hierarchy of group names into alphabetical order. If set to NO (the default)
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the group names will appear in their defined order.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseSORT_GROUP_NAMES = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# sorted by fully-qualified names, including namespaces. If set to
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# NO (the default), the class list will be sorted only by class name,
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# not including the namespace part.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Note: This option applies only to the class list, not to the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# alphabetical list.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseSORT_BY_SCOPE_NAME = NO
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# do proper type resolution of all parameters of a function it will reject a
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# match between the prototype and the implementation of a member function even
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# if there is only one candidate or it is obvious which candidate to choose
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# will still accept a match between prototype and implementation in such cases.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfSTRICT_PROTO_MATCHING = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The GENERATE_TODOLIST tag can be used to enable (YES) or
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# disable (NO) the todo list. This list is created by putting \todo
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# commands in the documentation.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseGENERATE_TODOLIST = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The GENERATE_TESTLIST tag can be used to enable (YES) or
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# disable (NO) the test list. This list is created by putting \test
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# commands in the documentation.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseGENERATE_TESTLIST = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The GENERATE_BUGLIST tag can be used to enable (YES) or
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# disable (NO) the bug list. This list is created by putting \bug
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# commands in the documentation.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseGENERATE_BUGLIST = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# disable (NO) the deprecated list. This list is created by putting
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# \deprecated commands in the documentation.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseGENERATE_DEPRECATEDLIST= YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The ENABLED_SECTIONS tag can be used to enable conditional
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# documentation sections, marked by \if section-label ... \endif
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# and \cond section-label ... \endcond blocks.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseENABLED_SECTIONS =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# the initial value of a variable or macro consists of for it to appear in
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the documentation. If the initializer consists of more lines than specified
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# here it will be hidden. Use a value of 0 to hide initializers completely.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The appearance of the initializer of individual variables and macros in the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# documentation can be controlled using \showinitializer or \hideinitializer
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# command in the documentation regardless of this setting.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseMAX_INITIALIZER_LINES = 30
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# at the bottom of the documentation of classes and structs. If set to YES the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# list will mention the files that were used to generate the documentation.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseSHOW_USED_FILES = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# This will remove the Files entry from the Quick Index and from the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Folder Tree View (if specified). The default is YES.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseSHOW_FILES = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Namespaces page.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# This will remove the Namespaces entry from the Quick Index
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# and from the Folder Tree View (if specified). The default is YES.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseSHOW_NAMESPACES = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The FILE_VERSION_FILTER tag can be used to specify a program or script that
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# doxygen should invoke to get the current version for each file (typically from
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the version control system). Doxygen will invoke the program by executing (via
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# popen()) the command <command> <input-file>, where <command> is the value of
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# provided by doxygen. Whatever the program writes to standard output
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# is used as the file version. See the manual for examples.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseFILE_VERSION_FILTER =
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# by doxygen. The layout file controls the global structure of the generated
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# output files in an output format independent way. To create the layout file
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# that represents doxygen's defaults, run doxygen with the -l option.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# You can optionally specify a file name after the option, if omitted
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# DoxygenLayout.xml will be used as the name of the layout file.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseLAYOUT_FILE =
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The CITE_BIB_FILES tag can be used to specify one or more bib files
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# containing the references data. This must be a list of .bib files. The
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# .bib extension is automatically appended if omitted. Using this command
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# requires the bibtex tool to be installed. See also
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# feature you need bibtex and perl available in the search path. Do not use
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# file names with spaces, bibtex cannot handle them.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfCITE_BIB_FILES =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# configuration options related to warning and progress messages
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The QUIET tag can be used to turn on/off the messages that are generated
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# by doxygen. Possible values are YES and NO. If left blank NO is used.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The WARNINGS tag can be used to turn on/off the warning messages that are
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# generated by doxygen. Possible values are YES and NO. If left blank
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# NO is used.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseWARNINGS = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# automatically be disabled.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseWARN_IF_UNDOCUMENTED = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# potential errors in the documentation, such as not documenting some
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# parameters in a documented function, or documenting parameters that
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# don't exist or using markup commands wrongly.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseWARN_IF_DOC_ERROR = YES
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The WARN_NO_PARAMDOC option can be enabled to get warnings for
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# functions that are documented, but have no documentation for their parameters
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# or return value. If set to NO (the default) doxygen will only warn about
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# wrong or incomplete parameter documentation, but not about the absence of
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# documentation.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseWARN_NO_PARAMDOC = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The WARN_FORMAT tag determines the format of the warning messages that
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# doxygen can produce. The string should contain the $file, $line, and $text
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# tags, which will be replaced by the file and line number from which the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# warning originated and the warning text. Optionally the format may contain
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# $version, which will be replaced by the version of the file (if it could
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# be obtained via FILE_VERSION_FILTER)
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseWARN_FORMAT = "$file:$line: $text"
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The WARN_LOGFILE tag can be used to specify a file to which warning
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# and error messages should be written. If left blank the output is written
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseWARN_LOGFILE =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# configuration options related to the input files
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The INPUT tag can be used to specify the files and/or directories that contain
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# documented source files. You may enter file names like "myfile.cpp" or
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# directories like "/usr/src/myproject". Separate the files or directories
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# with spaces.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseINPUT = @abs_top_srcdir@/src/lib/idmap/sss_idmap.h
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# This tag can be used to specify the character encoding of the source files
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# also the default input encoding. Doxygen uses libiconv (or the iconv built
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the list of possible encodings.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseINPUT_ENCODING = UTF-8
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the value of the INPUT tag contains directories, you can use the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# and *.h) to filter out the source-files in the directories. If left
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# blank the following patterns are tested:
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# *.f90 *.f *.for *.vhd *.vhdl
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseFILE_PATTERNS = *.cpp \
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The RECURSIVE tag can be used to turn specify whether or not subdirectories
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# should be searched for input files as well. Possible values are YES and NO.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If left blank NO is used.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseRECURSIVE = NO
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The EXCLUDE tag can be used to specify files and/or directories that should be
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# excluded from the INPUT source files. This way you can easily exclude a
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# subdirectory from a directory tree whose root is specified with the INPUT tag.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Note that relative paths are relative to the directory from which doxygen is
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
a02a5ed51178b2cbede0396d66aed716b8898096René Genz# directories that are symbolic links (a UNIX file system feature) are excluded
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# from the input.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseEXCLUDE_SYMLINKS = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the value of the INPUT tag contains directories, you can use the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# certain files from those directories. Note that the wildcards are matched
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# against the file with absolute path, so to exclude all test directories
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# for example use the pattern */test/*
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseEXCLUDE_PATTERNS = */.git/* \
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# (namespaces, classes, functions, etc.) that should be excluded from the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# output. The symbol name can be a fully qualified name, a word, or if the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# wildcard * is used, a substring. Examples: ANamespace, AClass,
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# AClass::ANamespace, ANamespace::*Test
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseEXCLUDE_SYMBOLS =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The EXAMPLE_PATH tag can be used to specify one or more files or
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# directories that contain example code fragments that are included (see
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the \include command).
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseEXAMPLE_PATH =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the value of the EXAMPLE_PATH tag contains directories, you can use the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# and *.h) to filter out the source-files in the directories. If left
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# blank all files are included.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseEXAMPLE_PATTERNS =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# searched for input files to be used with the \include or \dontinclude
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# commands irrespective of the value of the RECURSIVE tag.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Possible values are YES and NO. If left blank NO is used.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseEXAMPLE_RECURSIVE = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The IMAGE_PATH tag can be used to specify one or more files or
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# directories that contain image that are included in the documentation (see
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the \image command).
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The INPUT_FILTER tag can be used to specify a program that doxygen should
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# invoke to filter for each input file. Doxygen will invoke the filter program
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# by executing (via popen()) the command <filter> <input-file>, where <filter>
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# input file. Doxygen will then use the output that the filter program writes
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# to standard output.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If FILTER_PATTERNS is specified, this tag will be
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseINPUT_FILTER =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Doxygen will compare the file name with each pattern and apply the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# filter if there is a match.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The filters are a list of the form:
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# info on how filters are used. If FILTER_PATTERNS is empty or if
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# non of the patterns match the file name, INPUT_FILTER is applied.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseFILTER_PATTERNS =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# INPUT_FILTER) will be used to filter the input files when producing source
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# files to browse (i.e. when SOURCE_BROWSER is set to YES).
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseFILTER_SOURCE_FILES = NO
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# and it is also possible to disable source filtering for a specific pattern
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# using *.ext= (so without naming a filter). This option only has effect when
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# FILTER_SOURCE_FILES is enabled.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfFILTER_SOURCE_PATTERNS =
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# is part of the input, its contents will be placed on the main page (index.html).
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# This can be useful if you have a project on for instance GitHub and want reuse
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# the introduction page also for the doxygen output.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfUSE_MDFILE_AS_MAINPAGE =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# configuration options related to source browsing
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the SOURCE_BROWSER tag is set to YES then a list of source files will
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# be generated. Documented entities will be cross-referenced with these sources.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Note: To get rid of all source code in the generated output, make sure also
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# VERBATIM_HEADERS is set to NO.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseSOURCE_BROWSER = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Setting the INLINE_SOURCES tag to YES will include the body
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# of functions and classes directly in the documentation.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseINLINE_SOURCES = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# doxygen to hide any special comment blocks from generated source code
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# fragments. Normal C, C++ and Fortran comments will always remain visible.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseSTRIP_CODE_COMMENTS = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the REFERENCED_BY_RELATION tag is set to YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# then for each documented function all documented
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# functions referencing it will be listed.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseREFERENCED_BY_RELATION = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the REFERENCES_RELATION tag is set to YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# then for each documented function all documented entities
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# called/used by that function will be listed.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseREFERENCES_RELATION = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# link to the source code.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Otherwise they will link to the documentation.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseREFERENCES_LINK_SOURCE = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the USE_HTAGS tag is set to YES then the references to source code
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# will point to the HTML generated by the htags(1) tool instead of doxygen
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# built-in source browser. The htags tool is part of GNU's global source
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# tagging system (see http://www.gnu.org/software/global/global.html). You
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# will need version 4.8.6 or higher.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseUSE_HTAGS = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# will generate a verbatim copy of the header file for each class for
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# which an include is specified. Set to NO to disable this.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseVERBATIM_HEADERS = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# configuration options related to the alphabetical class index
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# of all compounds will be generated. Enable this if the project
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# contains a lot of classes, structs, unions or interfaces.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseALPHABETICAL_INDEX = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# in which this list will be split (can be a number in the range [1..20])
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseCOLS_IN_ALPHA_INDEX = 5
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# In case all classes in a project start with a common prefix, all
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# classes will be put under the same header in the alphabetical index.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# should be ignored while generating the index headers.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseIGNORE_PREFIX =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# configuration options related to the HTML output
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# generate HTML output.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseGENERATE_HTML = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If a relative path is entered the value of OUTPUT_DIRECTORY will be
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# put in front of it. If left blank `html' will be used as the default path.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseHTML_OUTPUT = html
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# doxygen will generate files with .html extension.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseHTML_FILE_EXTENSION = .html
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The HTML_HEADER tag can be used to specify a personal HTML header for
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# each generated HTML page. If it is left blank doxygen will generate a
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# standard header. Note that when using a custom header you are responsible
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# for the proper inclusion of any scripts and style sheets that doxygen
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# needs, which is dependent on the configuration options used.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# It is advised to generate a default header using "doxygen -w html
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# header.html footer.html stylesheet.css YourConfigFile" and then modify
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# that header. Note that the header is subject to change so you typically
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# have to redo this when upgrading to a newer version of doxygen or when
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# changing the value of configuration settings such as GENERATE_TREEVIEW!
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseHTML_HEADER =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The HTML_FOOTER tag can be used to specify a personal HTML footer for
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# each generated HTML page. If it is left blank doxygen will generate a
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# standard footer.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseHTML_FOOTER =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# style sheet that is used by each HTML page. It can be used to
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# fine-tune the look of the HTML output. If left blank doxygen will
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# generate a default style sheet. Note that it is recommended to use
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# tag will in the future become obsolete.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseHTML_STYLESHEET =
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# user-defined cascading style sheet that is included after the standard
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# style sheets created by doxygen. Using this option one can overrule
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# certain style aspects. This is preferred over using HTML_STYLESHEET
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# since it does not replace the standard style sheet and is therefor more
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# robust against future updates. Doxygen will copy the style sheet file to
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# the output directory.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfHTML_EXTRA_STYLESHEET =
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# other source files which should be copied to the HTML output directory. Note
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# that these files will be copied to the base HTML output directory. Use the
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# files. In the HTML_STYLESHEET file, use the file name only. Also note that
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# the files will be copied as-is; there are no commands or markers available.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfHTML_EXTRA_FILES =
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Doxygen will adjust the colors in the style sheet and background images
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# according to this color. Hue is specified as an angle on a colorwheel,
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# see http://en.wikipedia.org/wiki/Hue for more information.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# For instance the value 0 represents red, 60 is yellow, 120 is green,
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The allowed range is 0 to 359.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfHTML_COLORSTYLE_HUE = 220
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# the colors in the HTML output. For a value of 0 the output will use
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# grayscales only. A value of 255 will produce the most vivid colors.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfHTML_COLORSTYLE_SAT = 100
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# the luminance component of the colors in the HTML output. Values below
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# 100 gradually make the output lighter, whereas values above 100 make
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# the output darker. The value divided by 100 is the actual gamma applied,
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# and 100 does not change the gamma.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfHTML_COLORSTYLE_GAMMA = 80
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# page will contain the date and time when the page was generated. Setting
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# this to NO can help when comparing the output of multiple runs.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfHTML_TIMESTAMP = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# documentation will contain sections that can be hidden and shown after the
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# page has loaded.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseHTML_DYNAMIC_SECTIONS = NO
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# entries shown in the various tree structured indices initially; the user
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# can expand and collapse entries dynamically later on. Doxygen will expand
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# the tree to such a level that at most the specified number of entries are
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# visible (unless a fully collapsed tree already exceeds this amount).
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# So setting the number of entries 1 will produce a full collapsed tree by
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# default. 0 is a special value representing an infinite number of entries
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# and will result in a full expanded tree by default.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfHTML_INDEX_NUM_ENTRIES = 100
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the GENERATE_DOCSET tag is set to YES, additional index files
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# will be generated that can be used as input for Apple's Xcode 3
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# integrated development environment, introduced with OSX 10.5 (Leopard).
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# To create a documentation set, doxygen will generate a Makefile in the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# HTML output directory. Running make will produce the docset in that
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# directory and running "make install" will install the docset in
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# it at startup.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# for more information.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseGENERATE_DOCSET = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# feed. A documentation feed provides an umbrella under which multiple
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# documentation sets from a single provider (such as a company or product suite)
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# can be grouped.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseDOCSET_FEEDNAME = "Doxygen generated docs"
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# should uniquely identify the documentation set bundle. This should be a
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# will append .docset to the name.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseDOCSET_BUNDLE_ID = org.doxygen.Project
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# identify the documentation publisher. This should be a reverse domain-name
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# style string, e.g. com.mycompany.MyDocSet.documentation.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfDOCSET_PUBLISHER_ID = org.doxygen.Publisher
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfDOCSET_PUBLISHER_NAME = Publisher
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the GENERATE_HTMLHELP tag is set to YES, additional index files
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# will be generated that can be used as input for tools like the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# of the generated HTML documentation.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseGENERATE_HTMLHELP = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# be used to specify the file name of the resulting .chm file. You
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# can add a path in front of the file if the result should not be
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# written to the html output directory.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# be used to specify the location (absolute path including file name) of
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the HTML help compiler on the generated index.hhp.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseHHC_LOCATION =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# controls if a separate .chi index file is generated (YES) or that
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# it should be included in the master .chm file (NO).
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseGENERATE_CHI = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# is used to encode HtmlHelp index (hhk), content (hhc) and project file
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseCHM_INDEX_ENCODING =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# controls whether a binary table of contents is generated (YES) or a
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# normal table of contents (NO) in the .chm file.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseBINARY_TOC = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The TOC_EXPAND flag can be set to YES to add extra items for group members
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# to the contents of the HTML help documentation and to the tree view.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseTOC_EXPAND = NO
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# that can be used as input for Qt's qhelpgenerator to generate a
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Qt Compressed Help (.qch) of the generated HTML documentation.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseGENERATE_QHP = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# be used to specify the file name of the resulting .qch file.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The path specified is relative to the HTML output folder.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The QHP_NAMESPACE tag specifies the namespace to use when generating
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Qt Help Project output. For more information please see
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# http://doc.trolltech.com/qthelpproject.html#namespace
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseQHP_NAMESPACE =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Qt Help Project output. For more information please see
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# http://doc.trolltech.com/qthelpproject.html#virtual-folders
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseQHP_VIRTUAL_FOLDER = doc
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# add. For more information please see
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# http://doc.trolltech.com/qthelpproject.html#custom-filters
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseQHP_CUST_FILTER_NAME =
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# custom filter to add. For more information please see
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Qt Help Project / Custom Filters</a>.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseQHP_CUST_FILTER_ATTRS =
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# filter section matches.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Qt Help Project / Filter Attributes</a>.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseQHP_SECT_FILTER_ATTRS =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# be used to specify the location of Qt's qhelpgenerator.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If non-empty doxygen will try to run qhelpgenerator on the generated
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseQHG_LOCATION =
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# will be generated, which together with the HTML files, form an Eclipse help
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# plugin. To install this plugin and make it available under the help contents
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# menu in Eclipse, the contents of the directory containing the HTML and XML
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# files needs to be copied into the plugins directory of eclipse. The name of
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# the directory within the plugins directory should be the same as
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# the help appears.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfGENERATE_ECLIPSEHELP = NO
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# A unique identifier for the eclipse help plugin. When installing the plugin
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# the directory name containing the HTML and XML files should also have
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# at top of each HTML page. The value NO (the default) enables the index and
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# the value YES disables it. Since the tabs have the same information as the
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# navigation tree you can set this option to NO if you already set
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# GENERATE_TREEVIEW to YES.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfDISABLE_INDEX = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# structure should be generated to display hierarchical information.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the tag value is set to YES, a side panel will be generated
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# containing a tree-like index structure (just like the one that
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# is generated for HTML Help). For this to work a browser that supports
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Windows users are probably better off using the HTML help feature.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Since the tree basically has the same information as the tab index you
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# could consider to set DISABLE_INDEX to NO when enabling this option.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseGENERATE_TREEVIEW = NONE
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# (range [0,1..20]) that doxygen will group on one line in the generated HTML
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# documentation. Note that a value of 0 will completely suppress the enum
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# values from appearing in the overview section.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfENUM_VALUES_PER_LINE = 4
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# used to set the initial width (in pixels) of the frame in which the tree
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseTREEVIEW_WIDTH = 250
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# links to external symbols imported via tag files in a separate window.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfEXT_LINKS_IN_WINDOW = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Use this tag to change the font size of Latex formulas included
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# as images in the HTML documentation. The default is 10. Note that
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# when you change the font size after a successful doxygen run you need
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# to manually remove any form_*.png images from the HTML output directory
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# to force them to be regenerated.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseFORMULA_FONTSIZE = 10
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Use the FORMULA_TRANPARENT tag to determine whether or not the images
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# generated for formulas are transparent PNGs. Transparent PNGs are
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# not supported properly for IE 6.0, but are supported on all modern browsers.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Note that when changing this option you need to delete any form_*.png files
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# in the HTML output before the changes have effect.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfFORMULA_TRANSPARENT = YES
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# (see http://www.mathjax.org) which uses client side Javascript for the
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# rendering instead of using prerendered bitmaps. Use this if you do not
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# have LaTeX installed or if you want to formulas look prettier in the HTML
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# output. When enabled you may also need to install MathJax separately and
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# configure the path to it using the MATHJAX_RELPATH option.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfUSE_MATHJAX = NO
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# When MathJax is enabled you can set the default output format to be used for
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# SVG. The default value is HTML-CSS, which is slower, but has the best
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# compatibility.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfMATHJAX_FORMAT = HTML-CSS
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# When MathJax is enabled you need to specify the location relative to the
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# HTML output directory using the MATHJAX_RELPATH option. The destination
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# directory should contain the MathJax.js script. For instance, if the mathjax
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# directory is located at the same level as the HTML output directory, then
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# MATHJAX_RELPATH should be ../mathjax. The default value points to
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# the MathJax Content Delivery Network so you can quickly see the result without
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# installing MathJax.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# However, it is strongly recommended to install a local
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# copy of MathJax from http://www.mathjax.org before deployment.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfMATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# names that should be enabled during MathJax rendering.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfMATHJAX_EXTENSIONS =
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# When the SEARCHENGINE tag is enabled doxygen will generate a search box
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# for the HTML output. The underlying search engine uses javascript
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# and DHTML and should work on any modern browser. Note that when using
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# (GENERATE_DOCSET) there is already a search function so this one should
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# typically be disabled. For large projects the javascript based search engine
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseSEARCHENGINE = NO
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# implemented using a web server instead of a web client using Javascript.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# There are two flavours of web server based search depending on the
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# searching and an index file used by the script. When EXTERNAL_SEARCH is
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# enabled the indexing and searching needs to be provided by external tools.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# See the manual for details.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfSERVER_BASED_SEARCH = NO
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# script for searching. Instead the search results are written to an XML file
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# which needs to be processed by an external indexer. Doxygen will invoke an
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# external search engine pointed to by the SEARCHENGINE_URL option to obtain
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# the search results. Doxygen ships with an example indexer (doxyindexer) and
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# search engine (doxysearch.cgi) which are based on the open source search engine
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# library Xapian. See the manual for configuration details.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfEXTERNAL_SEARCH = NO
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The SEARCHENGINE_URL should point to a search engine hosted by a web server
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# which will returned the search results when EXTERNAL_SEARCH is enabled.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Doxygen ships with an example search engine (doxysearch) which is based on
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# the open source search engine library Xapian. See the manual for configuration
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfSEARCHENGINE_URL =
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# search data is written to a file for indexing by an external tool. With the
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# SEARCHDATA_FILE tag the name of this file can be specified.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfSEARCHDATA_FILE = searchdata.xml
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through other
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# doxygen projects that are not otherwise connected via tags files, but are
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# all added to the same search index. Each project needs to have a tag file set
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# via GENERATE_TAGFILE. The search mapping then maps the name of the tag file
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# to a relative location where the documentation can be found,
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# similar to the
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# TAGFILES option but without actually processing the tag file.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The format is: EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfEXTRA_SEARCH_MAPPINGS =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# configuration options related to the LaTeX output
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# generate Latex output.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseGENERATE_LATEX = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If a relative path is entered the value of OUTPUT_DIRECTORY will be
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# put in front of it. If left blank `latex' will be used as the default path.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseLATEX_OUTPUT = latex
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# invoked. If left blank `latex' will be used as the default command name.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Note that when enabling USE_PDFLATEX this option is only used for
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# generating bitmaps for formulas in the HTML output, but not in the
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Makefile that is written to the output directory.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseLATEX_CMD_NAME = latex
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# generate index for LaTeX. If left blank `makeindex' will be used as the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# default command name.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseMAKEINDEX_CMD_NAME = makeindex
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# LaTeX documents. This may be useful for small projects and may help to
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# save some trees in general.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseCOMPACT_LATEX = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The PAPER_TYPE tag can be used to set the paper type that is used
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# by the printer. Possible values are: a4, letter, legal and
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# executive. If left blank a4wide will be used.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BosePAPER_TYPE = a4wide
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# packages that should be included in the LaTeX output.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseEXTRA_PACKAGES =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the generated latex document. The header should contain everything until
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the first chapter. If it is left blank doxygen will generate a
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# standard header. Notice: only use this tag if you know what you are doing!
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseLATEX_HEADER =
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# the generated latex document. The footer should contain everything after
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# the last chapter. If it is left blank doxygen will generate a
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# standard footer. Notice: only use this tag if you know what you are doing!
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfLATEX_FOOTER =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# is prepared for conversion to pdf (using ps2pdf). The pdf file will
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# contain links (just like the HTML output) instead of page references
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# This makes the output suitable for online browsing using a pdf viewer.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BosePDF_HYPERLINKS = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# plain latex in the generated Makefile. Set this option to YES to get a
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# higher quality PDF documentation.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseUSE_PDFLATEX = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# command to the generated LaTeX files. This will instruct LaTeX to keep
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# running if errors occur, instead of asking the user for help.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# This option is also used when generating formulas in HTML.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseLATEX_BATCHMODE = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If LATEX_HIDE_INDICES is set to YES then doxygen will not
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# include the index chapters (such as File Index, Compound Index, etc.)
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# in the output.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseLATEX_HIDE_INDICES = NO
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# If LATEX_SOURCE_CODE is set to YES then doxygen will include
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# source code with syntax highlighting in the LaTeX output.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Note that which sources are shown also depends on other settings
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# such as SOURCE_BROWSER.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseLATEX_SOURCE_CODE = NO
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# http://en.wikipedia.org/wiki/BibTeX for more info.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfLATEX_BIB_STYLE = plain
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# configuration options related to the RTF output
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The RTF output is optimized for Word 97 and may not look very pretty with
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# other RTF readers or editors.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseGENERATE_RTF = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If a relative path is entered the value of OUTPUT_DIRECTORY will be
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# put in front of it. If left blank `rtf' will be used as the default path.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseRTF_OUTPUT = rtf
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# RTF documents. This may be useful for small projects and may help to
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# save some trees in general.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseCOMPACT_RTF = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# will contain hyperlink fields. The RTF file will
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# contain links (just like the HTML output) instead of page references.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# This makes the output suitable for online browsing using WORD or other
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# programs which support those fields.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Note: wordpad (write) and others do not support links.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseRTF_HYPERLINKS = NO
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Load style sheet definitions from file. Syntax is similar to doxygen's
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# config file, i.e. a series of assignments. You only have to provide
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# replacements, missing definitions are set to their default value.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseRTF_STYLESHEET_FILE =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Set optional variables used in the generation of an rtf document.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Syntax is similar to doxygen's config file.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseRTF_EXTENSIONS_FILE =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# configuration options related to the man page output
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# generate man pages
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseGENERATE_MAN = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The MAN_OUTPUT tag is used to specify where the man pages will be put.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If a relative path is entered the value of OUTPUT_DIRECTORY will be
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# put in front of it. If left blank `man' will be used as the default path.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseMAN_OUTPUT = man
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The MAN_EXTENSION tag determines the extension that is added to
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the generated man pages (default is the subroutine's section .3)
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseMAN_EXTENSION = .3
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# then it will generate one additional man file for each entity
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# documented in the real man page(s). These additional files
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# only source the real man page, but without them the man command
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# would be unable to find the correct page. The default is NO.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseMAN_LINKS = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# configuration options related to the XML output
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the GENERATE_XML tag is set to YES Doxygen will
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# generate an XML file that captures the structure of
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the code including all documentation.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseGENERATE_XML = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The XML_OUTPUT tag is used to specify where the XML pages will be put.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If a relative path is entered the value of OUTPUT_DIRECTORY will be
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# put in front of it. If left blank `xml' will be used as the default path.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseXML_OUTPUT = xml
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The XML_SCHEMA tag can be used to specify an XML schema,
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# which can be used by a validating XML parser to check the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# syntax of the XML files.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The XML_DTD tag can be used to specify an XML DTD,
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# which can be used by a validating XML parser to check the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# syntax of the XML files.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# dump the program listings (including syntax highlighting
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# and cross-referencing information) to the XML output. Note that
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# enabling this will significantly increase the size of the XML output.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseXML_PROGRAMLISTING = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# configuration options for the AutoGen Definitions output
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# generate an AutoGen Definitions (see autogen.sf.net) file
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# that captures the structure of the code including all
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# documentation. Note that this feature is still experimental
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# and incomplete at the moment.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseGENERATE_AUTOGEN_DEF = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# configuration options related to the Perl module output
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the GENERATE_PERLMOD tag is set to YES Doxygen will
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# generate a Perl module file that captures the structure of
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the code including all documentation. Note that this
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# feature is still experimental and incomplete at the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseGENERATE_PERLMOD = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the necessary Makefile rules, Perl scripts and LaTeX code to be able
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# to generate PDF and DVI output from the Perl module output.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BosePERLMOD_LATEX = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# nicely formatted so it can be parsed by a human reader.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# This is useful
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# if you want to understand what is going on.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# On the other hand, if this
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# tag is set to NO the size of the Perl module output will be much smaller
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# and Perl will parse it just the same.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BosePERLMOD_PRETTY = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The names of the make variables in the generated doxyrules.make file
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# This is useful so different doxyrules.make files included by the same
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Makefile don't overwrite each other's variables.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BosePERLMOD_MAKEVAR_PREFIX =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Configuration options related to the preprocessor
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# evaluate all C-preprocessor directives found in the sources and include
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseENABLE_PREPROCESSING = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# names in the source code. If set to NO (the default) only conditional
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# compilation will be performed. Macro expansion can be done in a controlled
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# way by setting EXPAND_ONLY_PREDEF to YES.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseMACRO_EXPANSION = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# then the macro expansion is limited to the macros specified with the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# PREDEFINED and EXPAND_AS_DEFINED tags.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseEXPAND_ONLY_PREDEF = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# pointed to by INCLUDE_PATH will be searched when a #include is found.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseSEARCH_INCLUDES = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The INCLUDE_PATH tag can be used to specify one or more directories that
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# contain include files that are not input files but should be processed by
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the preprocessor.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseINCLUDE_PATH =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# patterns (like *.h and *.hpp) to filter out the header-files in the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# directories. If left blank, the patterns specified with FILE_PATTERNS will
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseINCLUDE_FILE_PATTERNS =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The PREDEFINED tag can be used to specify one or more macro names that
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# are defined before the preprocessor is started (similar to the -D option of
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# gcc). The argument of the tag is a list of macros of the form: name
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# or name=definition (no spaces). If the definition and the = are
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# omitted =1 is assumed. To prevent a macro definition from being
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# undefined via #undef or recursively expanded use the := operator
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# instead of the = operator.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BosePREDEFINED = DOXYGEN
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# this tag can be used to specify a list of macro names that should be expanded.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The macro definition that is found in the sources will be used.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Use the PREDEFINED tag if you want to use a different macro definition that
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# overrules the definition found in the source code.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseEXPAND_AS_DEFINED =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# doxygen's preprocessor will remove all references to function-like macros
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# that are alone on a line, have an all uppercase name, and do not end with a
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# semicolon, because these will confuse the parser if not removed.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseSKIP_FUNCTION_MACROS = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Configuration::additions related to external references
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The TAGFILES option can be used to specify one or more tagfiles. For each
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# tag file the location of the external documentation should be added. The
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# format of a tag file without this location is as follows:
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# TAGFILES = file1 file2 ...
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Adding location for the tag files is done as follows:
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# TAGFILES = file1=loc1 "file2 = loc2" ...
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# where "loc1" and "loc2" can be relative or absolute paths
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# or URLs. Note that each tag file must have a unique name (where the name does
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# NOT include the path). If a tag file is not located in the directory in which
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# doxygen is run, you must also specify the path to the tagfile here.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# When a file name is specified after GENERATE_TAGFILE, doxygen will create
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# a tag file that is based on the input files it reads.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseGENERATE_TAGFILE =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the ALLEXTERNALS tag is set to YES all external classes will be listed
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# in the class index. If set to NO only the inherited external classes
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# will be listed.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseALLEXTERNALS = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# in the modules index. If set to NO, only the current project's groups will
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseEXTERNAL_GROUPS = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The PERL_PATH should be the absolute path and name of the perl script
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# interpreter (i.e. the result of `which perl').
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Configuration options related to the dot tool
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose#---------------------------------------------------------------------------
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# or super classes. Setting the tag to NO turns the diagrams off. Note that
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# this option also works with HAVE_DOT disabled, but it is recommended to
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# install and use dot, since it yields more powerful graphs.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseCLASS_DIAGRAMS = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# You can define message sequence charts within doxygen comments using the \msc
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# command. Doxygen will then run the mscgen tool (see
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# documentation. The MSCGEN_PATH tag allows you to specify the directory where
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the mscgen tool resides. If left empty the tool is assumed to be found in the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# default search path.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseMSCGEN_PATH =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If set to YES, the inheritance and collaboration graphs will hide
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# inheritance and usage relations if the target is undocumented
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# or is not a class.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseHIDE_UNDOC_RELATIONS = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# available from the path. This tool is part of Graphviz, a graph visualization
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# toolkit from AT&T and Lucent Bell Labs. The other options in this section
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# have no effect if this option is set to NO (the default)
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseHAVE_DOT = NO
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# allowed to run in parallel. When set to 0 (the default) doxygen will
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# base this on the number of processors available in the system. You can set it
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# explicitly to a value larger than 0 to get control over the balance
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# between CPU load and processing speed.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfDOT_NUM_THREADS = 0
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# By default doxygen will use the Helvetica font for all dot files that
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# doxygen generates. When you want a differently looking font you can specify
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# the font name using DOT_FONTNAME. You need to make sure dot is able to find
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# the font, which can be done by putting it in a standard location or by setting
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# directory containing the font.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseDOT_FONTNAME = FreeSans
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The default size is 10pt.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseDOT_FONTSIZE = 10
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# By default doxygen will tell dot to use the Helvetica font.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# set the path where dot can find it.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseDOT_FONTPATH =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# will generate a graph for each documented class showing the direct and
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# indirect inheritance relations. Setting this tag to YES will force the
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# CLASS_DIAGRAMS tag to NO.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseCLASS_GRAPH = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# will generate a graph for each documented class showing the direct and
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# indirect implementation dependencies (inheritance, containment, and
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# class references variables) of the class with other documented classes.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseCOLLABORATION_GRAPH = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# will generate a graph for groups, showing the direct groups dependencies
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseGROUP_GRAPHS = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# collaboration diagrams in a style similar to the OMG's Unified Modeling
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseUML_LOOK = NO
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# If the UML_LOOK tag is enabled, the fields and methods are shown inside
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# the class node. If there are many fields or methods and many nodes the
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# threshold limits the number of items for each type to make the size more
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# managable. Set this to 0 for no limit. Note that the threshold may be
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# exceeded by 50% before the limit is enforced.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfUML_LIMIT_NUM_FIELDS = 10
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If set to YES, the inheritance and collaboration graphs will show the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# relations between templates and their instances.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseTEMPLATE_RELATIONS = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# tags are set to YES then doxygen will generate a graph for each documented
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# file showing the direct and indirect include dependencies of the file with
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# other documented files.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseINCLUDE_GRAPH = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# documented header file showing the documented files that directly or
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# indirectly include this file.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseINCLUDED_BY_GRAPH = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the CALL_GRAPH and HAVE_DOT options are set to YES then
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# doxygen will generate a call dependency graph for every global function
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# or class method. Note that enabling this option will significantly increase
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the time of a run. So in most cases it will be better to enable call graphs
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# for selected functions only using the \callgraph command.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseCALL_GRAPH = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# doxygen will generate a caller dependency graph for every global function
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# or class method. Note that enabling this option will significantly increase
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the time of a run. So in most cases it will be better to enable caller
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# graphs for selected functions only using the \callergraph command.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseCALLER_GRAPH = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# will generate a graphical hierarchy of all classes instead of a textual one.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseGRAPHICAL_HIERARCHY = YES
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# then doxygen will show the dependencies a directory has on other directories
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# in a graphical way. The dependency relations are determined by the #include
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# relations between the files in the directories.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseDIRECTORY_GRAPH = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# generated by dot. Possible values are svg, png, jpg, or gif.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# If left blank png will be used. If you choose svg you need to set
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# visible in IE 9+ (other browsers do not have this requirement).
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseDOT_IMAGE_FORMAT = png
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# enable generation of interactive SVG images that allow zooming and panning.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Note that this requires a modern browser other than Internet Explorer.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# visible. Older versions of IE do not have SVG support.
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfINTERACTIVE_SVG = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The tag DOT_PATH can be used to specify the path where the dot tool can be
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# found. If left blank, it is assumed the dot tool can be found in the path.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The DOTFILE_DIRS tag can be used to specify one or more directories that
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# contain dot files that are included in the documentation (see the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# \dotfile command).
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseDOTFILE_DIRS =
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# The MSCFILE_DIRS tag can be used to specify one or more directories that
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# contain msc files that are included in the documentation (see the
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten Scherf# \mscfile command).
f0d860c4a1048a05fd7fb9e7dd674474ad8a82f3Thorsten ScherfMSCFILE_DIRS =
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# nodes that will be shown in the graph. If the number of nodes in a graph
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# becomes larger than this value, doxygen will truncate the graph, which is
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# visualized by representing a node as a red box. Note that doxygen if the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# number of direct children of the root node in a graph is already larger than
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseDOT_GRAPH_MAX_NODES = 50
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# graphs generated by dot. A depth value of 3 means that only nodes reachable
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# from the root by following a path via at most 3 edges will be shown. Nodes
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# that lay further from the root node will be omitted. Note that setting this
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# option to 1 or 2 may greatly reduce the computation time needed for large
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# code bases. Also note that the size of a graph can be further restricted by
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseMAX_DOT_GRAPH_DEPTH = 0
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# background. This is disabled by default, because dot on Windows does not
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# seem to support this out of the box. Warning: Depending on the platform used,
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# enabling this option may lead to badly anti-aliased labels on the edges of
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# a graph (i.e. they become hard to read).
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseDOT_TRANSPARENT = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# files in one run (i.e. multiple -o and -T options on the command line). This
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# makes dot run faster, but since only newer versions of dot (>1.8.10)
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# support this, this feature is disabled by default.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseDOT_MULTI_TARGETS = NO
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# generate a legend page explaining the meaning of the various boxes and
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# arrows in the dot generated graphs.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseGENERATE_LEGEND = YES
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# remove the intermediate dot files that are used to generate
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit Bose# the various graphs.
a6098862048d4bb469130b9ff21be3020d6f2c54Sumit BoseDOT_CLEANUP = YES