Doxyfile revision 617c72e9bdbdf719e45560ec3ee540bd160f11c4
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Doxyfile 1.8.3.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.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# All text after a hash (#) is considered a comment and will be ignored.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# The format is:
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# TAG = value [value, ...]
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# For lists items can also be appended using:
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# TAG += value [value, ...]
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# 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
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# that follow. The default is UTF-8 which is also the encoding used for all
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# text before the first occurrence of this tag. Doxygen uses libiconv (or the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# iconv built into libc) for the transcoding. See
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# http://www.gnu.org/software/libiconv for the list of possible encodings.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickDOXYFILE_ENCODING = UTF-8
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The PROJECT_NAME tag is a single word (or sequence of words) that should
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# identify the project. Note that if you do not use Doxywizard you need
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# to put quotes around the project name if it contains spaces.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickPROJECT_NAME = inkscape
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The PROJECT_NUMBER tag can be used to enter a project or revision number.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# This could be handy for archiving the generated documentation or
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# if some version control system is used.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Using the PROJECT_BRIEF tag one can provide an optional one line description
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# for a project that appears at the top of each page and should give viewer
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# a quick idea about the purpose of the project. Keep the description short.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraPROJECT_BRIEF = Vector Graphics Editor
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# With the PROJECT_LOGO tag one can specify an logo or icon that is
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# included in the documentation. The maximum height of the logo should not
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# exceed 55 pixels and the maximum width should not exceed 200 pixels.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Doxygen will copy the logo to the output directory.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# base path where the generated documentation will be put.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If a relative path is entered, it will be relative to the location
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# where doxygen was started. If left blank the current directory will be used.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickOUTPUT_DIRECTORY = doxygen
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# 4096 sub-directories (in 2 levels) under the output directory of each output
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# format and will distribute the generated files over these directories.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Enabling this option can be useful when feeding doxygen a huge amount of
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# source files, where putting all generated files in the same directory would
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# otherwise cause performance problems for the file system.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickCREATE_SUBDIRS = 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.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The default language is English, other supported languages are:
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickOUTPUT_LANGUAGE = English
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# include brief member descriptions after the members that are listed in
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the file and class documentation (similar to JavaDoc).
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# Set to NO to disable this.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickBRIEF_MEMBER_DESC = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the brief description of a member or function before the detailed description.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# brief descriptions will be completely suppressed.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickREPEAT_BRIEF = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# This tag implements a quasi-intelligent brief description abbreviator
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# that is used to form the text in various listings. Each string
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# in this list, if found as the leading text of the brief description, will be
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# stripped from the text and the result after processing the whole list, is
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# used as the annotated text. Otherwise, the brief description is used as-is.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If left blank, the following values are used ("$name" is automatically
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# replaced with the name of the entity): "The $name class" "The $name widget"
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# "The $name file" "is" "provides" "specifies" "contains"
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# "represents" "a" "an" "the"
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraABBREVIATE_BRIEF =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Doxygen will generate a detailed section even if there is only a brief
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# description.
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.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickINLINE_INHERITED_MEMB = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# path before files name in the file list and in the header files. If set
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# to NO the shortest path that makes the file name unique will be used.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickFULL_PATH_NAMES = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# can be used to strip a user-defined part of the path. Stripping is
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# only done if one of the specified strings matches the left-hand part of
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the path. The tag can be used to show relative paths in the file list.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If left blank the directory from which doxygen is run is used as the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# path to strip. Note that you specify absolute paths here, but also
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# relative paths, which will be relative from the directory where doxygen is
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraSTRIP_FROM_PATH =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the path mentioned in the documentation of a class, which tells
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the reader which header file to include in order to use a class.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If left blank only the name of the header file containing the class
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# definition is used. Otherwise one should specify the include paths that
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# are normally passed to the compiler using the -I flag.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraSTRIP_FROM_INC_PATH =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# (but less readable) file names. This can be useful if your file system
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# doesn't support long names like on DOS, Mac, or CD-ROM.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSHORT_NAMES = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# will interpret the first line (until the first dot) of a JavaDoc-style
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# comment as the brief description. If set to NO, the JavaDoc
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# comments will behave just like regular Qt-style comments
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# (thus requiring an explicit @brief command for a brief description.)
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickJAVADOC_AUTOBRIEF = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# interpret the first line (until the first dot) of a Qt-style
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# comment as the brief description. If set to NO, the comments
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# will behave just like regular Qt-style comments (thus requiring
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# an explicit \brief command for a brief description.)
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickQT_AUTOBRIEF = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# treat a multi-line C++ special comment block (i.e. a block of //! or ///
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# comments) as a brief description. This used to be the default behaviour.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The new default is to treat a multi-line C++ comment block as a detailed
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# description. Set this tag to YES if you prefer the old behaviour instead.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickMULTILINE_CPP_IS_BRIEF = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# member inherits the documentation from any documented member that it
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# re-implements.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickINHERIT_DOCS = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# a new page for each member. If set to NO, the documentation of a member will
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# be part of the file/class/namespace that contains it.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSEPARATE_MEMBER_PAGES = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The TAB_SIZE tag can be used to set the number of spaces in a tab.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# Doxygen uses this value to replace tabs by spaces in code fragments.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickTAB_SIZE = 4
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# This tag can be used to specify a number of aliases that acts
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# as commands in the documentation. An alias has the form "name=value".
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# For example adding "sideeffect=\par Side Effects:\n" will allow you to
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# put the command \sideeffect (or @sideeffect) in the documentation, which
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# will result in a user-defined paragraph with heading "Side Effects:".
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# You can put \n's in the value part of an alias to insert newlines.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# This tag can be used to specify a number of word-keyword mappings (TCL only).
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# A mapping has the form "name=value". For example adding
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# "class=itcl::class" will allow you to use the command class in the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# itcl::class meaning.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# sources only. Doxygen will then generate output that is more tailored for C.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# For instance, some of the names that are used will be different. The list
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# of all members will be omitted, etc.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickOPTIMIZE_OUTPUT_FOR_C = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# sources only. Doxygen will then generate output that is more tailored for
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Java. For instance, namespaces will be presented as packages, qualified
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# scopes will look different, etc.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickOPTIMIZE_OUTPUT_JAVA = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# sources only. Doxygen will then generate output that is more tailored for
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickOPTIMIZE_FOR_FORTRAN = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# sources. Doxygen will then generate output that is tailored for
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
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# using this tag. The format is ext=language, where ext is a file extension,
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# and language is one of the parsers supported by doxygen: IDL, Java,
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# C++. For instance to make doxygen treat .inc files as Fortran files (default
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# that for custom extensions you also need to set FILE_PATTERNS otherwise the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# files are not read by doxygen.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraEXTENSION_MAPPING =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# comments according to the Markdown format, which allows for more readable
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# documentation. See http://daringfireball.net/projects/markdown/ for details.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The output of markdown processing is further processed by doxygen, so you
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# can mix doxygen, HTML, and XML commands with Markdown formatting.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Disable only in case of backward compatibilities issues.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraMARKDOWN_SUPPORT = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# When enabled doxygen tries to link words that correspond to documented classes,
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# or namespaces to their corresponding documentation. Such a link can be
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# prevented in individual cases by by putting a % sign in front of the word or
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# globally by setting AUTOLINK_SUPPORT to NO.
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
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# to include (a tag file for) the STL sources as input, then you should
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# set this tag to YES in order to let doxygen match functions declarations and
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# func(std::string) {}). This also makes the inheritance and collaboration
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# diagrams that involve STL classes more complete and accurate.
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.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickCPP_CLI_SUPPORT = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Doxygen will parse them like normal C++ but will assume all classes use public
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# instead of private inheritance when no explicit protection keyword is present.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSIP_SUPPORT = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# For Microsoft's IDL there are propget and propput attributes to indicate
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# getter and setter methods for a property. Setting this option to YES (the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# default) will make doxygen replace the get and set methods by a property in
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the documentation. This will only work if the methods are indeed getting or
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# setting a simple type. If this is not the case, or you want to show the
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# methods anyway, you should set this option to NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickIDL_PROPERTY_SUPPORT = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# 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.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickDISTRIBUTE_GROUP_DOC = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the same type (for instance a group of public functions) to be put as a
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# subgroup of that type (e.g. under the Public Functions section). Set it to
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# NO to prevent subgrouping. Alternatively, this can be done per class using
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# the \nosubgrouping command.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSUBGROUPING = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# unions are shown inside the group in which they are included (e.g. using
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# @ingroup) instead of on a separate page (for HTML and Man pages) or
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# section (for LaTeX and RTF).
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraINLINE_GROUPED_CLASSES = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# unions with only public data fields will be shown inline in the documentation
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# of the scope in which they are defined (i.e. file, namespace, or group
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# documentation), provided this scope is documented. If set to NO (the default),
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# structs, classes, and unions are shown on a separate page (for HTML and Man
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# pages) or section (for LaTeX and RTF).
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraINLINE_SIMPLE_STRUCTS = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# 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,
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# namespace, or class. And the struct will be named TypeS. This can typically
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# be 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.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickTYPEDEF_HIDES_STRUCT = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# determine which symbols to keep in memory and which to flush to disk.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# When the cache is full, less often used symbols will be written to disk.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# For small to medium size projects (<1000 input files) the default value is
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# probably good enough. For larger projects a too small cache size can cause
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# doxygen to be busy swapping symbols to and from disk most of the time
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# causing a significant performance penalty.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the system has enough physical memory increasing the cache will improve the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# performance by keeping more symbols in memory. Note that the value works on
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# a logarithmic scale so increasing the size by one will roughly double the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# memory usage. The cache size is given by this formula:
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# corresponding to a cache size of 2^16 = 65536 symbols.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSYMBOL_CACHE_SIZE = 0
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# their name and scope. Since this can be an expensive process and often the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# same symbol appear multiple times in the code, doxygen keeps a cache of
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# pre-resolved symbols. If the cache is too small doxygen will become slower.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the cache is too large, memory is wasted. The cache size is given by this
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# corresponding to a cache size of 2^16 = 65536 symbols.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraLOOKUP_CACHE_SIZE = 0
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# Build related configuration options
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# documentation are documented, even if no documentation was available.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Private class members and static file members will be hidden unless
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickEXTRACT_ALL = YES
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# will be included in the documentation.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickEXTRACT_PRIVATE = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# 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.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraEXTRACT_PACKAGE = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the EXTRACT_STATIC tag is set to YES all static members of a file
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# will be included in the documentation.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickEXTRACT_STATIC = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# defined locally in source files will be included in the documentation.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# If set to NO only classes defined in header files are included.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickEXTRACT_LOCAL_CLASSES = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# This flag is only useful for Objective-C code. When set to YES local
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# methods, which are defined in the implementation section but not in
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the interface are included in the documentation.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# If set to NO (the default) only methods in the interface are included.
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
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# 'anonymous_namespace{file}', where file will be replaced with the base
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# name of the file that contains the anonymous namespace. By default
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# anonymous namespaces are hidden.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickEXTRACT_ANON_NSPACES = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# undocumented members of documented classes, files or namespaces.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If set to NO (the default) these members will be included in the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# various overviews, but no documentation section is generated.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# This option has no effect if EXTRACT_ALL is enabled.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickHIDE_UNDOC_MEMBERS = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# undocumented classes that are normally visible in the class hierarchy.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If set to NO (the default) these classes will be included in the various
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# overviews. This option has no effect if EXTRACT_ALL is enabled.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickHIDE_UNDOC_CLASSES = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# friend (class|struct|union) declarations.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If set to NO (the default) these declarations will be included in the
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# documentation.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickHIDE_FRIEND_COMPOUNDS = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# documentation blocks found inside the body of a function.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If set to NO (the default) these blocks will be appended to the
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# function's detailed documentation block.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickHIDE_IN_BODY_DOCS = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The INTERNAL_DOCS tag determines if documentation
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# that is typed after a \internal command is included. If the tag is set
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# to NO (the default) then the documentation will be excluded.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# Set it to YES to include the internal documentation.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickINTERNAL_DOCS = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# file 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.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickCASE_SENSE_NAMES = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# will show members with their full class and namespace scopes in the
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# documentation. If set to YES the scope will be hidden.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickHIDE_SCOPE_NAMES = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# will put a list of the files that are included by a file in the documentation
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# of that file.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSHOW_INCLUDE_FILES = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# will list include files with double quotes in the documentation
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# rather than with sharp brackets.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraFORCE_LOCAL_INCLUDES = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# is inserted in the documentation for inline members.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickINLINE_INFO = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# will sort the (detailed) documentation of file and class members
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# alphabetically by member name. If set to NO the members will appear in
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# declaration order.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSORT_MEMBER_DOCS = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# brief documentation of file, namespace and class members alphabetically
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# by member name. If set to NO (the default) the members will appear in
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# declaration order.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSORT_BRIEF_DOCS = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# will sort the (brief and detailed) documentation of class members so that
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# constructors and destructors are listed first. If set to NO (the default)
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the constructors will appear in the respective orders defined by
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraSORT_MEMBERS_CTORS_1ST = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# hierarchy of group names into alphabetical order. If set to NO (the default)
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# the group names will appear in their defined order.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSORT_GROUP_NAMES = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# sorted by fully-qualified names, including namespaces. If set to
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# NO (the default), the class list will be sorted only by class name,
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# not including the namespace part.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Note: This option applies only to the class list, not to the
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# alphabetical list.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSORT_BY_SCOPE_NAME = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# do proper type resolution of all parameters of a function it will reject a
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# match between the prototype and the implementation of a member function even
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# if there is only one candidate or it is obvious which candidate to choose
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# will still accept a match between prototype and implementation in such cases.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraSTRICT_PROTO_MATCHING = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The GENERATE_TODOLIST tag can be used to enable (YES) or
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# disable (NO) the todo list. This list is created by putting \todo
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# commands in the documentation.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_TODOLIST = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The GENERATE_TESTLIST tag can be used to enable (YES) or
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# disable (NO) the test list. This list is created by putting \test
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# commands in the documentation.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_TESTLIST = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The GENERATE_BUGLIST tag can be used to enable (YES) or
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# disable (NO) the bug list. This list is created by putting \bug
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# commands in the documentation.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_BUGLIST = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# disable (NO) the deprecated list. This list is created by putting
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# \deprecated commands in the documentation.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_DEPRECATEDLIST= YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The ENABLED_SECTIONS tag can be used to enable conditional
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# documentation sections, marked by \if section-label ... \endif
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# and \cond section-label ... \endcond blocks.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraENABLED_SECTIONS =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the initial value of a variable or macro consists of for it to appear in
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the documentation. If the initializer consists of more lines than specified
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# here it will be hidden. Use a value of 0 to hide initializers completely.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The appearance of the initializer of individual variables and macros in the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# documentation can be controlled using \showinitializer or \hideinitializer
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# command in the documentation regardless of this setting.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickMAX_INITIALIZER_LINES = 30
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# at the bottom of the documentation of classes and structs. If set to YES the
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# list will mention the files that were used to generate the documentation.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSHOW_USED_FILES = YES
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# This will remove the Files entry from the Quick Index and from the
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# Folder Tree View (if specified). The default is YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSHOW_FILES = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Namespaces page.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# This will remove the Namespaces entry from the Quick Index
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# and from the Folder Tree View (if specified). The default 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
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# popen()) the command <command> <input-file>, where <command> is the value of
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# provided by doxygen. Whatever the program writes to standard output
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# is used as the file version. See the manual for examples.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraFILE_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
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# that represents doxygen's defaults, run doxygen with the -l option.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# You can optionally specify a file name after the option, if omitted
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# DoxygenLayout.xml will be used as the name of the layout file.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The CITE_BIB_FILES tag can be used to specify one or more bib files
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# containing the references data. This must be a list of .bib files. The
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# .bib extension is automatically appended if omitted. Using this command
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# requires the bibtex tool to be installed. See also
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# feature you need bibtex and perl available in the search path. Do not use
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# file names with spaces, bibtex cannot handle them.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# configuration options related to warning and progress messages
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The QUIET tag can be used to turn on/off the messages that are generated
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# by doxygen. Possible values are YES and NO. If left blank NO is used.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The WARNINGS tag can be used to turn on/off the warning messages that are
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# generated by doxygen. Possible values are YES and NO. If left blank
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# NO is used.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickWARNINGS = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# automatically be disabled.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickWARN_IF_UNDOCUMENTED = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# potential errors in the documentation, such as not documenting some
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# parameters in a documented function, or documenting parameters that
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# don't exist or using markup commands wrongly.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickWARN_IF_DOC_ERROR = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The WARN_NO_PARAMDOC option can be enabled to get warnings for
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# functions that are documented, but have no documentation for their parameters
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# or return value. If set to NO (the default) doxygen will only warn about
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# wrong or incomplete parameter documentation, but not about the absence of
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# documentation.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickWARN_NO_PARAMDOC = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The WARN_FORMAT tag determines the format of the warning messages that
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# doxygen can produce. The string should contain the $file, $line, and $text
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# tags, which will be replaced by the file and line number from which the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# warning originated and the warning text. Optionally the format may contain
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# $version, which will be replaced by the version of the file (if it could
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# be obtained via FILE_VERSION_FILTER)
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickWARN_FORMAT = "$file:$line: $text"
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The WARN_LOGFILE tag can be used to specify a file to which warning
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# and error messages should be written. If left blank the output is written
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# to stderr.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# configuration options related to the input files
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The INPUT tag can be used to specify the files and/or directories that contain
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# documented source files. You may enter file names like "myfile.cpp" or
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# directories like "/usr/src/myproject". Separate the files or directories
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# with spaces.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickINPUT = src
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# This tag can be used to specify the character encoding of the source files
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# also the default input encoding. Doxygen uses libiconv (or the iconv built
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# the list of possible encodings.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickINPUT_ENCODING = UTF-8
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the value of the INPUT tag contains directories, you can use the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# and *.h) to filter out the source-files in the directories. If left
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# blank the following patterns are tested:
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# *.f90 *.f *.for *.vhd *.vhdl
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickFILE_PATTERNS = *.cpp *.h
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The RECURSIVE tag can be used to turn specify whether or not subdirectories
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# should be searched for input files as well. Possible values are YES and NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# If left blank NO is used.
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.
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
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# certain files from those directories. Note that the wildcards are matched
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# against the file with absolute path, so to exclude all test directories
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# for example use the pattern */test/*
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraEXCLUDE_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
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraEXCLUDE_SYMBOLS =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The EXAMPLE_PATH tag can be used to specify one or more files or
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# directories that contain example code fragments that are included (see
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# the \include command).
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the value of the EXAMPLE_PATH tag contains directories, you can use the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# and *.h) to filter out the source-files in the directories. If left
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# blank all files are included.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraEXAMPLE_PATTERNS =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# searched for input files to be used with the \include or \dontinclude
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# commands irrespective of the value of the RECURSIVE tag.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# Possible values are YES and NO. If left blank NO is used.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickEXAMPLE_RECURSIVE = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The IMAGE_PATH tag can be used to specify one or more files or
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# directories that contain image that are included in the documentation (see
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# the \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
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# by executing (via popen()) the command <filter> <input-file>, where <filter>
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# input file. Doxygen will then use the output that the filter program writes
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# to standard output.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If FILTER_PATTERNS is specified, this tag will be
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Doxygen will compare the file name with each pattern and apply the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# filter if there is a match.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The filters are a list of the form:
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# info on how filters are used. If FILTER_PATTERNS is empty or if
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# non of the patterns match the file name, INPUT_FILTER is applied.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraFILTER_PATTERNS =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# INPUT_FILTER) will be used to filter the input files when producing source
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# files to browse (i.e. when SOURCE_BROWSER is set to YES).
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickFILTER_SOURCE_FILES = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# and it is also possible to disable source filtering for a specific pattern
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# using *.ext= (so without naming a filter). This option only has effect when
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# FILTER_SOURCE_FILES is enabled.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraFILTER_SOURCE_PATTERNS =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# is part of the input, its contents will be placed on the main page (index.html).
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# This can be useful if you have a project on for instance GitHub and want reuse
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the introduction page also for the doxygen output.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraUSE_MDFILE_AS_MAINPAGE =
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# configuration options related to source browsing
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the SOURCE_BROWSER tag is set to YES then a list of source files will
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# be generated. Documented entities will be cross-referenced with these sources.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Note: To get rid of all source code in the generated output, make sure also
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# VERBATIM_HEADERS is set to NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSOURCE_BROWSER = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Setting the INLINE_SOURCES tag to YES will include the body
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# of functions and classes directly in the documentation.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickINLINE_SOURCES = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# doxygen to hide any special comment blocks from generated source code
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# fragments. Normal C, C++ and Fortran comments will always remain visible.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSTRIP_CODE_COMMENTS = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the REFERENCED_BY_RELATION tag is set to YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# then for each documented function all documented
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# functions referencing it will be listed.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickREFERENCED_BY_RELATION = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the REFERENCES_RELATION tag is set to YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# then for each documented function all documented entities
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# called/used by that function will be listed.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickREFERENCES_RELATION = YES
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# link to the source code.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Otherwise they will link to the documentation.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickREFERENCES_LINK_SOURCE = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the USE_HTAGS tag is set to YES then the references to source code
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# will point to the HTML generated by the htags(1) tool instead of doxygen
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# built-in source browser. The htags tool is part of GNU's global source
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# tagging system (see http://www.gnu.org/software/global/global.html). You
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# will need version 4.8.6 or higher.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickUSE_HTAGS = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# will generate a verbatim copy of the header file for each class for
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# which an include is specified. Set to NO to disable this.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickVERBATIM_HEADERS = NO
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# configuration options related to the alphabetical class index
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# of all compounds will be generated. Enable this if the project
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# contains a lot of classes, structs, unions or interfaces.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraALPHABETICAL_INDEX = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# in which this list will be split (can be a number in the range [1..20])
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickCOLS_IN_ALPHA_INDEX = 5
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# In case all classes in a project start with a common prefix, all
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# classes will be put under the same header in the alphabetical index.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# should be ignored while generating the index headers.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# configuration options related to the HTML output
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# generate HTML output.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_HTML = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If a relative path is entered the value of OUTPUT_DIRECTORY will be
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# put in front of it. If left blank `html' will be used as the default path.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickHTML_OUTPUT = html
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# doxygen will generate files with .html extension.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickHTML_FILE_EXTENSION = .html
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The HTML_HEADER tag can be used to specify a personal HTML header for
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# each generated HTML page. If it is left blank doxygen will generate a
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# standard header. Note that when using a custom header you are responsible
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# for the proper inclusion of any scripts and style sheets that doxygen
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# needs, which is dependent on the configuration options used.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# It is advised to generate a default header using "doxygen -w html
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# header.html footer.html stylesheet.css YourConfigFile" and then modify
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# that header. Note that the header is subject to change so you typically
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# have to redo this when upgrading to a newer version of doxygen or when
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# changing the value of configuration settings such as GENERATE_TREEVIEW!
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The HTML_FOOTER tag can be used to specify a personal HTML footer for
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# each generated HTML page. If it is left blank doxygen will generate a
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# standard footer.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# style sheet that is used by each HTML page. It can be used to
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# fine-tune the look of the HTML output. If left blank doxygen will
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# generate a default style sheet. Note that it is recommended to use
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# tag will in the future become obsolete.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraHTML_STYLESHEET =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# user-defined cascading style sheet that is included after the standard
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# style sheets created by doxygen. Using this option one can overrule
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# certain style aspects. This is preferred over using HTML_STYLESHEET
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# since it does not replace the standard style sheet and is therefor more
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# robust against future updates. Doxygen will copy the style sheet file to
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the output directory.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraHTML_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
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# files. In the HTML_STYLESHEET file, use the file name only. Also note that
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the files will be copied as-is; there are no commands or markers available.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraHTML_EXTRA_FILES =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Doxygen will adjust the colors in the style sheet and background images
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# according to this color. Hue is specified as an angle on a colorwheel,
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# see http://en.wikipedia.org/wiki/Hue for more information.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# For instance the value 0 represents red, 60 is yellow, 120 is green,
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The allowed range is 0 to 359.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraHTML_COLORSTYLE_HUE = 220
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the colors in the HTML output. For a value of 0 the output will use
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# grayscales only. A value of 255 will produce the most vivid colors.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraHTML_COLORSTYLE_SAT = 100
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the luminance component of the colors in the HTML output. Values below
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# 100 gradually make the output lighter, whereas values above 100 make
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the output darker. The value divided by 100 is the actual gamma applied,
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# and 100 does not change the gamma.
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
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# page will contain the date and time when the page was generated. Setting
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# this to NO can help when comparing the output of multiple runs.
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.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickHTML_DYNAMIC_SECTIONS = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# entries shown in the various tree structured indices initially; the user
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# can expand and collapse entries dynamically later on. Doxygen will expand
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the tree to such a level that at most the specified number of entries are
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# visible (unless a fully collapsed tree already exceeds this amount).
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# So setting the number of entries 1 will produce a full collapsed tree by
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# default. 0 is a special value representing an infinite number of entries
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# and will result in a full expanded tree by default.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraHTML_INDEX_NUM_ENTRIES = 100
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the GENERATE_DOCSET tag is set to YES, additional index files
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# will be generated that can be used as input for Apple's Xcode 3
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# integrated development environment, introduced with OSX 10.5 (Leopard).
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# To create a documentation set, doxygen will generate a Makefile in the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# HTML output directory. Running make will produce the docset in that
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# directory and running "make install" will install the docset in
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# for more information.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_DOCSET = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# feed. A documentation feed provides an umbrella under which multiple
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# documentation sets from a single provider (such as a company or product suite)
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# can be grouped.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickDOCSET_FEEDNAME = "Doxygen generated docs"
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# should uniquely identify the documentation set bundle. This should be a
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# will append .docset to the name.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickDOCSET_BUNDLE_ID = org.doxygen.Project
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# identify the documentation publisher. This should be a reverse domain-name
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# style string, e.g. com.mycompany.MyDocSet.documentation.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraDOCSET_PUBLISHER_ID = org.doxygen.Publisher
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraDOCSET_PUBLISHER_NAME = Publisher
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the GENERATE_HTMLHELP tag is set to YES, additional index files
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# will be generated that can be used as input for tools like the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# of the generated HTML documentation.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_HTMLHELP = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# be used to specify the file name of the resulting .chm file. You
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# can add a path in front of the file if the result should not be
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# written to the html output directory.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# be used to specify the location (absolute path including file name) of
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# the HTML help compiler on the generated index.hhp.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# controls if a separate .chi index file is generated (YES) or that
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# it should be included in the master .chm file (NO).
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_CHI = NO
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# is used to encode HtmlHelp index (hhk), content (hhc) and project file
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraCHM_INDEX_ENCODING =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# controls whether a binary table of contents is generated (YES) or a
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# normal table of contents (NO) in the .chm file.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickBINARY_TOC = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The TOC_EXPAND flag can be set to YES to add extra items for group members
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# to the contents of the HTML help documentation and to the tree view.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickTOC_EXPAND = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# that can be used as input for Qt's qhelpgenerator to generate a
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Qt Compressed Help (.qch) of the generated HTML documentation.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_QHP = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# be used to specify the file name of the resulting .qch file.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# The path specified is relative to the HTML output folder.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The QHP_NAMESPACE tag specifies the namespace to use when generating
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Qt Help Project output. For more information please see
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# http://doc.trolltech.com/qthelpproject.html#namespace
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickQHP_NAMESPACE = org.doxygen.Project
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Qt Help Project output. For more information please see
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# http://doc.trolltech.com/qthelpproject.html#virtual-folders
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickQHP_VIRTUAL_FOLDER = doc
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# add. For more information please see
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# http://doc.trolltech.com/qthelpproject.html#custom-filters
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraQHP_CUST_FILTER_NAME =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# custom filter to add. For more information please see
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Qt Help Project / Custom Filters</a>.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraQHP_CUST_FILTER_ATTRS =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# filter section matches.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Qt Help Project / Filter Attributes</a>.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraQHP_SECT_FILTER_ATTRS =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# be used to specify the location of Qt's qhelpgenerator.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If non-empty doxygen will try to run qhelpgenerator on the generated
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# will be generated, which together with the HTML files, form an Eclipse help
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# plugin. To install this plugin and make it available under the help contents
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# menu in Eclipse, the contents of the directory containing the HTML and XML
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# files needs to be copied into the plugins directory of eclipse. The name of
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the directory within the plugins directory should be the same as
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the help appears.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraGENERATE_ECLIPSEHELP = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# A unique identifier for the eclipse help plugin. When installing the plugin
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the directory name containing the HTML and XML files should also have
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraECLIPSE_DOC_ID = org.doxygen.Project
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# at top of each HTML page. The value NO (the default) enables the index and
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the value YES disables it. Since the tabs have the same information as the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# navigation tree you can set this option to NO if you already set
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# GENERATE_TREEVIEW to YES.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraDISABLE_INDEX = NO
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# structure should be generated to display hierarchical information.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the tag value is set to YES, a side panel will be generated
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# containing a tree-like index structure (just like the one that
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# is generated for HTML Help). For this to work a browser that supports
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Windows users are probably better off using the HTML help feature.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Since the tree basically has the same information as the tab index you
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# could consider to set DISABLE_INDEX to NO when enabling this option.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_TREEVIEW = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# (range [0,1..20]) that doxygen will group on one line in the generated HTML
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# documentation. Note that a value of 0 will completely suppress the enum
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# values from appearing in the overview section.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraENUM_VALUES_PER_LINE = 4
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# used to set the initial width (in pixels) of the frame in which the tree
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# is shown.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickTREEVIEW_WIDTH = 250
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# links to external symbols imported via tag files in a separate window.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraEXT_LINKS_IN_WINDOW = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Use this tag to change the font size of Latex formulas included
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# as images in the HTML documentation. The default is 10. Note that
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# when you change the font size after a successful doxygen run you need
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# to manually remove any form_*.png images from the HTML output directory
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# to force them to be regenerated.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickFORMULA_FONTSIZE = 10
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Use the FORMULA_TRANPARENT tag to determine whether or not the images
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# generated for formulas are transparent PNGs. Transparent PNGs are
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# not supported properly for IE 6.0, but are supported on all modern browsers.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Note that when changing this option you need to delete any form_*.png files
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# in the HTML output before the changes have effect.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraFORMULA_TRANSPARENT = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# (see http://www.mathjax.org) which uses client side Javascript for the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# rendering instead of using prerendered bitmaps. Use this if you do not
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# have LaTeX installed or if you want to formulas look prettier in the HTML
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# output. When enabled you may also need to install MathJax separately and
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# configure the path to it using the MATHJAX_RELPATH option.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# When MathJax is enabled you can set the default output format to be used for
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# SVG. The default value is HTML-CSS, which is slower, but has the best
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraMATHJAX_FORMAT = HTML-CSS
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# When MathJax is enabled you need to specify the location relative to the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# HTML output directory using the MATHJAX_RELPATH option. The destination
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# directory should contain the MathJax.js script. For instance, if the mathjax
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# directory is located at the same level as the HTML output directory, then
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# MATHJAX_RELPATH should be ../mathjax. The default value points to
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the MathJax Content Delivery Network so you can quickly see the result without
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# installing MathJax.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# However, it is strongly recommended to install a local
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# copy of MathJax from http://www.mathjax.org before deployment.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraMATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# names that should be enabled during MathJax rendering.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraMATHJAX_EXTENSIONS =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# When the SEARCHENGINE tag is enabled doxygen will generate a search box
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# for the HTML output. The underlying search engine uses javascript
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# and DHTML and should work on any modern browser. Note that when using
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# (GENERATE_DOCSET) there is already a search function so this one should
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# typically be disabled. For large projects the javascript based search engine
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraSEARCHENGINE = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# implemented using a web server instead of a web client using Javascript.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# There are two flavours of web server based search depending on the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# searching and an index file used by the script. When EXTERNAL_SEARCH is
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# enabled the indexing and searching needs to be provided by external tools.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# See the manual for details.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraSERVER_BASED_SEARCH = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# When EXTERNAL_SEARCH 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
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# external search engine pointed to by the SEARCHENGINE_URL option to obtain
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the search results. Doxygen ships with an example indexer (doxyindexer) and
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# search engine (doxysearch.cgi) which are based on the open source search engine
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# library Xapian. See the manual for configuration details.
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
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# which will returned the search results when EXTERNAL_SEARCH is enabled.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Doxygen ships with an example search engine (doxysearch) which is based on
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the open source search engine library Xapian. See the manual for configuration
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraSEARCHENGINE_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.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraSEARCHDATA_FILE = searchdata.xml
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# 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.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraEXTERNAL_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
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# of to a relative location where the documentation can be found.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ...
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraEXTRA_SEARCH_MAPPINGS =
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# configuration options related to the LaTeX output
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# generate Latex output.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_LATEX = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If a relative path is entered the value of OUTPUT_DIRECTORY will be
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# put in front of it. If left blank `latex' will be used as the default path.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickLATEX_OUTPUT = latex
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# invoked. If left blank `latex' will be used as the default command name.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Note that when enabling USE_PDFLATEX this option is only used for
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# generating bitmaps for formulas in the HTML output, but not in the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Makefile that is written to the output directory.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickLATEX_CMD_NAME = latex
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# generate index for LaTeX. If left blank `makeindex' will be used as the
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# default command name.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickMAKEINDEX_CMD_NAME = makeindex
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# LaTeX documents. This may be useful for small projects and may help to
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# save some trees in general.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickCOMPACT_LATEX = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The PAPER_TYPE tag can be used to set the paper type that is used
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# by the printer. Possible values are: a4, letter, legal and
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# executive. If left blank a4wide will be used.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# packages that should be included in the LaTeX output.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the generated latex document. The header should contain everything until
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the first chapter. If it is left blank doxygen will generate a
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# standard header. Notice: only use this tag if you know what you are doing!
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the generated latex document. The footer should contain everything after
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the last chapter. If it is left blank doxygen will generate a
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# standard footer. Notice: only use this tag if you know what you are doing!
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# is prepared for conversion to pdf (using ps2pdf). The pdf file will
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# contain links (just like the HTML output) instead of page references
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# This makes the output suitable for online browsing using a pdf viewer.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraPDF_HYPERLINKS = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# plain latex in the generated Makefile. Set this option to YES to get a
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# higher quality PDF documentation.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraUSE_PDFLATEX = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# command to the generated LaTeX files. This will instruct LaTeX to keep
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# running if errors occur, instead of asking the user for help.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# This option is also used when generating formulas in HTML.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickLATEX_BATCHMODE = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If LATEX_HIDE_INDICES is set to YES then doxygen will not
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# include the index chapters (such as File Index, Compound Index, etc.)
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# in the output.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickLATEX_HIDE_INDICES = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If LATEX_SOURCE_CODE is set to YES then doxygen will include
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# source code with syntax highlighting in the LaTeX output.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Note that which sources are shown also depends on other settings
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# such as SOURCE_BROWSER.
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
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# http://en.wikipedia.org/wiki/BibTeX for more info.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraLATEX_BIB_STYLE = plain
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# configuration options related to the RTF output
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The RTF output is optimized for Word 97 and may not look very pretty with
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# other RTF readers or editors.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_RTF = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If a relative path is entered the value of OUTPUT_DIRECTORY will be
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# put in front of it. If left blank `rtf' will be used as the default path.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickRTF_OUTPUT = rtf
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# RTF documents. This may be useful for small projects and may help to
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# save some trees in general.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickCOMPACT_RTF = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# will contain hyperlink fields. The RTF file will
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# contain links (just like the HTML output) instead of page references.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# This makes the output suitable for online browsing using WORD or other
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# programs which support those fields.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# Note: wordpad (write) and others do not support links.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickRTF_HYPERLINKS = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Load style sheet definitions from file. Syntax is similar to doxygen's
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# config file, i.e. a series of assignments. You only have to provide
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# replacements, missing definitions are set to their default value.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraRTF_STYLESHEET_FILE =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Set optional variables used in the generation of an rtf document.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# Syntax is similar to doxygen's config file.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraRTF_EXTENSIONS_FILE =
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# configuration options related to the man page output
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# generate man pages
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_MAN = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The MAN_OUTPUT tag is used to specify where the man pages will be put.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If a relative path is entered the value of OUTPUT_DIRECTORY will be
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# put in front of it. If left blank `man' will be used as the default path.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickMAN_OUTPUT = man
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The MAN_EXTENSION tag determines the extension that is added to
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# the generated man pages (default is the subroutine's section .3)
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickMAN_EXTENSION = .3
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# then it will generate one additional man file for each entity
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# documented in the real man page(s). These additional files
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# only source the real man page, but without them the man command
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# would be unable to find the correct page. The default is NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickMAN_LINKS = NO
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# configuration options related to the XML output
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the GENERATE_XML tag is set to YES Doxygen will
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# generate an XML file that captures the structure of
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# the code including all documentation.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_XML = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The XML_OUTPUT tag is used to specify where the XML pages will be put.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If a relative path is entered the value of OUTPUT_DIRECTORY will be
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# put in front of it. If left blank `xml' will be used as the default path.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickXML_OUTPUT = xml
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The XML_SCHEMA tag can be used to specify an XML schema,
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# which can be used by a validating XML parser to check the
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# syntax of the XML files.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The XML_DTD tag can be used to specify an XML DTD,
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# which can be used by a validating XML parser to check the
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# syntax of the XML files.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# dump the program listings (including syntax highlighting
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# and cross-referencing information) to the XML output. Note that
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# enabling this will significantly increase the size of the XML output.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickXML_PROGRAMLISTING = YES
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# configuration options for the AutoGen Definitions output
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# generate an AutoGen Definitions (see autogen.sf.net) file
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# that captures the structure of the code including all
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# documentation. Note that this feature is still experimental
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# and incomplete at the moment.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_AUTOGEN_DEF = NO
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# configuration options related to the Perl module output
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the GENERATE_PERLMOD tag is set to YES Doxygen will
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# generate a Perl module file that captures the structure of
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the code including all documentation. Note that this
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# feature is still experimental and incomplete at the
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_PERLMOD = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the necessary Makefile rules, Perl scripts and LaTeX code to be able
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# to generate PDF and DVI output from the Perl module output.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickPERLMOD_LATEX = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# nicely formatted so it can be parsed by a human reader.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# if you want to understand what is going on.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# On the other hand, if this
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# tag is set to NO the size of the Perl module output will be much smaller
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# and Perl will parse it just the same.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickPERLMOD_PRETTY = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The names of the make variables in the generated doxyrules.make file
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# This is useful so different doxyrules.make files included by the same
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# Makefile don't overwrite each other's variables.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraPERLMOD_MAKEVAR_PREFIX =
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Configuration options related to the preprocessor
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# evaluate all C-preprocessor directives found in the sources and include
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickENABLE_PREPROCESSING = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# names in the source code. If set to NO (the default) only conditional
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# compilation will be performed. Macro expansion can be done in a controlled
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# way by setting EXPAND_ONLY_PREDEF to YES.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickMACRO_EXPANSION = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# then the macro expansion is limited to the macros specified with the
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# PREDEFINED and EXPAND_AS_DEFINED tags.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickEXPAND_ONLY_PREDEF = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# pointed to by INCLUDE_PATH will be searched when a #include is found.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSEARCH_INCLUDES = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The INCLUDE_PATH tag can be used to specify one or more directories that
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# contain include files that are not input files but should be processed by
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# the preprocessor.
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
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# directories. If left blank, the patterns specified with FILE_PATTERNS will
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraINCLUDE_FILE_PATTERNS =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The PREDEFINED tag can be used to specify one or more macro names that
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# are defined before the preprocessor is started (similar to the -D option of
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# gcc). The argument of the tag is a list of macros of the form: name
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# or name=definition (no spaces). If the definition and the = are
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# omitted =1 is assumed. To prevent a macro definition from being
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# undefined via #undef or recursively expanded use the := operator
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# instead of the = operator.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# this tag can be used to specify a list of macro names that should be expanded.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The macro definition that is found in the sources will be used.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Use the PREDEFINED tag if you want to use a different macro definition that
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# overrules the definition found in the source code.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraEXPAND_AS_DEFINED =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# doxygen's preprocessor will remove all references to function-like macros
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# that are alone on a line, have an all uppercase name, and do not end with a
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# semicolon, because these will confuse the parser if not removed.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickSKIP_FUNCTION_MACROS = YES
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Configuration::additions related to external references
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The TAGFILES option can be used to specify one or more tagfiles. For each
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# tag file the location of the external documentation should be added. The
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# format of 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" ...
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# where "loc1" and "loc2" can be relative or absolute paths
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# or URLs. Note that each tag file must have a unique name (where the name does
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# NOT include the path). If a tag file is not located in the directory in which
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# doxygen is run, you must also specify the path to the tagfile here.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# When a file name is specified after GENERATE_TAGFILE, doxygen will create
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# a tag file that is based on the input files it reads.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraGENERATE_TAGFILE =
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the ALLEXTERNALS tag is set to YES all external classes will be listed
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# in the class index. If set to NO only the inherited external classes
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# will be listed.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickALLEXTERNALS = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# in the modules index. If set to NO, only the current project's groups will
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# be listed.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickEXTERNAL_GROUPS = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The PERL_PATH should be the absolute path and name of the perl script
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# interpreter (i.e. the result of `which perl').
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Configuration options related to the dot tool
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick#---------------------------------------------------------------------------
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# or super classes. Setting the tag to NO turns the diagrams off. Note that
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# this option also works with HAVE_DOT disabled, but it is recommended to
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# install and use dot, since it yields more powerful graphs.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickCLASS_DIAGRAMS = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# You can define message sequence charts within doxygen comments using the \msc
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# command. Doxygen will then run the mscgen tool (see
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# 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.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If set to YES, the inheritance and collaboration graphs will hide
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# inheritance and usage relations if the target is undocumented
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# or is not a class.
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
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# available from the path. This tool is part of Graphviz, a graph visualization
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# toolkit from AT&T and Lucent Bell Labs. The other options in this section
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# have no effect if this option is set to NO (the default)
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickHAVE_DOT = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# allowed to run in parallel. When set to 0 (the default) doxygen will
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# base this on the number of processors available in the system. You can set it
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# explicitly to a value larger than 0 to get control over the balance
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# between CPU load and processing speed.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraDOT_NUM_THREADS = 0
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# By default doxygen will use the Helvetica font for all dot files that
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# doxygen generates. When you want a differently looking font you can specify
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the font name using DOT_FONTNAME. You need to make sure dot is able to find
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the font, which can be done by putting it in a standard location or by setting
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# directory containing the font.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickDOT_FONTNAME = FreeSans
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The default size is 10pt.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraDOT_FONTSIZE = 10
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# By default doxygen will tell dot to use the Helvetica font.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# set the path where dot can find it.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# will generate a graph for each documented class showing the direct and
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# indirect inheritance relations. Setting this tag to YES will force the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# CLASS_DIAGRAMS tag to NO.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickCLASS_GRAPH = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# will generate a graph for each documented class showing the direct and
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# indirect implementation dependencies (inheritance, containment, and
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# class references variables) of the class with other documented classes.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickCOLLABORATION_GRAPH = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# will generate a graph for groups, showing the direct groups dependencies
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGROUP_GRAPHS = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# 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.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickUML_LOOK = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the UML_LOOK tag is enabled, the fields and methods are shown inside
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the class node. If there are many fields or methods and many nodes the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# threshold limits the number of items for each type to make the size more
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# managable. Set this to 0 for no limit. Note that the threshold may be
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# exceeded by 50% before the limit is enforced.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraUML_LIMIT_NUM_FIELDS = 10
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If set to YES, the inheritance and collaboration graphs will show the
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# relations between templates and their instances.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickTEMPLATE_RELATIONS = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# tags are set to YES then doxygen will generate a graph for each documented
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# file showing the direct and indirect include dependencies of the file with
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# other documented files.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickINCLUDE_GRAPH = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# documented header file showing the documented files that directly or
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# indirectly include this file.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickINCLUDED_BY_GRAPH = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the CALL_GRAPH and HAVE_DOT options are set to YES then
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# doxygen will generate a call dependency graph for every global function
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# or class method. Note that enabling this option will significantly increase
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the time of a run. So in most cases it will be better to enable call graphs
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# for selected functions only using the \callgraph command.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickCALL_GRAPH = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# doxygen will generate a caller dependency graph for every global function
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# or class method. Note that enabling this option will significantly increase
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# the time of a run. So in most cases it will be better to enable caller
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# graphs for selected functions only using the \callergraph command.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickCALLER_GRAPH = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# will generate a graphical hierarchy of all classes instead of a textual one.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGRAPHICAL_HIERARCHY = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# then doxygen will show the dependencies a directory has on other directories
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# in a graphical way. The dependency relations are determined by the #include
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# relations between the files in the directories.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickDIRECTORY_GRAPH = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# generated by dot. Possible values are svg, png, jpg, or gif.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If left blank png will be used. If you choose svg you need to set
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# visible in IE 9+ (other browsers do not have this requirement).
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.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Note that this requires a modern browser other than Internet Explorer.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# visible. Older versions of IE do not have SVG support.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos OliveiraINTERACTIVE_SVG = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The tag DOT_PATH 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.
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The DOTFILE_DIRS tag can be used to specify one or more directories that
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# contain dot files that are included in the documentation (see the
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# \dotfile command).
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The MSCFILE_DIRS tag can be used to specify one or more directories that
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# contain msc files that are included in the documentation (see the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# \mscfile command).
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# nodes that will be shown in the graph. If the number of nodes in a graph
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# becomes larger than this value, doxygen will truncate the graph, which is
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# visualized by representing a node as a red box. Note that doxygen if the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# number of direct children of the root node in a graph is already larger than
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickDOT_GRAPH_MAX_NODES = 50
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# graphs generated by dot. A depth value of 3 means that only nodes reachable
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# from the root by following a path via at most 3 edges will be shown. Nodes
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# that lay further from the root node will be omitted. Note that setting this
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# option to 1 or 2 may greatly reduce the computation time needed for large
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# code bases. Also 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.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickMAX_DOT_GRAPH_DEPTH = 0
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# background. This is disabled by default, because dot on Windows does not
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# seem to support this out of the box. Warning: Depending on the platform used,
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# enabling this option may lead to badly anti-aliased labels on the edges of
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# a graph (i.e. they become hard to read).
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickDOT_TRANSPARENT = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# Set the DOT_MULTI_TARGETS tag to YES 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
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# makes dot run faster, but since only newer versions of dot (>1.8.10)
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# support this, this feature is disabled by default.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickDOT_MULTI_TARGETS = NO
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# generate a legend page explaining the meaning of the various boxes and
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# arrows in the dot generated graphs.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickGENERATE_LEGEND = YES
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
617c72e9bdbdf719e45560ec3ee540bd160f11c4Vinícius dos Santos Oliveira# remove the intermediate dot files that are used to generate
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4Nick# the various graphs.
7765ee8964c8ffd7faee9baa0412abeb1ef5b0a4NickDOT_CLEANUP = YES