046dd19afa905a234191b0434743a85128499c51Jabiertxof# Doxyfile 1.8.9.1
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# This file describes the settings to be used by the documentation system
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# doxygen (www.doxygen.org) for a project.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# All text after a double hash (##) is considered a comment and is placed in
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# front of the TAG it is preceding.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# All text after a single hash (#) is considered a comment and will be ignored.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# The format is:
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# TAG = value [value, ...]
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# For lists, items can also be appended using:
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# TAG += value [value, ...]
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Values that contain spaces should be placed between quotes (\" \").
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# Project related configuration options
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# This tag specifies the encoding used for all characters in the config file
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# that follow. The default is UTF-8 which is also the encoding used for all text
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# for the list of possible encodings.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: UTF-8.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickDOXYFILE_ENCODING = UTF-8
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# double-quotes, unless you are using Doxywizard) that should identify the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# project for which the documentation is generated. This name is used in the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# title of most generated pages and in a few other places.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: My Project.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickPROJECT_NAME = inkscape
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# could be handy for archiving the generated documentation or if some version
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# control system is used.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofPROJECT_NUMBER =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Using the PROJECT_BRIEF tag one can provide an optional one line description
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# for a project that appears at the top of each page and should give viewer a
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# quick idea about the purpose of the project. Keep the description short.
046dd19afa905a234191b0434743a85128499c51JabiertxofPROJECT_BRIEF = "Vector Graphics Editor"
046dd19afa905a234191b0434743a85128499c51Jabiertxof# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
046dd19afa905a234191b0434743a85128499c51Jabiertxof# in the documentation. The maximum height of the logo should not exceed 55
046dd19afa905a234191b0434743a85128499c51Jabiertxof# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
046dd19afa905a234191b0434743a85128499c51Jabiertxof# the logo to the output directory.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# into which the generated documentation will be written. If a relative path is
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# entered, it will be relative to the location where doxygen was started. If
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# left blank the current directory will be used.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickOUTPUT_DIRECTORY = doxygen
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# directories (in 2 levels) under the output directory of each output format and
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# will distribute the generated files over these directories. Enabling this
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# option can be useful when feeding doxygen a huge amount of source files, where
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# putting all generated files in the same directory would otherwise causes
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# performance problems for the file system.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickCREATE_SUBDIRS = NO
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# characters to appear in the names of generated files. If set to NO, non-ASCII
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# The default value is: NO.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofALLOW_UNICODE_NAMES = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The OUTPUT_LANGUAGE tag is used to specify the language in which all
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# documentation generated by doxygen is written. Doxygen will use this
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# information to generate all constant output in the proper language.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Ukrainian and Vietnamese.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: English.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickOUTPUT_LANGUAGE = English
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# descriptions after the members that are listed in the file and class
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# documentation (similar to Javadoc). Set to NO to disable this.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickBRIEF_MEMBER_DESC = YES
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# description of a member or function before the detailed description
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# brief descriptions will be completely suppressed.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickREPEAT_BRIEF = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag implements a quasi-intelligent brief description abbreviator that is
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# used to form the text in various listings. Each string in this list, if found
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# as the leading text of the brief description, will be stripped from the text
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# and the result, after processing the whole list, is used as the annotated
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# text. Otherwise, the brief description is used as-is. If left blank, the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# following values are used ($name is automatically replaced with the name of
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the entity):The $name class, The $name widget, The $name file, is, provides,
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# specifies, contains, represents, a, an and the.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofABBREVIATE_BRIEF =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# doxygen will generate a detailed section even if there is only a brief
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# description.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickALWAYS_DETAILED_SEC = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# inherited members of a class in the documentation of that class as if those
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# members were ordinary class members. Constructors, destructors and assignment
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# operators of the base classes will not be shown.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickINLINE_INHERITED_MEMB = NO
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# before files name in the file list and in the header files. If set to NO the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# shortest path that makes the file name unique will be used
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickFULL_PATH_NAMES = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Stripping is only done if one of the specified strings matches the left-hand
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# part of the path. The tag can be used to show relative paths in the file list.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If left blank the directory from which doxygen is run is used as the path to
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note that you can specify absolute paths here, but also relative paths, which
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# will be relative from the directory where doxygen is started.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag FULL_PATH_NAMES is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofSTRIP_FROM_PATH =
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# path mentioned in the documentation of a class, which tells the reader which
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# header file to include in order to use a class. If left blank only the name of
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the header file containing the class definition is used. Otherwise one should
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# specify the list of include paths that are normally passed to the compiler
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# using the -I flag.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofSTRIP_FROM_INC_PATH =
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# less readable) file names. This can be useful is your file systems doesn't
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# support long names like on DOS, Mac, or CD-ROM.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSHORT_NAMES = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# first line (until the first dot) of a Javadoc-style comment as the brief
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# description. If set to NO, the Javadoc-style will behave just like regular Qt-
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# style comments (thus requiring an explicit @brief command for a brief
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickJAVADOC_AUTOBRIEF = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# line (until the first dot) of a Qt-style comment as the brief description. If
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# requiring an explicit \brief command for a brief description.)
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickQT_AUTOBRIEF = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# a brief description. This used to be the default behavior. The new default is
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# to treat a multi-line C++ comment block as a detailed description. Set this
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# tag to YES if you prefer the old behavior instead.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note that setting this tag to YES also means that rational rose comments are
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# not recognized any more.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickMULTILINE_CPP_IS_BRIEF = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# documentation from any documented member that it re-implements.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickINHERIT_DOCS = YES
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
046dd19afa905a234191b0434743a85128499c51Jabiertxof# page for each member. If set to NO, the documentation of a member will be part
046dd19afa905a234191b0434743a85128499c51Jabiertxof# of the file/class/namespace that contains it.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSEPARATE_MEMBER_PAGES = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# uses this value to replace tabs by spaces in code fragments.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Minimum value: 1, maximum value: 16, default value: 4.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickTAB_SIZE = 4
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag can be used to specify a number of aliases that act as commands in
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the documentation. An alias has the form:
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# For example adding
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# "sideeffect=@par Side Effects:\n"
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# will allow you to put the command \sideeffect (or @sideeffect) in the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# documentation, which will result in a user-defined paragraph with heading
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# "Side Effects:". You can put \n's in the value part of an alias to insert
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# This tag can be used to specify a number of word-keyword mappings (TCL only).
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# A mapping has the form "name=value". For example adding "class=itcl::class"
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# will allow you to use the command class in the itcl::class meaning.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# only. Doxygen will then generate output that is more tailored for C. For
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# instance, some of the names that are used will be different. The list of all
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# members will be omitted, etc.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofOPTIMIZE_OUTPUT_FOR_C = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Python sources only. Doxygen will then generate output that is more tailored
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# for that language. For instance, namespaces will be presented as packages,
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# qualified scopes will look different, etc.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickOPTIMIZE_OUTPUT_JAVA = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# sources. Doxygen will then generate output that is tailored for Fortran.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickOPTIMIZE_FOR_FORTRAN = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# sources. Doxygen will then generate output that is tailored for VHDL.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickOPTIMIZE_OUTPUT_VHDL = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Doxygen selects the parser to use depending on the extension of the files it
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# parses. With this tag you can assign which parser to use for a given
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# extension. Doxygen has a built-in mapping, but you can override or extend it
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# using this tag. The format is ext=language, where ext is a file extension, and
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# Fortran. In the later case the parser tries to guess whether the code is fixed
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# or free formatted code, this is the default for Fortran type files), VHDL. For
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# instance to make doxygen treat .inc files as Fortran files (default is PHP),
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# and .f files as C (default is Fortran), use: inc=Fortran f=C.
046dd19afa905a234191b0434743a85128499c51Jabiertxof# Note: For files without extension you can use no_extension as a placeholder.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the files are not read by doxygen.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofEXTENSION_MAPPING =
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# according to the Markdown format, which allows for more readable
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# documentation. See http://daringfireball.net/projects/markdown/ for details.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The output of markdown processing is further processed by doxygen, so you can
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# case of backward compatibilities issues.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraMARKDOWN_SUPPORT = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# When enabled doxygen tries to link words that correspond to documented
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# classes, or namespaces to their corresponding documentation. Such a link can
046dd19afa905a234191b0434743a85128499c51Jabiertxof# be prevented in individual cases by putting a % sign in front of the word or
046dd19afa905a234191b0434743a85128499c51Jabiertxof# globally by setting AUTOLINK_SUPPORT to NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraAUTOLINK_SUPPORT = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# to include (a tag file for) the STL sources as input, then you should set this
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# tag to YES in order to let doxygen match functions declarations and
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# definitions whose arguments contain STL classes (e.g. func(std::string);
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# versus func(std::string) {}). This also make the inheritance and collaboration
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# diagrams that involve STL classes more complete and accurate.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickBUILTIN_STL_SUPPORT = YES
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# If you use Microsoft's C++/CLI language, you should set this option to YES to
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# enable parsing support.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickCPP_CLI_SUPPORT = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# will parse them like normal C++ but will assume all classes use public instead
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# of private inheritance when no explicit protection keyword is present.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSIP_SUPPORT = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# For Microsoft's IDL there are propget and propput attributes to indicate
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# getter and setter methods for a property. Setting this option to YES will make
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# doxygen to replace the get and set methods by a property in the documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This will only work if the methods are indeed getting or setting a simple
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# type. If this is not the case, or you want to show the methods anyway, you
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# should set this option to NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickIDL_PROPERTY_SUPPORT = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
046dd19afa905a234191b0434743a85128499c51Jabiertxof# tag is set to YES then doxygen will reuse the documentation of the first
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# member in the group (if any) for the other members of the group. By default
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# all members of a group must be documented explicitly.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickDISTRIBUTE_GROUP_DOC = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Set the SUBGROUPING tag to YES to allow class member groups of the same type
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# (for instance a group of public functions) to be put as a subgroup of that
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# type (e.g. under the Public Functions section). Set it to NO to prevent
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# subgrouping. Alternatively, this can be done per class using the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# \nosubgrouping command.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSUBGROUPING = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# are shown inside the group in which they are included (e.g. using \ingroup)
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note that this feature does not work in combination with
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# SEPARATE_MEMBER_PAGES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraINLINE_GROUPED_CLASSES = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# with only public data fields or simple typedef fields will be shown inline in
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the documentation of the scope in which they are defined (i.e. file,
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# namespace, or group documentation), provided this scope is documented. If set
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# to NO, structs, classes, and unions are shown on a separate page (for HTML and
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Man pages) or section (for LaTeX and RTF).
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraINLINE_SIMPLE_STRUCTS = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# enum is documented as struct, union, or enum with the name of the typedef. So
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# with name TypeT. When disabled the typedef will appear as a member of a file,
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# namespace, or class. And the struct will be named TypeS. This can typically be
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# useful for C code in case the coding convention dictates that all compound
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# types are typedef'ed and only the typedef is referenced, never the tag name.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickTYPEDEF_HIDES_STRUCT = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# cache is used to resolve symbols given their name and scope. Since this can be
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# an expensive process and often the same symbol appears multiple times in the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# doxygen will become slower. If the cache is too large, memory is wasted. The
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# symbols. At the end of a run doxygen will report the cache usage and suggest
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the optimal cache size from a speed point of view.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Minimum value: 0, maximum value: 9, default value: 0.
046dd19afa905a234191b0434743a85128499c51JabiertxofLOOKUP_CACHE_SIZE = 1
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# Build related configuration options
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# documentation are documented, even if no documentation was available. Private
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# class members and static file members will be hidden unless the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note: This will also disable the warnings about undocumented members that are
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# normally produced when WARNINGS is set to YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickEXTRACT_ALL = YES
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# be included in the documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickEXTRACT_PRIVATE = YES
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# scope will be included in the documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraEXTRACT_PACKAGE = NO
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# included in the documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickEXTRACT_STATIC = YES
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
046dd19afa905a234191b0434743a85128499c51Jabiertxof# locally in source files will be included in the documentation. If set to NO,
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# only classes defined in header files are included. Does not have any effect
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# for Java sources.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickEXTRACT_LOCAL_CLASSES = NO
046dd19afa905a234191b0434743a85128499c51Jabiertxof# This flag is only useful for Objective-C code. If set to YES, local methods,
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# which are defined in the implementation section but not in the interface are
046dd19afa905a234191b0434743a85128499c51Jabiertxof# included in the documentation. If set to NO, only methods in the interface are
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickEXTRACT_LOCAL_METHODS = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If this flag is set to YES, the members of anonymous namespaces will be
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# extracted and appear in the documentation as a namespace called
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# 'anonymous_namespace{file}', where file will be replaced with the base name of
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the file that contains the anonymous namespace. By default anonymous namespace
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickEXTRACT_ANON_NSPACES = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# undocumented members inside documented classes or files. If set to NO these
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# members will be included in the various overviews, but no documentation
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# section is generated. This option has no effect if EXTRACT_ALL is enabled.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickHIDE_UNDOC_MEMBERS = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# undocumented classes that are normally visible in the class hierarchy. If set
046dd19afa905a234191b0434743a85128499c51Jabiertxof# to NO, these classes will be included in the various overviews. This option
046dd19afa905a234191b0434743a85128499c51Jabiertxof# has no effect if EXTRACT_ALL is enabled.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickHIDE_UNDOC_CLASSES = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
046dd19afa905a234191b0434743a85128499c51Jabiertxof# (class|struct|union) declarations. If set to NO, these declarations will be
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# included in the documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickHIDE_FRIEND_COMPOUNDS = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
046dd19afa905a234191b0434743a85128499c51Jabiertxof# documentation blocks found inside the body of a function. If set to NO, these
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# blocks will be appended to the function's detailed documentation block.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickHIDE_IN_BODY_DOCS = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The INTERNAL_DOCS tag determines if documentation that is typed after a
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# \internal command is included. If the tag is set to NO then the documentation
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# will be excluded. Set it to YES to include the internal documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickINTERNAL_DOCS = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
046dd19afa905a234191b0434743a85128499c51Jabiertxof# names in lower-case letters. If set to YES, upper-case letters are also
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# allowed. This is useful if you have classes or files whose names only differ
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# in case and if your file system supports case sensitive file names. Windows
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# and Mac users are advised to set this option to NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: system dependent.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickCASE_SENSE_NAMES = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
046dd19afa905a234191b0434743a85128499c51Jabiertxof# their full class and namespace scopes in the documentation. If set to YES, the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# scope will be hidden.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofHIDE_SCOPE_NAMES = NO
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
046dd19afa905a234191b0434743a85128499c51Jabiertxof# append additional text to a page's title, such as Class Reference. If set to
046dd19afa905a234191b0434743a85128499c51Jabiertxof# YES the compound reference will be hidden.
046dd19afa905a234191b0434743a85128499c51Jabiertxof# The default value is: NO.
046dd19afa905a234191b0434743a85128499c51JabiertxofHIDE_COMPOUND_REFERENCE= NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the files that are included by a file in the documentation of that file.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSHOW_INCLUDE_FILES = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# grouped member an include statement to the documentation, telling the reader
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# which file to include in order to use the member.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer HolmstedtSHOW_GROUPED_MEMB_INC = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# files with double quotes in the documentation rather than with sharp brackets.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraFORCE_LOCAL_INCLUDES = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# documentation for inline members.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickINLINE_INFO = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# (detailed) documentation of file and class members alphabetically by member
046dd19afa905a234191b0434743a85128499c51Jabiertxof# name. If set to NO, the members will appear in declaration order.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSORT_MEMBER_DOCS = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# descriptions of file, namespace and class members alphabetically by member
046dd19afa905a234191b0434743a85128499c51Jabiertxof# name. If set to NO, the members will appear in declaration order. Note that
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# this will also influence the order of the classes in the class list.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSORT_BRIEF_DOCS = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# (brief and detailed) documentation of class members so that constructors and
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# destructors are listed first. If set to NO the constructors will appear in the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# member documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# detailed member documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraSORT_MEMBERS_CTORS_1ST = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# of group names into alphabetical order. If set to NO the group names will
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# appear in their defined order.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSORT_GROUP_NAMES = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# fully-qualified names, including namespaces. If set to NO, the class list will
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# be sorted only by class name, not including the namespace part.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note: This option applies only to the class list, not to the alphabetical
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSORT_BY_SCOPE_NAME = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# type resolution of all parameters of a function it will reject a match between
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the prototype and the implementation of a member function even if there is
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# only one candidate or it is obvious which candidate to choose by doing a
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# accept a match between prototype and implementation in such cases.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraSTRICT_PROTO_MATCHING = NO
046dd19afa905a234191b0434743a85128499c51Jabiertxof# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
046dd19afa905a234191b0434743a85128499c51Jabiertxof# list. This list is created by putting \todo commands in the documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_TODOLIST = YES
046dd19afa905a234191b0434743a85128499c51Jabiertxof# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
046dd19afa905a234191b0434743a85128499c51Jabiertxof# list. This list is created by putting \test commands in the documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_TESTLIST = YES
046dd19afa905a234191b0434743a85128499c51Jabiertxof# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# list. This list is created by putting \bug commands in the documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_BUGLIST = YES
046dd19afa905a234191b0434743a85128499c51Jabiertxof# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the deprecated list. This list is created by putting \deprecated commands in
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_DEPRECATEDLIST= YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The ENABLED_SECTIONS tag can be used to enable conditional documentation
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# sections, marked by \if <section_label> ... \endif and \cond <section_label>
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# ... \endcond blocks.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofENABLED_SECTIONS =
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# initial value of a variable or macro / define can have for it to appear in the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# documentation. If the initializer consists of more lines than specified here
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# it will be hidden. Use a value of 0 to hide initializers completely. The
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# appearance of the value of individual variables and macros / defines can be
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# controlled using \showinitializer or \hideinitializer command in the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# documentation regardless of this setting.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Minimum value: 0, maximum value: 10000, default value: 30.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickMAX_INITIALIZER_LINES = 30
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
046dd19afa905a234191b0434743a85128499c51Jabiertxof# the bottom of the documentation of classes and structs. If set to YES, the
046dd19afa905a234191b0434743a85128499c51Jabiertxof# list will mention the files that were used to generate the documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSHOW_USED_FILES = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# will remove the Files entry from the Quick Index and from the Folder Tree View
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# (if specified).
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSHOW_FILES = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# page. This will remove the Namespaces entry from the Quick Index and from the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Folder Tree View (if specified).
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSHOW_NAMESPACES = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The FILE_VERSION_FILTER tag can be used to specify a program or script that
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# doxygen should invoke to get the current version for each file (typically from
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the version control system). Doxygen will invoke the program by executing (via
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# popen()) the command command input-file, where command is the value of the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# by doxygen. Whatever the program writes to standard output is used as the file
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# version. For an example see the documentation.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofFILE_VERSION_FILTER =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# by doxygen. The layout file controls the global structure of the generated
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# output files in an output format independent way. To create the layout file
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# that represents doxygen's defaults, run doxygen with the -l option. You can
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# optionally specify a file name after the option, if omitted DoxygenLayout.xml
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# will be used as the name of the layout file.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note that if you run doxygen from a directory containing a file called
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# tag is left empty.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofLAYOUT_FILE =
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the reference definitions. This must be a list of .bib files. The .bib
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# extension is automatically appended if omitted. This requires the bibtex tool
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# For LaTeX the style of the bibliography can be controlled using
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# search path. See also \cite for info how to create references.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofCITE_BIB_FILES =
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Configuration options related to warning and progress messages
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The QUIET tag can be used to turn on/off the messages that are generated to
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# standard output by doxygen. If QUIET is set to YES this implies that the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# messages are off.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The WARNINGS tag can be used to turn on/off the warning messages that are
046dd19afa905a234191b0434743a85128499c51Jabiertxof# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# this implies that the warnings are on.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Tip: Turn warnings on while writing the documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickWARNINGS = YES
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# will automatically be disabled.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickWARN_IF_UNDOCUMENTED = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# potential errors in the documentation, such as not documenting some parameters
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# in a documented function, or documenting parameters that don't exist or using
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# markup commands wrongly.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickWARN_IF_DOC_ERROR = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# are documented, but have no documentation for their parameters or return
046dd19afa905a234191b0434743a85128499c51Jabiertxof# value. If set to NO, doxygen will only warn about wrong or incomplete
046dd19afa905a234191b0434743a85128499c51Jabiertxof# parameter documentation, but not about the absence of documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickWARN_NO_PARAMDOC = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The WARN_FORMAT tag determines the format of the warning messages that doxygen
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# can produce. The string should contain the $file, $line, and $text tags, which
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# will be replaced by the file and line number from which the warning originated
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# and the warning text. Optionally the format may contain $version, which will
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# be replaced by the version of the file (if it could be obtained via
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# FILE_VERSION_FILTER)
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: $file:$line: $text.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickWARN_FORMAT = "$file:$line: $text"
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The WARN_LOGFILE tag can be used to specify a file to which warning and error
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# messages should be written. If left blank the output is written to standard
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# error (stderr).
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Configuration options related to the input files
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The INPUT tag is used to specify the files and/or directories that contain
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# documented source files. You may enter file names like myfile.cpp or
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# directories like /usr/src/myproject. Separate the files or directories with
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note: If this tag is empty the current directory is searched.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickINPUT = src
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# This tag can be used to specify the character encoding of the source files
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# documentation (see: http://www.gnu.org/software/libiconv) for the list of
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# possible encodings.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: UTF-8.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickINPUT_ENCODING = UTF-8
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the value of the INPUT tag contains directories, you can use the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# *.h) to filter out the source-files in the directories. If left blank the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# *.qsf, *.as and *.js.
54460428960d068cad943c46773905cfeb741da6Christoffer HolmstedtFILE_PATTERNS = *.cpp \
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The RECURSIVE tag can be used to specify whether or not subdirectories should
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# be searched for input files as well.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickRECURSIVE = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The EXCLUDE tag can be used to specify files and/or directories that should be
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# excluded from the INPUT source files. This way you can easily exclude a
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# subdirectory from a directory tree whose root is specified with the INPUT tag.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Note that relative paths are relative to the directory from which doxygen is
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# directories that are symbolic links (a Unix file system feature) are excluded
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# from the input.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickEXCLUDE_SYMLINKS = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the value of the INPUT tag contains directories, you can use the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# certain files from those directories.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note that the wildcards are matched against the file with absolute path, so to
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# exclude all test directories for example use the pattern */test/*
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofEXCLUDE_PATTERNS =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# (namespaces, classes, functions, etc.) that should be excluded from the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# output. The symbol name can be a fully qualified name, a word, or if the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# wildcard * is used, a substring. Examples: ANamespace, AClass,
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# AClass::ANamespace, ANamespace::*Test
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note that the wildcards are matched against the file with absolute path, so to
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# exclude all test directories use the pattern */test/*
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofEXCLUDE_SYMBOLS =
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The EXAMPLE_PATH tag can be used to specify one or more files or directories
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# that contain example code fragments that are included (see the \include
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofEXAMPLE_PATH =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the value of the EXAMPLE_PATH tag contains directories, you can use the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# *.h) to filter out the source-files in the directories. If left blank all
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# files are included.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofEXAMPLE_PATTERNS =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# searched for input files to be used with the \include or \dontinclude commands
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# irrespective of the value of the RECURSIVE tag.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickEXAMPLE_RECURSIVE = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The IMAGE_PATH tag can be used to specify one or more files or directories
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# that contain images that are to be included in the documentation (see the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# \image command).
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The INPUT_FILTER tag can be used to specify a program that doxygen should
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# invoke to filter for each input file. Doxygen will invoke the filter program
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# by executing (via popen()) the command:
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# <filter> <input-file>
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# name of an input file. Doxygen will then use the output that the filter
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# program writes to standard output. If FILTER_PATTERNS is specified, this tag
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# will be ignored.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note that the filter must not add or remove lines; it is applied before the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# code is scanned, but not when the output code is generated. If lines are added
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# or removed, the anchors will not be placed correctly.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofINPUT_FILTER =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# basis. Doxygen will compare the file name with each pattern and apply the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# filter if there is a match. The filters are a list of the form: pattern=filter
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# patterns match the file name, INPUT_FILTER is applied.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofFILTER_PATTERNS =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
046dd19afa905a234191b0434743a85128499c51Jabiertxof# INPUT_FILTER) will also be used to filter the input files that are used for
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickFILTER_SOURCE_FILES = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# it is also possible to disable source filtering for a specific pattern using
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# *.ext= (so without naming a filter).
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofFILTER_SOURCE_PATTERNS =
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# is part of the input, its contents will be placed on the main page
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# (index.html). This can be useful if you have a project on for instance GitHub
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# and want to reuse the introduction page also for the doxygen output.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofUSE_MDFILE_AS_MAINPAGE =
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Configuration options related to source browsing
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# generated. Documented entities will be cross-referenced with these sources.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note: To get rid of all source code in the generated output, make sure that
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# also VERBATIM_HEADERS is set to NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofSOURCE_BROWSER = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Setting the INLINE_SOURCES tag to YES will include the body of functions,
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# classes and enums directly into the documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickINLINE_SOURCES = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# special comment blocks from generated source code fragments. Normal C, C++ and
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Fortran comments will always remain visible.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSTRIP_CODE_COMMENTS = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# function all documented functions referencing it will be listed.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickREFERENCED_BY_RELATION = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the REFERENCES_RELATION tag is set to YES then for each documented function
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# all documented entities called/used by that function will be listed.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickREFERENCES_RELATION = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
046dd19afa905a234191b0434743a85128499c51Jabiertxof# to YES then the hyperlinks from functions in REFERENCES_RELATION and
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# link to the documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickREFERENCES_LINK_SOURCE = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# source code will show a tooltip with additional information such as prototype,
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# brief description and links to the definition and documentation. Since this
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# will make the HTML file larger and loading of large files a bit slower, you
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# can opt to disable this feature.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag SOURCE_BROWSER is set to YES.
54460428960d068cad943c46773905cfeb741da6Christoffer HolmstedtSOURCE_TOOLTIPS = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the USE_HTAGS tag is set to YES then the references to source code will
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# point to the HTML generated by the htags(1) tool instead of doxygen built-in
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# source browser. The htags tool is part of GNU's global source tagging system
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# (see http://www.gnu.org/software/global/global.html). You will need version
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# 4.8.6 or higher.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# To use it do the following:
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# - Install the latest version of global
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# - Make sure the INPUT points to the root of the source tree
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# - Run doxygen as normal
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Doxygen will invoke htags (and that will in turn invoke gtags), so these
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# tools must be available from the command line (i.e. in the search path).
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The result: instead of the source browser generated by doxygen, the links to
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# source code will now point to the output of htags.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag SOURCE_BROWSER is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickUSE_HTAGS = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# verbatim copy of the header file for each class for which an include is
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# specified. Set to NO to disable this.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# See also: Section \class.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickVERBATIM_HEADERS = NO
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# cost of reduced performance. This can be particularly helpful with template
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# rich C++ code for which doxygen's built-in parser lacks the necessary type
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# information.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# Note: The availability of this option depends on whether or not doxygen was
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# compiled with the --with-libclang option.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# The default value is: NO.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofCLANG_ASSISTED_PARSING = NO
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# If clang assisted parsing is enabled you can provide the compiler with command
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# line options that you would normally use when invoking the compiler. Note that
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# the include paths will already be set by doxygen for the files and directories
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# specified with INPUT and INCLUDE_PATH.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofCLANG_OPTIONS =
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Configuration options related to the alphabetical class index
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# compounds will be generated. Enable this if the project contains a lot of
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# classes, structs, unions or interfaces.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraALPHABETICAL_INDEX = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# which the alphabetical index list will be split.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Minimum value: 1, maximum value: 20, default value: 5.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickCOLS_IN_ALPHA_INDEX = 5
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# In case all classes in a project start with a common prefix, all classes will
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# can be used to specify a prefix (or a list of prefixes) that should be ignored
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# while generating the index headers.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofIGNORE_PREFIX =
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Configuration options related to the HTML output
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_HTML = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default directory is: html.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickHTML_OUTPUT = html
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# generated HTML page (for example: .htm, .php, .asp).
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: .html.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickHTML_FILE_EXTENSION = .html
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# each generated HTML page. If the tag is left blank doxygen will generate a
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# standard header.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# To get valid HTML the header file that includes any scripts and style sheets
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# that doxygen needs, which is dependent on the configuration options used (e.g.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# default header using
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# doxygen -w html new_header.html new_footer.html new_stylesheet.css
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# YourConfigFile
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# and then modify the file new_header.html. See also section "Doxygen usage"
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# for information on how to generate the default header that doxygen normally
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note: The header is subject to change so you typically have to regenerate the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# default header when upgrading to a newer version of doxygen. For a description
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# of the possible markers and block names see the documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofHTML_HEADER =
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# generated HTML page. If the tag is left blank doxygen will generate a standard
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# footer. See HTML_HEADER for more information on how to generate a default
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# footer and what special commands can be used inside the footer. See also
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# section "Doxygen usage" for information on how to generate the default footer
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# that doxygen normally uses.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofHTML_FOOTER =
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# sheet that is used by each HTML page. It can be used to fine-tune the look of
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the HTML output. If left blank doxygen will generate a default style sheet.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# See also section "Doxygen usage" for information on how to generate the style
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# sheet that doxygen normally uses.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# it is more robust and this tag (HTML_STYLESHEET) will in the future become
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofHTML_STYLESHEET =
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# cascading style sheets that are included after the standard style sheets
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# created by doxygen. Using this option one can overrule certain style aspects.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This is preferred over using HTML_STYLESHEET since it does not replace the
046dd19afa905a234191b0434743a85128499c51Jabiertxof# standard style sheet and is therefore more robust against future updates.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# Doxygen will copy the style sheet files to the output directory.
046dd19afa905a234191b0434743a85128499c51Jabiertxof# Note: The order of the extra style sheet files is of importance (e.g. the last
046dd19afa905a234191b0434743a85128499c51Jabiertxof# style sheet in the list overrules the setting of the previous ones in the
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# list). For an example see the documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofHTML_EXTRA_STYLESHEET =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# other source files which should be copied to the HTML output directory. Note
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# that these files will be copied to the base HTML output directory. Use the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# files will be copied as-is; there are no commands or markers available.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofHTML_EXTRA_FILES =
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
046dd19afa905a234191b0434743a85128499c51Jabiertxof# will adjust the colors in the style sheet and background images according to
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# this color. Hue is specified as an angle on a colorwheel, see
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# purple, and 360 is red again.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Minimum value: 0, maximum value: 359, default value: 220.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraHTML_COLORSTYLE_HUE = 220
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# in the HTML output. For a value of 0 the output will use grayscales only. A
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# value of 255 will produce the most vivid colors.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Minimum value: 0, maximum value: 255, default value: 100.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraHTML_COLORSTYLE_SAT = 100
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# luminance component of the colors in the HTML output. Values below 100
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# gradually make the output lighter, whereas values above 100 make the output
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# darker. The value divided by 100 is the actual gamma applied, so 80 represents
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# change the gamma.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Minimum value: 40, maximum value: 240, default value: 80.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraHTML_COLORSTYLE_GAMMA = 80
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# page will contain the date and time when the page was generated. Setting this
046dd19afa905a234191b0434743a85128499c51Jabiertxof# to YES can help to show when doxygen was last run and thus if the
046dd19afa905a234191b0434743a85128499c51Jabiertxof# documentation is up to date.
046dd19afa905a234191b0434743a85128499c51Jabiertxof# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraHTML_TIMESTAMP = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# documentation will contain sections that can be hidden and shown after the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# page has loaded.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickHTML_DYNAMIC_SECTIONS = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# shown in the various tree structured indices initially; the user can expand
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# and collapse entries dynamically later on. Doxygen will expand the tree to
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# such a level that at most the specified number of entries are visible (unless
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# a fully collapsed tree already exceeds this amount). So setting the number of
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# entries 1 will produce a full collapsed tree by default. 0 is a special value
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# representing an infinite number of entries and will result in a full expanded
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# tree by default.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Minimum value: 0, maximum value: 9999, default value: 100.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraHTML_INDEX_NUM_ENTRIES = 100
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the GENERATE_DOCSET tag is set to YES, additional index files will be
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# generated that can be used as input for Apple's Xcode 3 integrated development
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# environment (see: http://developer.apple.com/tools/xcode/), introduced with
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Makefile in the HTML output directory. Running make will produce the docset in
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# that directory and running make install will install the docset in
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# for more information.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_DOCSET = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag determines the name of the docset feed. A documentation feed provides
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# an umbrella under which multiple documentation sets from a single provider
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# (such as a company or product suite) can be grouped.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: Doxygen generated docs.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_DOCSET is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickDOCSET_FEEDNAME = "Doxygen generated docs"
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag specifies a string that should uniquely identify the documentation
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# set bundle. This should be a reverse domain-name style string, e.g.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: org.doxygen.Project.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_DOCSET is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickDOCSET_BUNDLE_ID = org.doxygen.Project
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the documentation publisher. This should be a reverse domain-name style
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# string, e.g. com.mycompany.MyDocSet.documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: org.doxygen.Publisher.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_DOCSET is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraDOCSET_PUBLISHER_ID = org.doxygen.Publisher
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: Publisher.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_DOCSET is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraDOCSET_PUBLISHER_NAME = Publisher
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The HTML Help Workshop contains a compiler that can convert all HTML output
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# files are now used as the Windows 98 help format, and will replace the old
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Windows help format (.hlp) on all Windows platforms in the future. Compressed
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# HTML files also contain an index, a table of contents, and you can search for
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# words in the documentation. The HTML workshop also contains a viewer for
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# compressed HTML files.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_HTMLHELP = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The CHM_FILE tag can be used to specify the file name of the resulting .chm
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# file. You can add a path in front of the file if the result should not be
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# written to the html output directory.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The HHC_LOCATION tag can be used to specify the location (absolute path
046dd19afa905a234191b0434743a85128499c51Jabiertxof# including file name) of the HTML help compiler (hhc.exe). If non-empty,
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# doxygen will try to run the HTML help compiler on the generated index.hhp.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The file has to be specified with full path.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofHHC_LOCATION =
046dd19afa905a234191b0434743a85128499c51Jabiertxof# The GENERATE_CHI flag controls if a separate .chi index file is generated
046dd19afa905a234191b0434743a85128499c51Jabiertxof# (YES) or that it should be included in the master .chm file (NO).
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_CHI = NO
046dd19afa905a234191b0434743a85128499c51Jabiertxof# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# and project file content.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofCHM_INDEX_ENCODING =
046dd19afa905a234191b0434743a85128499c51Jabiertxof# The BINARY_TOC flag controls whether a binary table of contents is generated
046dd19afa905a234191b0434743a85128499c51Jabiertxof# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# enables the Previous and Next buttons.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickBINARY_TOC = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The TOC_EXPAND flag can be set to YES to add extra items for group members to
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the table of contents of the HTML help documentation and to the tree view.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickTOC_EXPAND = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# (.qch) of the generated HTML documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_QHP = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the file name of the resulting .qch file. The path specified is relative to
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the HTML output folder.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_QHP is set to YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Project output. For more information please see Qt Help Project / Namespace
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: org.doxygen.Project.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_QHP is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickQHP_NAMESPACE = org.doxygen.Project
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Help Project output. For more information please see Qt Help Project / Virtual
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: doc.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_QHP is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickQHP_VIRTUAL_FOLDER = doc
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# filter to add. For more information please see Qt Help Project / Custom
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_QHP is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofQHP_CUST_FILTER_NAME =
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# custom filter to add. For more information please see Qt Help Project / Custom
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_QHP is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofQHP_CUST_FILTER_ATTRS =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# project's filter section matches. Qt Help Project / Filter Attributes (see:
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_QHP is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofQHP_SECT_FILTER_ATTRS =
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The QHG_LOCATION tag can be used to specify the location of Qt's
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# generated .qhp file.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_QHP is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofQHG_LOCATION =
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# generated, together with the HTML files, they form an Eclipse help plugin. To
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# install this plugin and make it available under the help contents menu in
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Eclipse, the contents of the directory containing the HTML and XML files needs
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# to be copied into the plugins directory of eclipse. The name of the directory
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# After copying Eclipse needs to be restarted before the help appears.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraGENERATE_ECLIPSEHELP = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# A unique identifier for the Eclipse help plugin. When installing the plugin
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the directory name containing the HTML and XML files should also have this
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# name. Each documentation set should have its own identifier.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: org.doxygen.Project.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraECLIPSE_DOC_ID = org.doxygen.Project
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If you want full control over the layout of the generated HTML pages it might
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# be necessary to disable the index and replace it with your own. The
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# of each HTML page. A value of NO enables the index and the value YES disables
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# it. Since the tabs in the index contain the same information as the navigation
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraDISABLE_INDEX = NO
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# structure should be generated to display hierarchical information. If the tag
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# value is set to YES, a side panel will be generated containing a tree-like
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# index structure (just like the one that is generated for HTML Help). For this
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# to work a browser that supports JavaScript, DHTML, CSS and frames is required
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# (i.e. any modern browser). Windows users are probably better off using the
046dd19afa905a234191b0434743a85128499c51Jabiertxof# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# further fine-tune the look of the index. As an example, the default style
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# sheet generated by doxygen has an example that shows how to put an image at
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the same information as the tab index, you could consider setting
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# DISABLE_INDEX to YES when enabling this option.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofGENERATE_TREEVIEW = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# doxygen will group on one line in the generated HTML documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note that a value of 0 will completely suppress the enum values from appearing
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# in the overview section.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Minimum value: 0, maximum value: 20, default value: 4.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraENUM_VALUES_PER_LINE = 4
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# to set the initial width (in pixels) of the frame in which the tree is shown.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Minimum value: 0, maximum value: 1500, default value: 250.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickTREEVIEW_WIDTH = 250
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# external symbols imported via tag files in a separate window.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraEXT_LINKS_IN_WINDOW = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Use this tag to change the font size of LaTeX formulas included as images in
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the HTML documentation. When you change the font size after a successful
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# doxygen run you need to manually remove any form_*.png images from the HTML
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# output directory to force them to be regenerated.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Minimum value: 8, maximum value: 50, default value: 10.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickFORMULA_FONTSIZE = 10
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Use the FORMULA_TRANPARENT tag to determine whether or not the images
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# generated for formulas are transparent PNGs. Transparent PNGs are not
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# supported properly for IE 6.0, but are supported on all modern browsers.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note that when changing this option you need to delete any form_*.png files in
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the HTML output directory before the changes have effect.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraFORMULA_TRANSPARENT = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# http://www.mathjax.org) which uses client side Javascript for the rendering
046dd19afa905a234191b0434743a85128499c51Jabiertxof# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# installed or if you want to formulas look prettier in the HTML output. When
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# enabled you may also need to install MathJax separately and configure the path
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# to it using the MATHJAX_RELPATH option.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# When MathJax is enabled you can set the default output format to be used for
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the MathJax output. See the MathJax site (see:
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# http://docs.mathjax.org/en/latest/output.html) for more details.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Possible values are: HTML-CSS (which is slower, but has the best
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# compatibility), NativeMML (i.e. MathML) and SVG.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: HTML-CSS.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag USE_MATHJAX is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraMATHJAX_FORMAT = HTML-CSS
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# When MathJax is enabled you need to specify the location relative to the HTML
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# output directory using the MATHJAX_RELPATH option. The destination directory
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# should contain the MathJax.js script. For instance, if the mathjax directory
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# is located at the same level as the HTML output directory, then
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Content Delivery Network so you can quickly see the result without installing
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# MathJax. However, it is strongly recommended to install a local copy of
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# MathJax from http://www.mathjax.org before deployment.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: http://cdn.mathjax.org/mathjax/latest.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag USE_MATHJAX is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraMATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# extension names that should be enabled during MathJax rendering. For example
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag USE_MATHJAX is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofMATHJAX_EXTENSIONS =
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# of code that will be used on startup of the MathJax code. See the MathJax site
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# example see the documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag USE_MATHJAX is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofMATHJAX_CODEFILE =
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the HTML output. The underlying search engine uses javascript and DHTML and
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# should work on any modern browser. Note that when using HTML help
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# there is already a search function so this one should typically be disabled.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# For large projects the javascript based search engine can be slow, then
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# search using the keyboard; to jump to the search box use <access key> + S
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# (what the <access key> is depends on the OS and browser, but it is typically
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# key> to jump into the search results window, the results can be navigated
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the search. The filter options can be selected when the cursor is inside the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# to select a filter and <Enter> or <escape> to activate or cancel the filter
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_HTML is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofSEARCHENGINE = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# implemented using a web server instead of a web client using Javascript. There
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# setting. When disabled, doxygen will generate a PHP script for searching and
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# and searching needs to be provided by external tools. See the section
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# "External Indexing and Searching" for details.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag SEARCHENGINE is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraSERVER_BASED_SEARCH = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# script for searching. Instead the search results are written to an XML file
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# which needs to be processed by an external indexer. Doxygen will invoke an
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# search results.
046dd19afa905a234191b0434743a85128499c51Jabiertxof# Doxygen ships with an example indexer (doxyindexer) and search engine
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# (doxysearch.cgi) which are based on the open source search engine library
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# See the section "External Indexing and Searching" for details.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag SEARCHENGINE is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraEXTERNAL_SEARCH = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The SEARCHENGINE_URL should point to a search engine hosted by a web server
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# which will return the search results when EXTERNAL_SEARCH is enabled.
046dd19afa905a234191b0434743a85128499c51Jabiertxof# Doxygen ships with an example indexer (doxyindexer) and search engine
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# (doxysearch.cgi) which are based on the open source search engine library
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Xapian (see: http://xapian.org/). See the section "External Indexing and
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Searching" for details.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag SEARCHENGINE is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofSEARCHENGINE_URL =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# search data is written to a file for indexing by an external tool. With the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# SEARCHDATA_FILE tag the name of this file can be specified.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default file is: searchdata.xml.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag SEARCHENGINE is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraSEARCHDATA_FILE = searchdata.xml
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# projects and redirect the results back to the right project.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag SEARCHENGINE is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofEXTERNAL_SEARCH_ID =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# projects other than the one defined by this configuration file, but that are
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# all added to the same external search index. Each project needs to have a
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# to a relative location where the documentation can be found. The format is:
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag SEARCHENGINE is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofEXTRA_SEARCH_MAPPINGS =
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Configuration options related to the LaTeX output
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_LATEX = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default directory is: latex.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_LATEX is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickLATEX_OUTPUT = latex
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note that when enabling USE_PDFLATEX this option is only used for generating
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# bitmaps for formulas in the HTML output, but not in the Makefile that is
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# written to the output directory.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default file is: latex.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_LATEX is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickLATEX_CMD_NAME = latex
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# index for LaTeX.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default file is: makeindex.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_LATEX is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickMAKEINDEX_CMD_NAME = makeindex
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# documents. This may be useful for small projects and may help to save some
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# trees in general.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_LATEX is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickCOMPACT_LATEX = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The PAPER_TYPE tag can be used to set the paper type that is used by the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# 14 inches) and executive (7.25 x 10.5 inches).
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: a4.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_LATEX is set to YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# that should be included in the LaTeX output. To get the times font for
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# instance you can specify
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# EXTRA_PACKAGES=times
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If left blank no extra packages will be included.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_LATEX is set to YES.
54460428960d068cad943c46773905cfeb741da6Christoffer HolmstedtEXTRA_PACKAGES = amsmath \
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# generated LaTeX document. The header should contain everything until the first
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# chapter. If it is left blank doxygen will generate a standard header. See
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# section "Doxygen usage" for information on how to let doxygen write the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# default header to a separate file.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note: Only use a user-defined header if you know what you are doing! The
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# following commands have a special meaning inside the header: $title,
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
046dd19afa905a234191b0434743a85128499c51Jabiertxof# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
046dd19afa905a234191b0434743a85128499c51Jabiertxof# string, for the replacement values of the other commands the user is referred
046dd19afa905a234191b0434743a85128499c51Jabiertxof# to HTML_HEADER.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_LATEX is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofLATEX_HEADER =
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# generated LaTeX document. The footer should contain everything after the last
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# chapter. If it is left blank doxygen will generate a standard footer. See
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# LATEX_HEADER for more information on how to generate a default footer and what
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# special commands can be used inside the footer.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note: Only use a user-defined footer if you know what you are doing!
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_LATEX is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofLATEX_FOOTER =
046dd19afa905a234191b0434743a85128499c51Jabiertxof# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
046dd19afa905a234191b0434743a85128499c51Jabiertxof# LaTeX style sheets that are included after the standard style sheets created
046dd19afa905a234191b0434743a85128499c51Jabiertxof# by doxygen. Using this option one can overrule certain style aspects. Doxygen
046dd19afa905a234191b0434743a85128499c51Jabiertxof# will copy the style sheet files to the output directory.
046dd19afa905a234191b0434743a85128499c51Jabiertxof# Note: The order of the extra style sheet files is of importance (e.g. the last
046dd19afa905a234191b0434743a85128499c51Jabiertxof# style sheet in the list overrules the setting of the previous ones in the
046dd19afa905a234191b0434743a85128499c51Jabiertxof# This tag requires that the tag GENERATE_LATEX is set to YES.
046dd19afa905a234191b0434743a85128499c51JabiertxofLATEX_EXTRA_STYLESHEET =
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# other source files which should be copied to the LATEX_OUTPUT output
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# directory. Note that the files will be copied as-is; there are no commands or
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# markers available.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_LATEX is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofLATEX_EXTRA_FILES =
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# contain links (just like the HTML output) instead of page references. This
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# makes the output suitable for online browsing using a PDF viewer.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_LATEX is set to YES.
73af768eaec4951e47383158f988f8951cfbc8d5Vinícius dos Santos OliveiraPDF_HYPERLINKS = NO
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
046dd19afa905a234191b0434743a85128499c51Jabiertxof# the PDF file directly from the LaTeX files. Set this option to YES, to get a
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# higher quality PDF documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_LATEX is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraUSE_PDFLATEX = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# command to the generated LaTeX files. This will instruct LaTeX to keep running
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# if errors occur, instead of asking the user for help. This option is also used
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# when generating formulas in HTML.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_LATEX is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickLATEX_BATCHMODE = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# index chapters (such as File Index, Compound Index, etc.) in the output.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_LATEX is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickLATEX_HIDE_INDICES = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# code with syntax highlighting in the LaTeX output.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note that which sources are shown also depends on other settings such as
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# SOURCE_BROWSER.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_LATEX is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraLATEX_SOURCE_CODE = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# bibliography, e.g. plainnat, or ieeetr. See
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: plain.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_LATEX is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraLATEX_BIB_STYLE = plain
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Configuration options related to the RTF output
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# RTF output is optimized for Word 97 and may not look too pretty with other RTF
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_RTF = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default directory is: rtf.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_RTF is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickRTF_OUTPUT = rtf
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# documents. This may be useful for small projects and may help to save some
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# trees in general.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_RTF is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickCOMPACT_RTF = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# contain hyperlink fields. The RTF file will contain links (just like the HTML
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# output) instead of page references. This makes the output suitable for online
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# browsing using Word or some other Word compatible readers that support those
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note: WordPad (write) and others do not support links.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_RTF is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickRTF_HYPERLINKS = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Load stylesheet definitions from file. Syntax is similar to doxygen's config
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# file, i.e. a series of assignments. You only have to provide replacements,
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# missing definitions are set to their default value.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# See also section "Doxygen usage" for information on how to generate the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# default style sheet that doxygen normally uses.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_RTF is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofRTF_STYLESHEET_FILE =
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Set optional variables used in the generation of an RTF document. Syntax is
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# similar to doxygen's config file. A template extensions file can be generated
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# using doxygen -e rtf extensionFile.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_RTF is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofRTF_EXTENSIONS_FILE =
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
046dd19afa905a234191b0434743a85128499c51Jabiertxof# with syntax highlighting in the RTF output.
046dd19afa905a234191b0434743a85128499c51Jabiertxof# Note that which sources are shown also depends on other settings such as
046dd19afa905a234191b0434743a85128499c51Jabiertxof# SOURCE_BROWSER.
046dd19afa905a234191b0434743a85128499c51Jabiertxof# The default value is: NO.
046dd19afa905a234191b0434743a85128499c51Jabiertxof# This tag requires that the tag GENERATE_RTF is set to YES.
046dd19afa905a234191b0434743a85128499c51JabiertxofRTF_SOURCE_CODE = NO
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Configuration options related to the man page output
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# classes and files.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_MAN = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# it. A directory man3 will be created inside the directory specified by
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default directory is: man.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_MAN is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickMAN_OUTPUT = man
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The MAN_EXTENSION tag determines the extension that is added to the generated
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# man pages. In case the manual section does not start with a number, the number
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: .3.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_MAN is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickMAN_EXTENSION = .3
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# The MAN_SUBDIR tag determines the name of the directory created within
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# MAN_EXTENSION with the initial . removed.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# This tag requires that the tag GENERATE_MAN is set to YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# will generate one additional man file for each entity documented in the real
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# man page(s). These additional files only source the real man page, but without
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# them the man command would be unable to find the correct page.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_MAN is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickMAN_LINKS = NO
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Configuration options related to the XML output
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# captures the structure of the code including all documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_XML = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default directory is: xml.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_XML is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickXML_OUTPUT = xml
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# listings (including syntax highlighting and cross-referencing information) to
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the XML output. Note that enabling this will significantly increase the size
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# of the XML output.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_XML is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickXML_PROGRAMLISTING = YES
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Configuration options related to the DOCBOOK output
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# that can be used to generate PDF.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer HolmstedtGENERATE_DOCBOOK = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default directory is: docbook.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
54460428960d068cad943c46773905cfeb741da6Christoffer HolmstedtDOCBOOK_OUTPUT = docbook
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# program listings (including syntax highlighting and cross-referencing
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# information) to the DOCBOOK output. Note that enabling this will significantly
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# increase the size of the DOCBOOK output.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# The default value is: NO.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofDOCBOOK_PROGRAMLISTING = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt#---------------------------------------------------------------------------
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Configuration options for the AutoGen Definitions output
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt#---------------------------------------------------------------------------
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
046dd19afa905a234191b0434743a85128499c51Jabiertxof# AutoGen Definitions (see http://autogen.sf.net) file that captures the
046dd19afa905a234191b0434743a85128499c51Jabiertxof# structure of the code including all documentation. Note that this feature is
046dd19afa905a234191b0434743a85128499c51Jabiertxof# still experimental and incomplete at the moment.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_AUTOGEN_DEF = NO
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Configuration options related to the Perl module output
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# file that captures the structure of the code including all documentation.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note that this feature is still experimental and incomplete at the moment.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_PERLMOD = NO
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# output from the Perl module output.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_PERLMOD is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickPERLMOD_LATEX = NO
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# formatted so it can be parsed by a human reader. This is useful if you want to
046dd19afa905a234191b0434743a85128499c51Jabiertxof# understand what is going on. On the other hand, if this tag is set to NO, the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# size of the Perl module output will be much smaller and Perl will parse it
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# just the same.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_PERLMOD is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickPERLMOD_PRETTY = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The names of the make variables in the generated doxyrules.make file are
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# so different doxyrules.make files included by the same Makefile don't
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# overwrite each other's variables.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag GENERATE_PERLMOD is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofPERLMOD_MAKEVAR_PREFIX =
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Configuration options related to the preprocessor
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# C-preprocessor directives found in the sources and include files.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickENABLE_PREPROCESSING = YES
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
046dd19afa905a234191b0434743a85128499c51Jabiertxof# in the source code. If set to NO, only conditional compilation will be
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# performed. Macro expansion can be done in a controlled way by setting
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# EXPAND_ONLY_PREDEF to YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickMACRO_EXPANSION = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the macro expansion is limited to the macros specified with the PREDEFINED and
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# EXPAND_AS_DEFINED tags.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickEXPAND_ONLY_PREDEF = NO
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the SEARCH_INCLUDES tag is set to YES, the include files in the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# INCLUDE_PATH will be searched if a #include is found.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSEARCH_INCLUDES = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The INCLUDE_PATH tag can be used to specify one or more directories that
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# contain include files that are not input files but should be processed by the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag SEARCH_INCLUDES is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickINCLUDE_PATH = src
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# patterns (like *.h and *.hpp) to filter out the header-files in the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# directories. If left blank, the patterns specified with FILE_PATTERNS will be
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofINCLUDE_FILE_PATTERNS =
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The PREDEFINED tag can be used to specify one or more macro names that are
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# defined before the preprocessor is started (similar to the -D option of e.g.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# gcc). The argument of the tag is a list of macros of the form: name or
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# is assumed. To prevent a macro definition from being undefined via #undef or
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# recursively expanded use the := operator instead of the = operator.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# tag can be used to specify a list of macro names that should be expanded. The
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# macro definition that is found in the sources will be used. Use the PREDEFINED
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# tag if you want to use a different macro definition that overrules the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# definition found in the source code.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofEXPAND_AS_DEFINED =
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# remove all references to function-like macros that are alone on a line, have
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# an all uppercase name, and do not end with a semicolon. Such function macros
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# are typically used for boiler-plate code, and will confuse the parser if not
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSKIP_FUNCTION_MACROS = YES
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Configuration options related to external references
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The TAGFILES tag can be used to specify one or more tag files. For each tag
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# file the location of the external documentation should be added. The format of
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# a tag file without this location is as follows:
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# TAGFILES = file1 file2 ...
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Adding location for the tag files is done as follows:
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# TAGFILES = file1=loc1 "file2 = loc2" ...
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# where loc1 and loc2 can be relative or absolute paths or URLs. See the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# section "Linking to external documentation" for more information about the use
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# Note: Each tag file must have a unique name (where the name does NOT include
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the path). If a tag file is not located in the directory in which doxygen is
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# run, you must also specify the path to the tagfile here.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# tag file that is based on the input files it reads. See section "Linking to
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# external documentation" for more information about the usage of tag files.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofGENERATE_TAGFILE =
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
046dd19afa905a234191b0434743a85128499c51Jabiertxof# the class index. If set to NO, only the inherited external classes will be
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickALLEXTERNALS = NO
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
046dd19afa905a234191b0434743a85128499c51Jabiertxof# in the modules index. If set to NO, only the current project's groups will be
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickEXTERNAL_GROUPS = YES
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the related pages index. If set to NO, only the current project's pages will
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
54460428960d068cad943c46773905cfeb741da6Christoffer HolmstedtEXTERNAL_PAGES = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The PERL_PATH should be the absolute path and name of the perl script
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# interpreter (i.e. the result of 'which perl').
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default file (with absolute path) is: /usr/bin/perl.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Configuration options related to the dot tool
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# NO turns the diagrams off. Note that this option also works with HAVE_DOT
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# disabled, but it is recommended to install and use dot, since it yields more
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# powerful graphs.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickCLASS_DIAGRAMS = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# You can define message sequence charts within doxygen comments using the \msc
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# command. Doxygen will then run the mscgen tool (see:
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# documentation. The MSCGEN_PATH tag allows you to specify the directory where
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the mscgen tool resides. If left empty the tool is assumed to be found in the
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# default search path.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofMSCGEN_PATH =
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# You can include diagrams made with dia in doxygen documentation. Doxygen will
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# then run dia to produce the diagram and insert it in the documentation. The
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# DIA_PATH tag allows you to specify the directory where the dia binary resides.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If left empty dia is assumed to be found in the default search path.
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If set to YES the inheritance and collaboration graphs will hide inheritance
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# and usage relations if the target is undocumented or is not a class.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickHIDE_UNDOC_RELATIONS = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# available from the path. This tool is part of Graphviz (see:
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Bell Labs. The other options in this section have no effect if this option is
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# The default value is: YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickHAVE_DOT = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# to run in parallel. When set to 0 doxygen will base this on the number of
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# processors available in the system. You can set it explicitly to a value
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# larger than 0 to get control over the balance between CPU load and processing
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Minimum value: 0, maximum value: 32, default value: 0.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraDOT_NUM_THREADS = 0
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# When you want a differently looking font in the dot files that doxygen
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# generates you can specify the font name using DOT_FONTNAME. You need to make
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# sure dot is able to find the font, which can be done by putting it in a
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# standard location or by setting the DOTFONTPATH environment variable or by
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# setting DOT_FONTPATH to the directory containing the font.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: Helvetica.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
046dd19afa905a234191b0434743a85128499c51JabiertxofDOT_FONTNAME = Helvetica
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Minimum value: 4, maximum value: 24, default value: 10.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraDOT_FONTSIZE = 10
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# By default doxygen will tell dot to use the default font as specified with
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the path where dot can find it using this tag.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofDOT_FONTPATH =
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# each documented class showing the direct and indirect inheritance relations.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickCLASS_GRAPH = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# graph for each documented class showing the direct and indirect implementation
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# dependencies (inheritance, containment, and class references variables) of the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# class with other documented classes.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickCOLLABORATION_GRAPH = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# groups, showing the direct groups dependencies.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGROUP_GRAPHS = YES
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# collaboration diagrams in a style similar to the OMG's Unified Modeling
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# Language.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickUML_LOOK = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# class node. If there are many fields or methods and many nodes the graph may
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# number of items for each type to make the size more manageable. Set this to 0
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# for no limit. Note that the threshold may be exceeded by 50% before the limit
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# but if the number exceeds 15, the total amount of fields shown is limited to
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Minimum value: 0, maximum value: 100, default value: 10.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraUML_LIMIT_NUM_FIELDS = 10
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# collaboration graphs will show the relations between templates and their
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickTEMPLATE_RELATIONS = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# YES then doxygen will generate a graph for each documented file showing the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# direct and indirect include dependencies of the file with other documented
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickINCLUDE_GRAPH = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# set to YES then doxygen will generate a graph for each documented file showing
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the direct and indirect include dependencies of the file with other documented
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickINCLUDED_BY_GRAPH = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# dependency graph for every global function or class method.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note that enabling this option will significantly increase the time of a run.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# So in most cases it will be better to enable call graphs for selected
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# functions only using the \callgraph command.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickCALL_GRAPH = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# dependency graph for every global function or class method.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note that enabling this option will significantly increase the time of a run.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# So in most cases it will be better to enable caller graphs for selected
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# functions only using the \callergraph command.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickCALLER_GRAPH = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# hierarchy of all classes instead of a textual one.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGRAPHICAL_HIERARCHY = YES
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# dependencies a directory has on other directories in a graphical way. The
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# dependency relations are determined by the #include relations between the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# files in the directories.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickDIRECTORY_GRAPH = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# generated by dot.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# to make the SVG files visible in IE 9+ (other browsers do not have this
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# gif:cairo:gd, gif:gd, gif:gd:gd and svg.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: png.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickDOT_IMAGE_FORMAT = png
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# enable generation of interactive SVG images that allow zooming and panning.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note that this requires a modern browser other than Internet Explorer. Tested
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# and working are Firefox, Chrome, Safari, and Opera.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the SVG files visible. Older versions of IE do not have SVG support.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraINTERACTIVE_SVG = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The DOT_PATH tag can be used to specify the path where the dot tool can be
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# found. If left blank, it is assumed the dot tool can be found in the path.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The DOTFILE_DIRS tag can be used to specify one or more directories that
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# contain dot files that are included in the documentation (see the \dotfile
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofDOTFILE_DIRS =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The MSCFILE_DIRS tag can be used to specify one or more directories that
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# contain msc files that are included in the documentation (see the \mscfile
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofMSCFILE_DIRS =
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The DIAFILE_DIRS tag can be used to specify one or more directories that
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# contain dia files that are included in the documentation (see the \diafile
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofDIAFILE_DIRS =
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# path where java can find the plantuml.jar file. If left blank, it is assumed
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# PlantUML is not used or called during a preprocessing step. Doxygen will
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# generate a warning when it encounters a \startuml command in this case and
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8Jabiertxof# will not generate output for the diagram.
8d82340cad1d7d76eb46a0bd5845f14421f4e8c8JabiertxofPLANTUML_JAR_PATH =
046dd19afa905a234191b0434743a85128499c51Jabiertxof# When using plantuml, the specified paths are searched for files specified by
046dd19afa905a234191b0434743a85128499c51Jabiertxof# the !include statement in a plantuml block.
046dd19afa905a234191b0434743a85128499c51JabiertxofPLANTUML_INCLUDE_PATH =
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# that will be shown in the graph. If the number of nodes in a graph becomes
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# larger than this value, doxygen will truncate the graph, which is visualized
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# by representing a node as a red box. Note that doxygen if the number of direct
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# children of the root node in a graph is already larger than
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Minimum value: 0, maximum value: 10000, default value: 50.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickDOT_GRAPH_MAX_NODES = 50
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# generated by dot. A depth value of 3 means that only nodes reachable from the
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# root by following a path via at most 3 edges will be shown. Nodes that lay
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# further from the root node will be omitted. Note that setting this option to 1
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# or 2 may greatly reduce the computation time needed for large code bases. Also
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# note that the size of a graph can be further restricted by
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Minimum value: 0, maximum value: 1000, default value: 0.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickMAX_DOT_GRAPH_DEPTH = 0
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# background. This is disabled by default, because dot on Windows does not seem
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# to support this out of the box.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# Warning: Depending on the platform used, enabling this option may lead to
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickDOT_TRANSPARENT = NO
046dd19afa905a234191b0434743a85128499c51Jabiertxof# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# files in one run (i.e. multiple -o and -T options on the command line). This
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# makes dot run faster, but since only newer versions of dot (>1.8.10) support
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# this, this feature is disabled by default.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: NO.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickDOT_MULTI_TARGETS = NO
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# explaining the meaning of the various boxes and arrows in the dot generated
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_LEGEND = YES
046dd19afa905a234191b0434743a85128499c51Jabiertxof# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# files that are used to generate the various graphs.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# The default value is: YES.
54460428960d068cad943c46773905cfeb741da6Christoffer Holmstedt# This tag requires that the tag HAVE_DOT is set to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickDOT_CLEANUP = YES