Doxyfile revision 617c72e9bdbdf719e45560ec3ee540bd160f11c4
5a580c3a38ced62d4bcc95b8ac7c4f2935b5d294Timo Sirainen# Doxyfile 1.8.3.1
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# This file describes the settings to be used by the documentation system
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# doxygen (www.doxygen.org) for a project.
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# All text after a hash (#) is considered a comment and will be ignored.
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# The format is:
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# TAG = value [value, ...]
238812433b4f7965fd662dce0f4efccb092630a8Timo Sirainen# For lists items can also be appended using:
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# TAG += value [value, ...]
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainen# Values that contain spaces should be placed between quotes (" ").
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen#---------------------------------------------------------------------------
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# Project related configuration options
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen#---------------------------------------------------------------------------
8e371a3ce32bd64288786855b8ce0cb63f19f7d1Timo Sirainen# This tag specifies the encoding used for all characters in the config file
8e371a3ce32bd64288786855b8ce0cb63f19f7d1Timo Sirainen# that follow. The default is UTF-8 which is also the encoding used for all
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# text before the first occurrence of this tag. Doxygen uses libiconv (or the
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen# iconv built into libc) for the transcoding. See
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen# http://www.gnu.org/software/libiconv for the list of possible encodings.
73b50eecfc31750a312e2f940023f522eb07178cTimo SirainenDOXYFILE_ENCODING = UTF-8
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen# The PROJECT_NAME tag is a single word (or sequence of words) that should
f428ea9564d72894c18b8f3876bfaaf677ce19aaTimo Sirainen# identify the project. Note that if you do not use Doxywizard you need
02a54da28f376dd66d7939d8546a196a0045b486Timo Sirainen# to put quotes around the project name if it contains spaces.
02a54da28f376dd66d7939d8546a196a0045b486Timo SirainenPROJECT_NAME = inkscape
02a54da28f376dd66d7939d8546a196a0045b486Timo Sirainen# The PROJECT_NUMBER tag can be used to enter a project or revision number.
02a54da28f376dd66d7939d8546a196a0045b486Timo Sirainen# This could be handy for archiving the generated documentation or
02a54da28f376dd66d7939d8546a196a0045b486Timo Sirainen# if some version control system is used.
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo SirainenPROJECT_NUMBER =
2615df45a8027948a474abe5e817b34b0499c171Timo Sirainen# Using the PROJECT_BRIEF tag one can provide an optional one line description
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# for a project that appears at the top of each page and should give viewer
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# a quick idea about the purpose of the project. Keep the description short.
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo SirainenPROJECT_BRIEF = Vector Graphics Editor
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# With the PROJECT_LOGO tag one can specify an logo or icon that is
2615df45a8027948a474abe5e817b34b0499c171Timo Sirainen# included in the documentation. The maximum height of the logo should not
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# exceed 55 pixels and the maximum width should not exceed 200 pixels.
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# Doxygen will copy the logo to the output directory.
e7ca5f820d6a1a8fe549a2966ac707a60e055ef4Timo Sirainen# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# base path where the generated documentation will be put.
ff7056842f14fd3b30a2d327dfab165b9d15dd30Timo Sirainen# If a relative path is entered, it will be relative to the location
ff7056842f14fd3b30a2d327dfab165b9d15dd30Timo Sirainen# where doxygen was started. If left blank the current directory will be used.
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo SirainenOUTPUT_DIRECTORY = doxygen
11fec79522fc0cebe7321d1a9206568d22ddc1c0Timo Sirainen# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
11fec79522fc0cebe7321d1a9206568d22ddc1c0Timo Sirainen# 4096 sub-directories (in 2 levels) under the output directory of each output
11fec79522fc0cebe7321d1a9206568d22ddc1c0Timo Sirainen# format and will distribute the generated files over these directories.
04870054863757edf048c81dcce3c5e7dec453cdTimo Sirainen# Enabling this option can be useful when feeding doxygen a huge amount of
11fec79522fc0cebe7321d1a9206568d22ddc1c0Timo Sirainen# source files, where putting all generated files in the same directory would
11fec79522fc0cebe7321d1a9206568d22ddc1c0Timo Sirainen# otherwise cause performance problems for the file system.
11fec79522fc0cebe7321d1a9206568d22ddc1c0Timo SirainenCREATE_SUBDIRS = NO
04870054863757edf048c81dcce3c5e7dec453cdTimo Sirainen# The OUTPUT_LANGUAGE tag is used to specify the language in which all
04870054863757edf048c81dcce3c5e7dec453cdTimo Sirainen# documentation generated by doxygen is written. Doxygen will use this
11fec79522fc0cebe7321d1a9206568d22ddc1c0Timo Sirainen# information to generate all constant output in the proper language.
02a54da28f376dd66d7939d8546a196a0045b486Timo Sirainen# The default language is English, other supported languages are:
11fec79522fc0cebe7321d1a9206568d22ddc1c0Timo Sirainen# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
11fec79522fc0cebe7321d1a9206568d22ddc1c0Timo Sirainen# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
02a54da28f376dd66d7939d8546a196a0045b486Timo Sirainen# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
11fec79522fc0cebe7321d1a9206568d22ddc1c0Timo Sirainen# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
026be738ed56c8be10d048ef7b684ef5e05e5beaTimo Sirainen# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
11fec79522fc0cebe7321d1a9206568d22ddc1c0Timo Sirainen# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
11fec79522fc0cebe7321d1a9206568d22ddc1c0Timo SirainenOUTPUT_LANGUAGE = English
11fec79522fc0cebe7321d1a9206568d22ddc1c0Timo Sirainen# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
11fec79522fc0cebe7321d1a9206568d22ddc1c0Timo Sirainen# include brief member descriptions after the members that are listed in
11fec79522fc0cebe7321d1a9206568d22ddc1c0Timo Sirainen# the file and class documentation (similar to JavaDoc).
e03d986a74128f5ba30fcfda9f6e36578f5d8decTimo Sirainen# Set to NO to disable this.
11fec79522fc0cebe7321d1a9206568d22ddc1c0Timo SirainenBRIEF_MEMBER_DESC = YES
11fec79522fc0cebe7321d1a9206568d22ddc1c0Timo Sirainen# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
e03d986a74128f5ba30fcfda9f6e36578f5d8decTimo Sirainen# the brief description of a member or function before the detailed description.
11fec79522fc0cebe7321d1a9206568d22ddc1c0Timo Sirainen# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
11fec79522fc0cebe7321d1a9206568d22ddc1c0Timo Sirainen# brief descriptions will be completely suppressed.
36b7bef6b3106dae2586bad95c5db4dc71f8ad2fTimo SirainenREPEAT_BRIEF = YES
36b7bef6b3106dae2586bad95c5db4dc71f8ad2fTimo Sirainen# This tag implements a quasi-intelligent brief description abbreviator
36b7bef6b3106dae2586bad95c5db4dc71f8ad2fTimo Sirainen# that is used to form the text in various listings. Each string
36b7bef6b3106dae2586bad95c5db4dc71f8ad2fTimo Sirainen# in this list, if found as the leading text of the brief description, will be
36b7bef6b3106dae2586bad95c5db4dc71f8ad2fTimo Sirainen# stripped from the text and the result after processing the whole list, is
36b7bef6b3106dae2586bad95c5db4dc71f8ad2fTimo Sirainen# used as the annotated text. Otherwise, the brief description is used as-is.
36b7bef6b3106dae2586bad95c5db4dc71f8ad2fTimo Sirainen# If left blank, the following values are used ("$name" is automatically
36b7bef6b3106dae2586bad95c5db4dc71f8ad2fTimo Sirainen# replaced with the name of the entity): "The $name class" "The $name widget"
36b7bef6b3106dae2586bad95c5db4dc71f8ad2fTimo Sirainen# "The $name file" "is" "provides" "specifies" "contains"
36b7bef6b3106dae2586bad95c5db4dc71f8ad2fTimo Sirainen# "represents" "a" "an" "the"
36b7bef6b3106dae2586bad95c5db4dc71f8ad2fTimo SirainenABBREVIATE_BRIEF =
4264d75117668afed3c3602116dcf159463644e6Timo Sirainen# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
4264d75117668afed3c3602116dcf159463644e6Timo Sirainen# Doxygen will generate a detailed section even if there is only a brief
4264d75117668afed3c3602116dcf159463644e6Timo Sirainen# description.
4264d75117668afed3c3602116dcf159463644e6Timo SirainenALWAYS_DETAILED_SEC = NO
36b7bef6b3106dae2586bad95c5db4dc71f8ad2fTimo Sirainen# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
36b7bef6b3106dae2586bad95c5db4dc71f8ad2fTimo Sirainen# inherited members of a class in the documentation of that class as if those
3c493c276f599d9b9cd10764876d648003046954Timo Sirainen# members were ordinary class members. Constructors, destructors and assignment
17ad2164c747cedbf81dae1893063e71a3df0356Timo Sirainen# operators of the base classes will not be shown.
17ad2164c747cedbf81dae1893063e71a3df0356Timo SirainenINLINE_INHERITED_MEMB = NO
17ad2164c747cedbf81dae1893063e71a3df0356Timo Sirainen# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
b53bec99f804caa67f85c3523435ba9f4502c2d7Timo Sirainen# path before files name in the file list and in the header files. If set
17ad2164c747cedbf81dae1893063e71a3df0356Timo Sirainen# to NO the shortest path that makes the file name unique will be used.
b53bec99f804caa67f85c3523435ba9f4502c2d7Timo SirainenFULL_PATH_NAMES = YES
b53bec99f804caa67f85c3523435ba9f4502c2d7Timo Sirainen# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
b53bec99f804caa67f85c3523435ba9f4502c2d7Timo Sirainen# can be used to strip a user-defined part of the path. Stripping is
f318b3dbe2acc177b8ee1c160e4b5b14e7f2cd41Timo Sirainen# only done if one of the specified strings matches the left-hand part of
b53bec99f804caa67f85c3523435ba9f4502c2d7Timo Sirainen# the path. The tag can be used to show relative paths in the file list.
b53bec99f804caa67f85c3523435ba9f4502c2d7Timo Sirainen# If left blank the directory from which doxygen is run is used as the
b53bec99f804caa67f85c3523435ba9f4502c2d7Timo Sirainen# path to strip. Note that you specify absolute paths here, but also
b53bec99f804caa67f85c3523435ba9f4502c2d7Timo Sirainen# relative paths, which will be relative from the directory where doxygen is
17ad2164c747cedbf81dae1893063e71a3df0356Timo SirainenSTRIP_FROM_PATH =
17ad2164c747cedbf81dae1893063e71a3df0356Timo Sirainen# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
17ad2164c747cedbf81dae1893063e71a3df0356Timo Sirainen# the path mentioned in the documentation of a class, which tells
17ad2164c747cedbf81dae1893063e71a3df0356Timo Sirainen# the reader which header file to include in order to use a class.
17ad2164c747cedbf81dae1893063e71a3df0356Timo Sirainen# If left blank only the name of the header file containing the class
17ad2164c747cedbf81dae1893063e71a3df0356Timo Sirainen# definition is used. Otherwise one should specify the include paths that
17ad2164c747cedbf81dae1893063e71a3df0356Timo Sirainen# are normally passed to the compiler using the -I flag.
f318b3dbe2acc177b8ee1c160e4b5b14e7f2cd41Timo SirainenSTRIP_FROM_INC_PATH =
17ad2164c747cedbf81dae1893063e71a3df0356Timo Sirainen# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen# (but less readable) file names. This can be useful if your file system
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen# doesn't support long names like on DOS, Mac, or CD-ROM.
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo SirainenSHORT_NAMES = NO
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen# will interpret the first line (until the first dot) of a JavaDoc-style
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen# comment as the brief description. If set to NO, the JavaDoc
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen# comments will behave just like regular Qt-style comments
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen# (thus requiring an explicit @brief command for a brief description.)
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo SirainenJAVADOC_AUTOBRIEF = YES
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen# interpret the first line (until the first dot) of a Qt-style
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen# comment as the brief description. If set to NO, the comments
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen# will behave just like regular Qt-style comments (thus requiring
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen# an explicit \brief command for a brief description.)
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo SirainenQT_AUTOBRIEF = NO
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen# treat a multi-line C++ special comment block (i.e. a block of //! or ///
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen# comments) as a brief description. This used to be the default behaviour.
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen# The new default is to treat a multi-line C++ comment block as a detailed
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen# description. Set this tag to YES if you prefer the old behaviour instead.
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo SirainenMULTILINE_CPP_IS_BRIEF = NO
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
f318b3dbe2acc177b8ee1c160e4b5b14e7f2cd41Timo Sirainen# member inherits the documentation from any documented member that it
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen# re-implements.
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo SirainenINHERIT_DOCS = YES
206ac4273fa102500fa017f0c21a4fd72e94665aTimo Sirainen# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
71e88fae3be360e9a93b3398e743f99a6f05d2edTimo Sirainen# a new page for each member. If set to NO, the documentation of a member will
206ac4273fa102500fa017f0c21a4fd72e94665aTimo Sirainen# be part of the file/class/namespace that contains it.
206ac4273fa102500fa017f0c21a4fd72e94665aTimo SirainenSEPARATE_MEMBER_PAGES = NO
206ac4273fa102500fa017f0c21a4fd72e94665aTimo Sirainen# The TAB_SIZE tag can be used to set the number of spaces in a tab.
206ac4273fa102500fa017f0c21a4fd72e94665aTimo Sirainen# Doxygen uses this value to replace tabs by spaces in code fragments.
206ac4273fa102500fa017f0c21a4fd72e94665aTimo Sirainen# This tag can be used to specify a number of aliases that acts
206ac4273fa102500fa017f0c21a4fd72e94665aTimo Sirainen# as commands in the documentation. An alias has the form "name=value".
206ac4273fa102500fa017f0c21a4fd72e94665aTimo Sirainen# For example adding "sideeffect=\par Side Effects:\n" will allow you to
206ac4273fa102500fa017f0c21a4fd72e94665aTimo Sirainen# put the command \sideeffect (or @sideeffect) in the documentation, which
206ac4273fa102500fa017f0c21a4fd72e94665aTimo Sirainen# will result in a user-defined paragraph with heading "Side Effects:".
206ac4273fa102500fa017f0c21a4fd72e94665aTimo Sirainen# You can put \n's in the value part of an alias to insert newlines.
206ac4273fa102500fa017f0c21a4fd72e94665aTimo Sirainen# This tag can be used to specify a number of word-keyword mappings (TCL only).
206ac4273fa102500fa017f0c21a4fd72e94665aTimo Sirainen# A mapping has the form "name=value". For example adding
206ac4273fa102500fa017f0c21a4fd72e94665aTimo Sirainen# "class=itcl::class" will allow you to use the command class in the
206ac4273fa102500fa017f0c21a4fd72e94665aTimo Sirainen# itcl::class meaning.
206ac4273fa102500fa017f0c21a4fd72e94665aTimo Sirainen# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
206ac4273fa102500fa017f0c21a4fd72e94665aTimo Sirainen# sources only. Doxygen will then generate output that is more tailored for C.
206ac4273fa102500fa017f0c21a4fd72e94665aTimo Sirainen# For instance, some of the names that are used will be different. The list
206ac4273fa102500fa017f0c21a4fd72e94665aTimo Sirainen# of all members will be omitted, etc.
206ac4273fa102500fa017f0c21a4fd72e94665aTimo SirainenOPTIMIZE_OUTPUT_FOR_C = YES
206ac4273fa102500fa017f0c21a4fd72e94665aTimo Sirainen# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
206ac4273fa102500fa017f0c21a4fd72e94665aTimo Sirainen# sources only. Doxygen will then generate output that is more tailored for
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# Java. For instance, namespaces will be presented as packages, qualified
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# scopes will look different, etc.
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo SirainenOPTIMIZE_OUTPUT_JAVA = NO
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
02a54da28f376dd66d7939d8546a196a0045b486Timo Sirainen# sources only. Doxygen will then generate output that is more tailored for
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo SirainenOPTIMIZE_FOR_FORTRAN = NO
02a54da28f376dd66d7939d8546a196a0045b486Timo Sirainen# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# sources. Doxygen will then generate output that is tailored for
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo SirainenOPTIMIZE_OUTPUT_VHDL = NO
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# Doxygen selects the parser to use depending on the extension of the files it
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# parses. With this tag you can assign which parser to use for a given
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# extension. Doxygen has a built-in mapping, but you can override or extend it
12ef7b394dfdf4d53d432ac576f6bfcd20ebad6dTimo Sirainen# using this tag. The format is ext=language, where ext is a file extension,
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# and language is one of the parsers supported by doxygen: IDL, Java,
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen# C++. For instance to make doxygen treat .inc files as Fortran files (default
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen# that for custom extensions you also need to set FILE_PATTERNS otherwise the
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen# files are not read by doxygen.
73b50eecfc31750a312e2f940023f522eb07178cTimo SirainenEXTENSION_MAPPING =
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# comments according to the Markdown format, which allows for more readable
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# documentation. See http://daringfireball.net/projects/markdown/ for details.
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# The output of markdown processing is further processed by doxygen, so you
8e371a3ce32bd64288786855b8ce0cb63f19f7d1Timo Sirainen# can mix doxygen, HTML, and XML commands with Markdown formatting.
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# Disable only in case of backward compatibilities issues.
12ef7b394dfdf4d53d432ac576f6bfcd20ebad6dTimo SirainenMARKDOWN_SUPPORT = YES
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen# When enabled doxygen tries to link words that correspond to documented classes,
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen# or namespaces to their corresponding documentation. Such a link can be
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen# prevented in individual cases by by putting a % sign in front of the word or
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# globally by setting AUTOLINK_SUPPORT to NO.
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo SirainenAUTOLINK_SUPPORT = YES
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# to include (a tag file for) the STL sources as input, then you should
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# set this tag to YES in order to let doxygen match functions declarations and
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# func(std::string) {}). This also makes the inheritance and collaboration
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# diagrams that involve STL classes more complete and accurate.
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo SirainenBUILTIN_STL_SUPPORT = YES
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# If you use Microsoft's C++/CLI language, you should set this option to YES to
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen# enable parsing support.
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo SirainenCPP_CLI_SUPPORT = NO
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen# Doxygen will parse them like normal C++ but will assume all classes use public
103106f0227b8487abc1e2c6ad63b84cdc51388eTimo Sirainen# instead of private inheritance when no explicit protection keyword is present.
103106f0227b8487abc1e2c6ad63b84cdc51388eTimo SirainenSIP_SUPPORT = NO
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# For Microsoft's IDL there are propget and propput attributes to indicate
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen# getter and setter methods for a property. Setting this option to YES (the
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# default) will make doxygen replace the get and set methods by a property in
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# the documentation. This will only work if the methods are indeed getting or
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen# setting a simple type. If this is not the case, or you want to show the
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# methods anyway, you should set this option to NO.
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo SirainenIDL_PROPERTY_SUPPORT = YES
8e371a3ce32bd64288786855b8ce0cb63f19f7d1Timo Sirainen# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# tag is set to YES, then doxygen will reuse the documentation of the first
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# member in the group (if any) for the other members of the group. By default
02a54da28f376dd66d7939d8546a196a0045b486Timo Sirainen# all members of a group must be documented explicitly.
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo SirainenDISTRIBUTE_GROUP_DOC = NO
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen# the same type (for instance a group of public functions) to be put as a
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# subgroup of that type (e.g. under the Public Functions section). Set it to
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# NO to prevent subgrouping. Alternatively, this can be done per class using
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen# the \nosubgrouping command.
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo SirainenSUBGROUPING = YES
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# unions are shown inside the group in which they are included (e.g. using
8e371a3ce32bd64288786855b8ce0cb63f19f7d1Timo Sirainen# @ingroup) instead of on a separate page (for HTML and Man pages) or
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# section (for LaTeX and RTF).
02a54da28f376dd66d7939d8546a196a0045b486Timo SirainenINLINE_GROUPED_CLASSES = NO
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# unions with only public data fields will be shown inline in the documentation
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# of the scope in which they are defined (i.e. file, namespace, or group
742230f6ea54caf4dc2fdf365396da2e26f2f8e3Timo Sirainen# documentation), provided this scope is documented. If set to NO (the default),
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen# structs, classes, and unions are shown on a separate page (for HTML and Man
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# pages) or section (for LaTeX and RTF).
73b50eecfc31750a312e2f940023f522eb07178cTimo SirainenINLINE_SIMPLE_STRUCTS = NO
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
539977f9257bd8985be5a8093658da266ae9cd19Timo Sirainen# is documented as struct, union, or enum with the name of the typedef. So
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
539977f9257bd8985be5a8093658da266ae9cd19Timo Sirainen# with name TypeT. When disabled the typedef will appear as a member of a file,
539977f9257bd8985be5a8093658da266ae9cd19Timo Sirainen# namespace, or class. And the struct will be named TypeS. This can typically
539977f9257bd8985be5a8093658da266ae9cd19Timo Sirainen# be useful for C code in case the coding convention dictates that all compound
8e371a3ce32bd64288786855b8ce0cb63f19f7d1Timo Sirainen# types are typedef'ed and only the typedef is referenced, never the tag name.
539977f9257bd8985be5a8093658da266ae9cd19Timo SirainenTYPEDEF_HIDES_STRUCT = NO
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
8e371a3ce32bd64288786855b8ce0cb63f19f7d1Timo Sirainen# determine which symbols to keep in memory and which to flush to disk.
539977f9257bd8985be5a8093658da266ae9cd19Timo Sirainen# When the cache is full, less often used symbols will be written to disk.
539977f9257bd8985be5a8093658da266ae9cd19Timo Sirainen# For small to medium size projects (<1000 input files) the default value is
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# probably good enough. For larger projects a too small cache size can cause
539977f9257bd8985be5a8093658da266ae9cd19Timo Sirainen# doxygen to be busy swapping symbols to and from disk most of the time
539977f9257bd8985be5a8093658da266ae9cd19Timo Sirainen# causing a significant performance penalty.
539977f9257bd8985be5a8093658da266ae9cd19Timo Sirainen# If the system has enough physical memory increasing the cache will improve the
8e371a3ce32bd64288786855b8ce0cb63f19f7d1Timo Sirainen# performance by keeping more symbols in memory. Note that the value works on
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# a logarithmic scale so increasing the size by one will roughly double the
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# memory usage. The cache size is given by this formula:
e2d268e9531227ead6a98466ecf3c046c857ef70Timo Sirainen# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
e2d268e9531227ead6a98466ecf3c046c857ef70Timo Sirainen# corresponding to a cache size of 2^16 = 65536 symbols.
12ef7b394dfdf4d53d432ac576f6bfcd20ebad6dTimo SirainenSYMBOL_CACHE_SIZE = 0
12ef7b394dfdf4d53d432ac576f6bfcd20ebad6dTimo Sirainen# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
12ef7b394dfdf4d53d432ac576f6bfcd20ebad6dTimo Sirainen# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
12ef7b394dfdf4d53d432ac576f6bfcd20ebad6dTimo Sirainen# their name and scope. Since this can be an expensive process and often the
12ef7b394dfdf4d53d432ac576f6bfcd20ebad6dTimo Sirainen# same symbol appear multiple times in the code, doxygen keeps a cache of
12ef7b394dfdf4d53d432ac576f6bfcd20ebad6dTimo Sirainen# pre-resolved symbols. If the cache is too small doxygen will become slower.
e2d268e9531227ead6a98466ecf3c046c857ef70Timo Sirainen# If the cache is too large, memory is wasted. The cache size is given by this
12ef7b394dfdf4d53d432ac576f6bfcd20ebad6dTimo Sirainen# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
e2d268e9531227ead6a98466ecf3c046c857ef70Timo Sirainen# corresponding to a cache size of 2^16 = 65536 symbols.
e2d268e9531227ead6a98466ecf3c046c857ef70Timo SirainenLOOKUP_CACHE_SIZE = 0
e2d268e9531227ead6a98466ecf3c046c857ef70Timo Sirainen#---------------------------------------------------------------------------
e2d268e9531227ead6a98466ecf3c046c857ef70Timo Sirainen# Build related configuration options
12ef7b394dfdf4d53d432ac576f6bfcd20ebad6dTimo Sirainen#---------------------------------------------------------------------------
e2d268e9531227ead6a98466ecf3c046c857ef70Timo Sirainen# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
12ef7b394dfdf4d53d432ac576f6bfcd20ebad6dTimo Sirainen# documentation are documented, even if no documentation was available.
12ef7b394dfdf4d53d432ac576f6bfcd20ebad6dTimo Sirainen# Private class members and static file members will be hidden unless
12ef7b394dfdf4d53d432ac576f6bfcd20ebad6dTimo Sirainen# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
12ef7b394dfdf4d53d432ac576f6bfcd20ebad6dTimo SirainenEXTRACT_ALL = YES
e3aeeb634245e80d4f643f8d2eea11d6b72336d8Timo Sirainen# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# will be included in the documentation.
e3aeeb634245e80d4f643f8d2eea11d6b72336d8Timo SirainenEXTRACT_PRIVATE = YES
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo Sirainen# scope will be included in the documentation.
04870054863757edf048c81dcce3c5e7dec453cdTimo SirainenEXTRACT_PACKAGE = NO
e2d268e9531227ead6a98466ecf3c046c857ef70Timo Sirainen# If the EXTRACT_STATIC tag is set to YES all static members of a file
e2d268e9531227ead6a98466ecf3c046c857ef70Timo Sirainen# will be included in the documentation.
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo SirainenEXTRACT_STATIC = YES
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# defined locally in source files will be included in the documentation.
6695fbfc493422a810eb5d950bfd6f41990626a9Timo Sirainen# If set to NO only classes defined in header files are included.
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo SirainenEXTRACT_LOCAL_CLASSES = NO
04870054863757edf048c81dcce3c5e7dec453cdTimo Sirainen# This flag is only useful for Objective-C code. When set to YES local
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# methods, which are defined in the implementation section but not in
7ada346a0fb1540ae8c26433a6a12166c27daf22Timo Sirainen# the interface are included in the documentation.
7ada346a0fb1540ae8c26433a6a12166c27daf22Timo Sirainen# If set to NO (the default) only methods in the interface are included.
6695fbfc493422a810eb5d950bfd6f41990626a9Timo SirainenEXTRACT_LOCAL_METHODS = NO
7ada346a0fb1540ae8c26433a6a12166c27daf22Timo Sirainen# If this flag is set to YES, the members of anonymous namespaces will be
6695fbfc493422a810eb5d950bfd6f41990626a9Timo Sirainen# extracted and appear in the documentation as a namespace called
04870054863757edf048c81dcce3c5e7dec453cdTimo Sirainen# 'anonymous_namespace{file}', where file will be replaced with the base
6695fbfc493422a810eb5d950bfd6f41990626a9Timo Sirainen# name of the file that contains the anonymous namespace. By default
6695fbfc493422a810eb5d950bfd6f41990626a9Timo Sirainen# anonymous namespaces are hidden.
e2d268e9531227ead6a98466ecf3c046c857ef70Timo SirainenEXTRACT_ANON_NSPACES = NO
6695fbfc493422a810eb5d950bfd6f41990626a9Timo Sirainen# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
6695fbfc493422a810eb5d950bfd6f41990626a9Timo Sirainen# undocumented members of documented classes, files or namespaces.
6695fbfc493422a810eb5d950bfd6f41990626a9Timo Sirainen# If set to NO (the default) these members will be included in the
6695fbfc493422a810eb5d950bfd6f41990626a9Timo Sirainen# various overviews, but no documentation section is generated.
6695fbfc493422a810eb5d950bfd6f41990626a9Timo Sirainen# This option has no effect if EXTRACT_ALL is enabled.
6695fbfc493422a810eb5d950bfd6f41990626a9Timo SirainenHIDE_UNDOC_MEMBERS = NO
6695fbfc493422a810eb5d950bfd6f41990626a9Timo Sirainen# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
6695fbfc493422a810eb5d950bfd6f41990626a9Timo Sirainen# undocumented classes that are normally visible in the class hierarchy.
6695fbfc493422a810eb5d950bfd6f41990626a9Timo Sirainen# If set to NO (the default) these classes will be included in the various
12ef7b394dfdf4d53d432ac576f6bfcd20ebad6dTimo Sirainen# overviews. This option has no effect if EXTRACT_ALL is enabled.
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo SirainenHIDE_UNDOC_CLASSES = NO
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# friend (class|struct|union) declarations.
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen# If set to NO (the default) these declarations will be included in the
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen# documentation.
73b50eecfc31750a312e2f940023f522eb07178cTimo SirainenHIDE_FRIEND_COMPOUNDS = NO
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
1973c7c4f46abec48e1015823a304f17da35b2f6Timo Sirainen# documentation blocks found inside the body of a function.
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen# If set to NO (the default) these blocks will be appended to the
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen# function's detailed documentation block.
73b50eecfc31750a312e2f940023f522eb07178cTimo SirainenHIDE_IN_BODY_DOCS = NO
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen# The INTERNAL_DOCS tag determines if documentation
1973c7c4f46abec48e1015823a304f17da35b2f6Timo Sirainen# that is typed after a \internal command is included. If the tag is set
1973c7c4f46abec48e1015823a304f17da35b2f6Timo Sirainen# to NO (the default) then the documentation will be excluded.
1973c7c4f46abec48e1015823a304f17da35b2f6Timo Sirainen# Set it to YES to include the internal documentation.
1973c7c4f46abec48e1015823a304f17da35b2f6Timo SirainenINTERNAL_DOCS = NO
73b50eecfc31750a312e2f940023f522eb07178cTimo Sirainen# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
ef3f582fdf2d007838bba693f8c2629d079668deTimo Sirainen# file names in lower-case letters. If set to YES upper-case letters are also
cff1f182205e674285cf3ff446a0dcf7afea277dTimo Sirainen# allowed. This is useful if you have classes or files whose names only differ
c29216637957d4b3126c6929ac5ba98138256ce1Timo Sirainen# in case and if your file system supports case sensitive file names. Windows
306cfd77100131c08b243de10f6d40500f4c27c6Timo Sirainen# and Mac users are advised to set this option to NO.
306cfd77100131c08b243de10f6d40500f4c27c6Timo SirainenCASE_SENSE_NAMES = YES
306cfd77100131c08b243de10f6d40500f4c27c6Timo Sirainen# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
306cfd77100131c08b243de10f6d40500f4c27c6Timo Sirainen# will show members with their full class and namespace scopes in the
306cfd77100131c08b243de10f6d40500f4c27c6Timo Sirainen# documentation. If set to YES the scope will be hidden.
306cfd77100131c08b243de10f6d40500f4c27c6Timo SirainenHIDE_SCOPE_NAMES = YES
306cfd77100131c08b243de10f6d40500f4c27c6Timo Sirainen# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
306cfd77100131c08b243de10f6d40500f4c27c6Timo Sirainen# will put a list of the files that are included by a file in the documentation
306cfd77100131c08b243de10f6d40500f4c27c6Timo Sirainen# of that file.
306cfd77100131c08b243de10f6d40500f4c27c6Timo SirainenSHOW_INCLUDE_FILES = YES
306cfd77100131c08b243de10f6d40500f4c27c6Timo Sirainen# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
306cfd77100131c08b243de10f6d40500f4c27c6Timo Sirainen# will list include files with double quotes in the documentation
cff1f182205e674285cf3ff446a0dcf7afea277dTimo Sirainen# rather than with sharp brackets.
306cfd77100131c08b243de10f6d40500f4c27c6Timo SirainenFORCE_LOCAL_INCLUDES = NO
306cfd77100131c08b243de10f6d40500f4c27c6Timo Sirainen# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
306cfd77100131c08b243de10f6d40500f4c27c6Timo Sirainen# is inserted in the documentation for inline members.
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo SirainenINLINE_INFO = YES
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo Sirainen# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
2615df45a8027948a474abe5e817b34b0499c171Timo Sirainen# will sort the (detailed) documentation of file and class members
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo Sirainen# alphabetically by member name. If set to NO the members will appear in
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo Sirainen# declaration order.
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo SirainenSORT_MEMBER_DOCS = YES
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo Sirainen# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen# brief documentation of file, namespace and class members alphabetically
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen# by member name. If set to NO (the default) the members will appear in
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo Sirainen# declaration order.
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo SirainenSORT_BRIEF_DOCS = NO
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo Sirainen# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo Sirainen# will sort the (brief and detailed) documentation of class members so that
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo Sirainen# constructors and destructors are listed first. If set to NO (the default)
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo Sirainen# the constructors will appear in the respective orders defined by
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo Sirainen# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo Sirainen# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo SirainenSORT_MEMBERS_CTORS_1ST = NO
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo Sirainen# hierarchy of group names into alphabetical order. If set to NO (the default)
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo Sirainen# the group names will appear in their defined order.
1973c7c4f46abec48e1015823a304f17da35b2f6Timo SirainenSORT_GROUP_NAMES = NO
1973c7c4f46abec48e1015823a304f17da35b2f6Timo Sirainen# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
1973c7c4f46abec48e1015823a304f17da35b2f6Timo Sirainen# sorted by fully-qualified names, including namespaces. If set to
1973c7c4f46abec48e1015823a304f17da35b2f6Timo Sirainen# NO (the default), the class list will be sorted only by class name,
1973c7c4f46abec48e1015823a304f17da35b2f6Timo Sirainen# not including the namespace part.
1973c7c4f46abec48e1015823a304f17da35b2f6Timo Sirainen# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen# Note: This option applies only to the class list, not to the
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo Sirainen# alphabetical list.
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo SirainenSORT_BY_SCOPE_NAME = NO
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo Sirainen# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo Sirainen# do proper type resolution of all parameters of a function it will reject a
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo Sirainen# match between the prototype and the implementation of a member function even
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo Sirainen# if there is only one candidate or it is obvious which candidate to choose
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo Sirainen# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo Sirainen# will still accept a match between prototype and implementation in such cases.
1d2b188f0eedc3cab6e27ceac5425a037f38042eTimo SirainenSTRICT_PROTO_MATCHING = NO
b59960aed0923004f21f2a00bc1c945084d2f851Timo Sirainen# The GENERATE_TODOLIST tag can be used to enable (YES) or
b59960aed0923004f21f2a00bc1c945084d2f851Timo Sirainen# disable (NO) the todo list. This list is created by putting \todo
b59960aed0923004f21f2a00bc1c945084d2f851Timo Sirainen# commands in the documentation.
b59960aed0923004f21f2a00bc1c945084d2f851Timo SirainenGENERATE_TODOLIST = YES
b59960aed0923004f21f2a00bc1c945084d2f851Timo Sirainen# The GENERATE_TESTLIST tag can be used to enable (YES) or
b59960aed0923004f21f2a00bc1c945084d2f851Timo Sirainen# disable (NO) the test list. This list is created by putting \test
b59960aed0923004f21f2a00bc1c945084d2f851Timo Sirainen# commands in the documentation.
b59960aed0923004f21f2a00bc1c945084d2f851Timo SirainenGENERATE_TESTLIST = YES
b59960aed0923004f21f2a00bc1c945084d2f851Timo Sirainen# The GENERATE_BUGLIST tag can be used to enable (YES) or
b59960aed0923004f21f2a00bc1c945084d2f851Timo Sirainen# disable (NO) the bug list. This list is created by putting \bug
b59960aed0923004f21f2a00bc1c945084d2f851Timo Sirainen# commands in the documentation.
b59960aed0923004f21f2a00bc1c945084d2f851Timo SirainenGENERATE_BUGLIST = YES
b59960aed0923004f21f2a00bc1c945084d2f851Timo Sirainen# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
b59960aed0923004f21f2a00bc1c945084d2f851Timo Sirainen# disable (NO) the deprecated list. This list is created by putting
b59960aed0923004f21f2a00bc1c945084d2f851Timo Sirainen# \deprecated commands in the documentation.
ea9d9d99948cff5f9b881f79b28fa3b80da0f2a7Timo SirainenGENERATE_DEPRECATEDLIST= YES
ea9d9d99948cff5f9b881f79b28fa3b80da0f2a7Timo Sirainen# The ENABLED_SECTIONS tag can be used to enable conditional
539977f9257bd8985be5a8093658da266ae9cd19Timo Sirainen# documentation sections, marked by \if section-label ... \endif
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# and \cond section-label ... \endcond blocks.
ea9d9d99948cff5f9b881f79b28fa3b80da0f2a7Timo SirainenENABLED_SECTIONS =
ea9d9d99948cff5f9b881f79b28fa3b80da0f2a7Timo Sirainen# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
ea9d9d99948cff5f9b881f79b28fa3b80da0f2a7Timo Sirainen# the initial value of a variable or macro consists of for it to appear in
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# the documentation. If the initializer consists of more lines than specified
a9dbce68b8bf10026e05721fdf3206279d64cb8aTimo Sirainen# here it will be hidden. Use a value of 0 to hide initializers completely.
a9dbce68b8bf10026e05721fdf3206279d64cb8aTimo Sirainen# The appearance of the initializer of individual variables and macros in the
a9dbce68b8bf10026e05721fdf3206279d64cb8aTimo Sirainen# documentation can be controlled using \showinitializer or \hideinitializer
a9dbce68b8bf10026e05721fdf3206279d64cb8aTimo Sirainen# command in the documentation regardless of this setting.
a9dbce68b8bf10026e05721fdf3206279d64cb8aTimo SirainenMAX_INITIALIZER_LINES = 30
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
539977f9257bd8985be5a8093658da266ae9cd19Timo Sirainen# at the bottom of the documentation of classes and structs. If set to YES the
539977f9257bd8985be5a8093658da266ae9cd19Timo Sirainen# list will mention the files that were used to generate the documentation.
dd350fbefc91e6450dcd01f0cda5db6ea2242736Timo SirainenSHOW_USED_FILES = YES
dd350fbefc91e6450dcd01f0cda5db6ea2242736Timo Sirainen# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
db9f053331a7bb144d32a2331e666cb1d2be5766Timo Sirainen# This will remove the Files entry from the Quick Index and from the
dd350fbefc91e6450dcd01f0cda5db6ea2242736Timo Sirainen# Folder Tree View (if specified). The default is YES.
539977f9257bd8985be5a8093658da266ae9cd19Timo SirainenSHOW_FILES = YES
306cfd77100131c08b243de10f6d40500f4c27c6Timo Sirainen# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
539977f9257bd8985be5a8093658da266ae9cd19Timo Sirainen# Namespaces page.
b59960aed0923004f21f2a00bc1c945084d2f851Timo Sirainen# This will remove the Namespaces entry from the Quick Index
f318b3dbe2acc177b8ee1c160e4b5b14e7f2cd41Timo Sirainen# and from the Folder Tree View (if specified). The default is YES.
f318b3dbe2acc177b8ee1c160e4b5b14e7f2cd41Timo SirainenSHOW_NAMESPACES = YES
539977f9257bd8985be5a8093658da266ae9cd19Timo Sirainen# The FILE_VERSION_FILTER tag can be used to specify a program or script that
539977f9257bd8985be5a8093658da266ae9cd19Timo Sirainen# doxygen should invoke to get the current version for each file (typically from
539977f9257bd8985be5a8093658da266ae9cd19Timo Sirainen# the version control system). Doxygen will invoke the program by executing (via
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# popen()) the command <command> <input-file>, where <command> is the value of
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# provided by doxygen. Whatever the program writes to standard output
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# is used as the file version. See the manual for examples.
db9f053331a7bb144d32a2331e666cb1d2be5766Timo SirainenFILE_VERSION_FILTER =
7fb70daba4e571eab5b64f496d20b9e37e31141bTimo Sirainen# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# by doxygen. The layout file controls the global structure of the generated
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# output files in an output format independent way. To create the layout file
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# that represents doxygen's defaults, run doxygen with the -l option.
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# You can optionally specify a file name after the option, if omitted
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# DoxygenLayout.xml will be used as the name of the layout file.
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# The CITE_BIB_FILES tag can be used to specify one or more bib files
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# containing the references data. This must be a list of .bib files. The
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# .bib extension is automatically appended if omitted. Using this command
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# requires the bibtex tool to be installed. See also
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# feature you need bibtex and perl available in the search path. Do not use
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# file names with spaces, bibtex cannot handle them.
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo SirainenCITE_BIB_FILES =
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen#---------------------------------------------------------------------------
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# configuration options related to warning and progress messages
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen#---------------------------------------------------------------------------
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# The QUIET tag can be used to turn on/off the messages that are generated
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# by doxygen. Possible values are YES and NO. If left blank NO is used.
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# The WARNINGS tag can be used to turn on/off the warning messages that are
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# generated by doxygen. Possible values are YES and NO. If left blank
238812433b4f7965fd662dce0f4efccb092630a8Timo SirainenWARNINGS = YES
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# automatically be disabled.
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo SirainenWARN_IF_UNDOCUMENTED = NO
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# potential errors in the documentation, such as not documenting some
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# parameters in a documented function, or documenting parameters that
238812433b4f7965fd662dce0f4efccb092630a8Timo Sirainen# don't exist or using markup commands wrongly.
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo SirainenWARN_IF_DOC_ERROR = YES
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# The WARN_NO_PARAMDOC option can be enabled to get warnings for
238812433b4f7965fd662dce0f4efccb092630a8Timo Sirainen# functions that are documented, but have no documentation for their parameters
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# or return value. If set to NO (the default) doxygen will only warn about
eb4d4f557fa75aa2a47639e9deb75a21f44eb42aTimo Sirainen# wrong or incomplete parameter documentation, but not about the absence of
WARN_LOGFILE = doxygen_warnings.log
# The INPUT tag can be used to specify the files and/or directories that contain
# documented source files. You may enter file names like "myfile.cpp" or
# directories like "/usr/src/myproject". Separate the files or directories
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
# The EXCLUDE tag can be used to specify files and/or directories that should be
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
# is part of the input, its contents will be placed on the main page (index.html).
# called/used by that function will be listed.
# tagging system (see http://www.gnu.org/software/global/global.html). You
# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
# see http://en.wikipedia.org/wiki/Hue for more information.
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
DOCSET_BUNDLE_ID = org.doxygen.Project
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
# the HTML help compiler on the generated index.hhp.
# http://doc.trolltech.com/qthelpproject.html#namespace
QHP_NAMESPACE = org.doxygen.Project
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
# http://doc.trolltech.com/qthelpproject.html#custom-filters
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
ECLIPSE_DOC_ID = org.doxygen.Project
# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
# (see http://www.mathjax.org) which uses client side Javascript for the
# thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and
# directory should contain the MathJax.js script. For instance, if the mathjax
# copy of MathJax from http://www.mathjax.org before deployment.
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
# search engine (doxysearch.cgi) which are based on the open source search engine
SEARCHDATA_FILE = searchdata.xml
# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
# http://en.wikipedia.org/wiki/BibTeX for more info.
# config file, i.e. a series of assignments. You only have to provide
# generate an AutoGen Definitions (see autogen.sf.net) file
# The names of the make variables in the generated doxyrules.make file
# This is useful so different doxyrules.make files included by the same
# interpreter (i.e. the result of `which perl').
PERL_PATH = /usr/bin/perl
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
# a graph (i.e. they become hard to read).
# files in one run (i.e. multiple -o and -T options on the command line). This