953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Doxyfile 1.8.5
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This file describes the settings to be used by the documentation system
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# doxygen (www.doxygen.org) for a project.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# All text after a double hash (##) is considered a comment and is placed in
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# front of the TAG it is preceding.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# All text after a single hash (#) is considered a comment and will be ignored.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The format is:
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# TAG = value [value, ...]
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# For lists, items can also be appended using:
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# TAG += value [value, ...]
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Values that contain spaces should be placed between quotes (\" \").
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Project related configuration options
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag specifies the encoding used for all characters in the config file
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# that follow. The default is UTF-8 which is also the encoding used for all text
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# for the list of possible encodings.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: UTF-8.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntDOXYFILE_ENCODING = UTF-8
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# double-quotes, unless you are using Doxywizard) that should identify the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# project for which the documentation is generated. This name is used in the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# title of most generated pages and in a few other places.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: My Project.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntPROJECT_NAME = "LXC"
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# could be handy for archiving the generated documentation or if some version
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# control system is used.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntPROJECT_NUMBER =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Using the PROJECT_BRIEF tag one can provide an optional one line description
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# for a project that appears at the top of each page and should give viewer a
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# quick idea about the purpose of the project. Keep the description short.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntPROJECT_BRIEF =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the documentation. The maximum height of the logo should not exceed 55 pixels
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# to the output directory.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntPROJECT_LOGO =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# into which the generated documentation will be written. If a relative path is
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# entered, it will be relative to the location where doxygen was started. If
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# left blank the current directory will be used.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntOUTPUT_DIRECTORY = .
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# directories (in 2 levels) under the output directory of each output format and
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# will distribute the generated files over these directories. Enabling this
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# option can be useful when feeding doxygen a huge amount of source files, where
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# putting all generated files in the same directory would otherwise causes
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# performance problems for the file system.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntCREATE_SUBDIRS = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The OUTPUT_LANGUAGE tag is used to specify the language in which all
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# documentation generated by doxygen is written. Doxygen will use this
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# information to generate all constant output in the proper language.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi,
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en,
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish,
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Turkish, Ukrainian and Vietnamese.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: English.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntOUTPUT_LANGUAGE = English
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# descriptions after the members that are listed in the file and class
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# documentation (similar to Javadoc). Set to NO to disable this.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntBRIEF_MEMBER_DESC = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# description of a member or function before the detailed description
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# brief descriptions will be completely suppressed.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntREPEAT_BRIEF = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag implements a quasi-intelligent brief description abbreviator that is
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# used to form the text in various listings. Each string in this list, if found
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# as the leading text of the brief description, will be stripped from the text
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# and the result, after processing the whole list, is used as the annotated
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# text. Otherwise, the brief description is used as-is. If left blank, the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# following values are used ($name is automatically replaced with the name of
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the entity):The $name class, The $name widget, The $name file, is, provides,
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# specifies, contains, represents, a, an and the.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntABBREVIATE_BRIEF =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# doxygen will generate a detailed section even if there is only a brief
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# description.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntALWAYS_DETAILED_SEC = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# inherited members of a class in the documentation of that class as if those
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# members were ordinary class members. Constructors, destructors and assignment
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# operators of the base classes will not be shown.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntINLINE_INHERITED_MEMB = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# before files name in the file list and in the header files. If set to NO the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# shortest path that makes the file name unique will be used
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
4167ada83ec9ba89b8cd14e24e14922d959e07ddEvgeni GolovFULL_PATH_NAMES = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Stripping is only done if one of the specified strings matches the left-hand
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# part of the path. The tag can be used to show relative paths in the file list.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If left blank the directory from which doxygen is run is used as the path to
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note that you can specify absolute paths here, but also relative paths, which
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# will be relative from the directory where doxygen is started.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag FULL_PATH_NAMES is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntSTRIP_FROM_PATH =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# path mentioned in the documentation of a class, which tells the reader which
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# header file to include in order to use a class. If left blank only the name of
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the header file containing the class definition is used. Otherwise one should
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# specify the list of include paths that are normally passed to the compiler
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# using the -I flag.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntSTRIP_FROM_INC_PATH =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# less readable) file names. This can be useful is your file systems doesn't
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# support long names like on DOS, Mac, or CD-ROM.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntSHORT_NAMES = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# first line (until the first dot) of a Javadoc-style comment as the brief
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# description. If set to NO, the Javadoc-style will behave just like regular Qt-
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# style comments (thus requiring an explicit @brief command for a brief
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# description.)
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntJAVADOC_AUTOBRIEF = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# line (until the first dot) of a Qt-style comment as the brief description. If
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# requiring an explicit \brief command for a brief description.)
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntQT_AUTOBRIEF = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# a brief description. This used to be the default behavior. The new default is
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# to treat a multi-line C++ comment block as a detailed description. Set this
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# tag to YES if you prefer the old behavior instead.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note that setting this tag to YES also means that rational rose comments are
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# not recognized any more.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntMULTILINE_CPP_IS_BRIEF = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# documentation from any documented member that it re-implements.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntINHERIT_DOCS = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# new page for each member. If set to NO, the documentation of a member will be
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# part of the file/class/namespace that contains it.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntSEPARATE_MEMBER_PAGES = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# uses this value to replace tabs by spaces in code fragments.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Minimum value: 1, maximum value: 16, default value: 4.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag can be used to specify a number of aliases that act as commands in
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the documentation. An alias has the form:
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# For example adding
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# "sideeffect=@par Side Effects:\n"
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# will allow you to put the command \sideeffect (or @sideeffect) in the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# documentation, which will result in a user-defined paragraph with heading
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# "Side Effects:". You can put \n's in the value part of an alias to insert
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag can be used to specify a number of word-keyword mappings (TCL only).
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# A mapping has the form "name=value". For example adding "class=itcl::class"
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# will allow you to use the command class in the itcl::class meaning.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# only. Doxygen will then generate output that is more tailored for C. For
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# instance, some of the names that are used will be different. The list of all
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# members will be omitted, etc.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntOPTIMIZE_OUTPUT_FOR_C = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Python sources only. Doxygen will then generate output that is more tailored
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# for that language. For instance, namespaces will be presented as packages,
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# qualified scopes will look different, etc.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntOPTIMIZE_OUTPUT_JAVA = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# sources. Doxygen will then generate output that is tailored for Fortran.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntOPTIMIZE_FOR_FORTRAN = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# sources. Doxygen will then generate output that is tailored for VHDL.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntOPTIMIZE_OUTPUT_VHDL = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Doxygen selects the parser to use depending on the extension of the files it
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# parses. With this tag you can assign which parser to use for a given
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# extension. Doxygen has a built-in mapping, but you can override or extend it
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# using this tag. The format is ext=language, where ext is a file extension, and
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# (default is Fortran), use: inc=Fortran f=C.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note For files without extension you can use no_extension as a placeholder.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the files are not read by doxygen.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntEXTENSION_MAPPING =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# according to the Markdown format, which allows for more readable
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# documentation. See http://daringfireball.net/projects/markdown/ for details.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The output of markdown processing is further processed by doxygen, so you can
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# case of backward compatibilities issues.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntMARKDOWN_SUPPORT = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# When enabled doxygen tries to link words that correspond to documented
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# classes, or namespaces to their corresponding documentation. Such a link can
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# be prevented in individual cases by by putting a % sign in front of the word
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# or globally by setting AUTOLINK_SUPPORT to NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntAUTOLINK_SUPPORT = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# to include (a tag file for) the STL sources as input, then you should set this
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# tag to YES in order to let doxygen match functions declarations and
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# definitions whose arguments contain STL classes (e.g. func(std::string);
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# versus func(std::string) {}). This also make the inheritance and collaboration
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# diagrams that involve STL classes more complete and accurate.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntBUILTIN_STL_SUPPORT = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If you use Microsoft's C++/CLI language, you should set this option to YES to
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# enable parsing support.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntCPP_CLI_SUPPORT = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# will parse them like normal C++ but will assume all classes use public instead
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# of private inheritance when no explicit protection keyword is present.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntSIP_SUPPORT = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# For Microsoft's IDL there are propget and propput attributes to indicate
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# getter and setter methods for a property. Setting this option to YES will make
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# doxygen to replace the get and set methods by a property in the documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This will only work if the methods are indeed getting or setting a simple
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# type. If this is not the case, or you want to show the methods anyway, you
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# should set this option to NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntIDL_PROPERTY_SUPPORT = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# tag is set to YES, then doxygen will reuse the documentation of the first
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# member in the group (if any) for the other members of the group. By default
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# all members of a group must be documented explicitly.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntDISTRIBUTE_GROUP_DOC = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Set the SUBGROUPING tag to YES to allow class member groups of the same type
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# (for instance a group of public functions) to be put as a subgroup of that
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# type (e.g. under the Public Functions section). Set it to NO to prevent
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# subgrouping. Alternatively, this can be done per class using the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# \nosubgrouping command.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntSUBGROUPING = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# are shown inside the group in which they are included (e.g. using \ingroup)
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note that this feature does not work in combination with
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# SEPARATE_MEMBER_PAGES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntINLINE_GROUPED_CLASSES = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# with only public data fields or simple typedef fields will be shown inline in
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the documentation of the scope in which they are defined (i.e. file,
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# namespace, or group documentation), provided this scope is documented. If set
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# to NO, structs, classes, and unions are shown on a separate page (for HTML and
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Man pages) or section (for LaTeX and RTF).
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntINLINE_SIMPLE_STRUCTS = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# enum is documented as struct, union, or enum with the name of the typedef. So
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# with name TypeT. When disabled the typedef will appear as a member of a file,
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# namespace, or class. And the struct will be named TypeS. This can typically be
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# useful for C code in case the coding convention dictates that all compound
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# types are typedef'ed and only the typedef is referenced, never the tag name.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntTYPEDEF_HIDES_STRUCT = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# cache is used to resolve symbols given their name and scope. Since this can be
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# an expensive process and often the same symbol appears multiple times in the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# doxygen will become slower. If the cache is too large, memory is wasted. The
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# symbols. At the end of a run doxygen will report the cache usage and suggest
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the optimal cache size from a speed point of view.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Minimum value: 0, maximum value: 9, default value: 0.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntLOOKUP_CACHE_SIZE = 0
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Build related configuration options
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# documentation are documented, even if no documentation was available. Private
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# class members and static file members will be hidden unless the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note: This will also disable the warnings about undocumented members that are
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# normally produced when WARNINGS is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntEXTRACT_ALL = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# be included in the documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntEXTRACT_PRIVATE = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# scope will be included in the documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntEXTRACT_PACKAGE = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# included in the documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntEXTRACT_STATIC = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# locally in source files will be included in the documentation. If set to NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# only classes defined in header files are included. Does not have any effect
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# for Java sources.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntEXTRACT_LOCAL_CLASSES = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This flag is only useful for Objective-C code. When set to YES local methods,
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# which are defined in the implementation section but not in the interface are
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# included in the documentation. If set to NO only methods in the interface are
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntEXTRACT_LOCAL_METHODS = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If this flag is set to YES, the members of anonymous namespaces will be
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# extracted and appear in the documentation as a namespace called
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# 'anonymous_namespace{file}', where file will be replaced with the base name of
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the file that contains the anonymous namespace. By default anonymous namespace
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# are hidden.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntEXTRACT_ANON_NSPACES = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# undocumented members inside documented classes or files. If set to NO these
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# members will be included in the various overviews, but no documentation
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# section is generated. This option has no effect if EXTRACT_ALL is enabled.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntHIDE_UNDOC_MEMBERS = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# undocumented classes that are normally visible in the class hierarchy. If set
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# to NO these classes will be included in the various overviews. This option has
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# no effect if EXTRACT_ALL is enabled.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntHIDE_UNDOC_CLASSES = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# (class|struct|union) declarations. If set to NO these declarations will be
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# included in the documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntHIDE_FRIEND_COMPOUNDS = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# documentation blocks found inside the body of a function. If set to NO these
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# blocks will be appended to the function's detailed documentation block.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntHIDE_IN_BODY_DOCS = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The INTERNAL_DOCS tag determines if documentation that is typed after a
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# \internal command is included. If the tag is set to NO then the documentation
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# will be excluded. Set it to YES to include the internal documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntINTERNAL_DOCS = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# names in lower-case letters. If set to YES upper-case letters are also
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# allowed. This is useful if you have classes or files whose names only differ
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# in case and if your file system supports case sensitive file names. Windows
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# and Mac users are advised to set this option to NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: system dependent.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntCASE_SENSE_NAMES = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# their full class and namespace scopes in the documentation. If set to YES the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# scope will be hidden.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntHIDE_SCOPE_NAMES = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the files that are included by a file in the documentation of that file.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntSHOW_INCLUDE_FILES = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# files with double quotes in the documentation rather than with sharp brackets.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntFORCE_LOCAL_INCLUDES = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# documentation for inline members.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntINLINE_INFO = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# (detailed) documentation of file and class members alphabetically by member
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# name. If set to NO the members will appear in declaration order.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntSORT_MEMBER_DOCS = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# descriptions of file, namespace and class members alphabetically by member
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# name. If set to NO the members will appear in declaration order.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntSORT_BRIEF_DOCS = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# (brief and detailed) documentation of class members so that constructors and
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# destructors are listed first. If set to NO the constructors will appear in the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# member documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# detailed member documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntSORT_MEMBERS_CTORS_1ST = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# of group names into alphabetical order. If set to NO the group names will
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# appear in their defined order.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntSORT_GROUP_NAMES = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# fully-qualified names, including namespaces. If set to NO, the class list will
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# be sorted only by class name, not including the namespace part.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note: This option applies only to the class list, not to the alphabetical
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntSORT_BY_SCOPE_NAME = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# type resolution of all parameters of a function it will reject a match between
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the prototype and the implementation of a member function even if there is
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# only one candidate or it is obvious which candidate to choose by doing a
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# accept a match between prototype and implementation in such cases.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntSTRICT_PROTO_MATCHING = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# todo list. This list is created by putting \todo commands in the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntGENERATE_TODOLIST = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# test list. This list is created by putting \test commands in the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntGENERATE_TESTLIST = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# list. This list is created by putting \bug commands in the documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntGENERATE_BUGLIST = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the deprecated list. This list is created by putting \deprecated commands in
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntGENERATE_DEPRECATEDLIST= YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The ENABLED_SECTIONS tag can be used to enable conditional documentation
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# sections, marked by \if <section_label> ... \endif and \cond <section_label>
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# ... \endcond blocks.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntENABLED_SECTIONS =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# initial value of a variable or macro / define can have for it to appear in the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# documentation. If the initializer consists of more lines than specified here
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# it will be hidden. Use a value of 0 to hide initializers completely. The
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# appearance of the value of individual variables and macros / defines can be
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# controlled using \showinitializer or \hideinitializer command in the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# documentation regardless of this setting.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Minimum value: 0, maximum value: 10000, default value: 30.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntMAX_INITIALIZER_LINES = 30
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the bottom of the documentation of classes and structs. If set to YES the list
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# will mention the files that were used to generate the documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntSHOW_USED_FILES = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# will remove the Files entry from the Quick Index and from the Folder Tree View
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# (if specified).
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntSHOW_FILES = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# page. This will remove the Namespaces entry from the Quick Index and from the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Folder Tree View (if specified).
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntSHOW_NAMESPACES = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The FILE_VERSION_FILTER tag can be used to specify a program or script that
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# doxygen should invoke to get the current version for each file (typically from
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the version control system). Doxygen will invoke the program by executing (via
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# popen()) the command command input-file, where command is the value of the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# by doxygen. Whatever the program writes to standard output is used as the file
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# version. For an example see the documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntFILE_VERSION_FILTER =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# by doxygen. The layout file controls the global structure of the generated
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# output files in an output format independent way. To create the layout file
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# that represents doxygen's defaults, run doxygen with the -l option. You can
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# optionally specify a file name after the option, if omitted DoxygenLayout.xml
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# will be used as the name of the layout file.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note that if you run doxygen from a directory containing a file called
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# tag is left empty.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntLAYOUT_FILE =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the reference definitions. This must be a list of .bib files. The .bib
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# extension is automatically appended if omitted. This requires the bibtex tool
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# For LaTeX the style of the bibliography can be controlled using
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# search path. Do not use file names with spaces, bibtex cannot handle them. See
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# also \cite for info how to create references.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntCITE_BIB_FILES =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Configuration options related to warning and progress messages
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The QUIET tag can be used to turn on/off the messages that are generated to
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# standard output by doxygen. If QUIET is set to YES this implies that the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# messages are off.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The WARNINGS tag can be used to turn on/off the warning messages that are
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# this implies that the warnings are on.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Tip: Turn warnings on while writing the documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntWARNINGS = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# will automatically be disabled.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntWARN_IF_UNDOCUMENTED = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# potential errors in the documentation, such as not documenting some parameters
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# in a documented function, or documenting parameters that don't exist or using
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# markup commands wrongly.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntWARN_IF_DOC_ERROR = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# are documented, but have no documentation for their parameters or return
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# value. If set to NO doxygen will only warn about wrong or incomplete parameter
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# documentation, but not about the absence of documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntWARN_NO_PARAMDOC = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The WARN_FORMAT tag determines the format of the warning messages that doxygen
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# can produce. The string should contain the $file, $line, and $text tags, which
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# will be replaced by the file and line number from which the warning originated
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# and the warning text. Optionally the format may contain $version, which will
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# be replaced by the version of the file (if it could be obtained via
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# FILE_VERSION_FILTER)
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: $file:$line: $text.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntWARN_FORMAT = "$file:$line: $text"
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The WARN_LOGFILE tag can be used to specify a file to which warning and error
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# messages should be written. If left blank the output is written to standard
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# error (stderr).
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntWARN_LOGFILE =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Configuration options related to the input files
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The INPUT tag is used to specify the files and/or directories that contain
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# documented source files. You may enter file names like myfile.cpp or
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# directories like /usr/src/myproject. Separate the files or directories with
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note: If this tag is empty the current directory is searched.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag can be used to specify the character encoding of the source files
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# documentation (see: http://www.gnu.org/software/libiconv) for the list of
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# possible encodings.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: UTF-8.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntINPUT_ENCODING = UTF-8
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the value of the INPUT tag contains directories, you can use the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# *.h) to filter out the source-files in the directories. If left blank the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# *.qsf, *.as and *.js.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntFILE_PATTERNS = *.h
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The RECURSIVE tag can be used to specify whether or not subdirectories should
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# be searched for input files as well.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntRECURSIVE = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The EXCLUDE tag can be used to specify files and/or directories that should be
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# excluded from the INPUT source files. This way you can easily exclude a
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# subdirectory from a directory tree whose root is specified with the INPUT tag.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note that relative paths are relative to the directory from which doxygen is
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# directories that are symbolic links (a Unix file system feature) are excluded
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# from the input.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntEXCLUDE_SYMLINKS = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the value of the INPUT tag contains directories, you can use the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# certain files from those directories.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note that the wildcards are matched against the file with absolute path, so to
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# exclude all test directories for example use the pattern */test/*
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntEXCLUDE_PATTERNS =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# (namespaces, classes, functions, etc.) that should be excluded from the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# output. The symbol name can be a fully qualified name, a word, or if the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# wildcard * is used, a substring. Examples: ANamespace, AClass,
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# AClass::ANamespace, ANamespace::*Test
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note that the wildcards are matched against the file with absolute path, so to
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# exclude all test directories use the pattern */test/*
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntEXCLUDE_SYMBOLS =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The EXAMPLE_PATH tag can be used to specify one or more files or directories
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# that contain example code fragments that are included (see the \include
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntEXAMPLE_PATH =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the value of the EXAMPLE_PATH tag contains directories, you can use the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# *.h) to filter out the source-files in the directories. If left blank all
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# files are included.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntEXAMPLE_PATTERNS =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# searched for input files to be used with the \include or \dontinclude commands
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# irrespective of the value of the RECURSIVE tag.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntEXAMPLE_RECURSIVE = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The IMAGE_PATH tag can be used to specify one or more files or directories
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# that contain images that are to be included in the documentation (see the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# \image command).
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The INPUT_FILTER tag can be used to specify a program that doxygen should
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# invoke to filter for each input file. Doxygen will invoke the filter program
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# by executing (via popen()) the command:
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# <filter> <input-file>
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# name of an input file. Doxygen will then use the output that the filter
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# program writes to standard output. If FILTER_PATTERNS is specified, this tag
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# will be ignored.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note that the filter must not add or remove lines; it is applied before the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# code is scanned, but not when the output code is generated. If lines are added
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# or removed, the anchors will not be placed correctly.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntINPUT_FILTER =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# basis. Doxygen will compare the file name with each pattern and apply the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# filter if there is a match. The filters are a list of the form: pattern=filter
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# patterns match the file name, INPUT_FILTER is applied.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntFILTER_PATTERNS =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# INPUT_FILTER ) will also be used to filter the input files that are used for
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntFILTER_SOURCE_FILES = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# it is also possible to disable source filtering for a specific pattern using
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# *.ext= (so without naming a filter).
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntFILTER_SOURCE_PATTERNS =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# is part of the input, its contents will be placed on the main page
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# (index.html). This can be useful if you have a project on for instance GitHub
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# and want to reuse the introduction page also for the doxygen output.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntUSE_MDFILE_AS_MAINPAGE =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Configuration options related to source browsing
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# generated. Documented entities will be cross-referenced with these sources.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note: To get rid of all source code in the generated output, make sure that
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# also VERBATIM_HEADERS is set to NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntSOURCE_BROWSER = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Setting the INLINE_SOURCES tag to YES will include the body of functions,
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# classes and enums directly into the documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntINLINE_SOURCES = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# special comment blocks from generated source code fragments. Normal C, C++ and
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Fortran comments will always remain visible.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntSTRIP_CODE_COMMENTS = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# function all documented functions referencing it will be listed.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntREFERENCED_BY_RELATION = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the REFERENCES_RELATION tag is set to YES then for each documented function
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# all documented entities called/used by that function will be listed.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntREFERENCES_RELATION = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# link to the documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntREFERENCES_LINK_SOURCE = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# source code will show a tooltip with additional information such as prototype,
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# brief description and links to the definition and documentation. Since this
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# will make the HTML file larger and loading of large files a bit slower, you
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# can opt to disable this feature.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag SOURCE_BROWSER is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntSOURCE_TOOLTIPS = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the USE_HTAGS tag is set to YES then the references to source code will
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# point to the HTML generated by the htags(1) tool instead of doxygen built-in
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# source browser. The htags tool is part of GNU's global source tagging system
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# (see http://www.gnu.org/software/global/global.html). You will need version
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# 4.8.6 or higher.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# To use it do the following:
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# - Install the latest version of global
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# - Make sure the INPUT points to the root of the source tree
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# - Run doxygen as normal
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Doxygen will invoke htags (and that will in turn invoke gtags), so these
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# tools must be available from the command line (i.e. in the search path).
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The result: instead of the source browser generated by doxygen, the links to
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# source code will now point to the output of htags.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag SOURCE_BROWSER is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntUSE_HTAGS = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# verbatim copy of the header file for each class for which an include is
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# specified. Set to NO to disable this.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# See also: Section \class.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntVERBATIM_HEADERS = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Configuration options related to the alphabetical class index
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# compounds will be generated. Enable this if the project contains a lot of
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# classes, structs, unions or interfaces.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntALPHABETICAL_INDEX = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# which the alphabetical index list will be split.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Minimum value: 1, maximum value: 20, default value: 5.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntCOLS_IN_ALPHA_INDEX = 5
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# In case all classes in a project start with a common prefix, all classes will
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# can be used to specify a prefix (or a list of prefixes) that should be ignored
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# while generating the index headers.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntIGNORE_PREFIX =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Configuration options related to the HTML output
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntGENERATE_HTML = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default directory is: html.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntHTML_OUTPUT = html
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# generated HTML page (for example: .htm, .php, .asp).
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: .html.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntHTML_FILE_EXTENSION = .html
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# each generated HTML page. If the tag is left blank doxygen will generate a
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# standard header.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# To get valid HTML the header file that includes any scripts and style sheets
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# that doxygen needs, which is dependent on the configuration options used (e.g.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# default header using
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# doxygen -w html new_header.html new_footer.html new_stylesheet.css
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# YourConfigFile
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# and then modify the file new_header.html. See also section "Doxygen usage"
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# for information on how to generate the default header that doxygen normally
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note: The header is subject to change so you typically have to regenerate the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# default header when upgrading to a newer version of doxygen. For a description
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# of the possible markers and block names see the documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntHTML_HEADER =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# generated HTML page. If the tag is left blank doxygen will generate a standard
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# footer. See HTML_HEADER for more information on how to generate a default
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# footer and what special commands can be used inside the footer. See also
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# section "Doxygen usage" for information on how to generate the default footer
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# that doxygen normally uses.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntHTML_FOOTER =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# sheet that is used by each HTML page. It can be used to fine-tune the look of
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the HTML output. If left blank doxygen will generate a default style sheet.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# See also section "Doxygen usage" for information on how to generate the style
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# sheet that doxygen normally uses.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# it is more robust and this tag (HTML_STYLESHEET) will in the future become
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntHTML_STYLESHEET =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# defined cascading style sheet that is included after the standard style sheets
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# created by doxygen. Using this option one can overrule certain style aspects.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This is preferred over using HTML_STYLESHEET since it does not replace the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# standard style sheet and is therefor more robust against future updates.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Doxygen will copy the style sheet file to the output directory. For an example
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# see the documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntHTML_EXTRA_STYLESHEET =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# other source files which should be copied to the HTML output directory. Note
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# that these files will be copied to the base HTML output directory. Use the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# files will be copied as-is; there are no commands or markers available.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntHTML_EXTRA_FILES =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# will adjust the colors in the stylesheet and background images according to
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# this color. Hue is specified as an angle on a colorwheel, see
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# purple, and 360 is red again.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Minimum value: 0, maximum value: 359, default value: 220.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntHTML_COLORSTYLE_HUE = 220
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# in the HTML output. For a value of 0 the output will use grayscales only. A
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# value of 255 will produce the most vivid colors.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Minimum value: 0, maximum value: 255, default value: 100.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntHTML_COLORSTYLE_SAT = 100
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# luminance component of the colors in the HTML output. Values below 100
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# gradually make the output lighter, whereas values above 100 make the output
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# darker. The value divided by 100 is the actual gamma applied, so 80 represents
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# change the gamma.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Minimum value: 40, maximum value: 240, default value: 80.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntHTML_COLORSTYLE_GAMMA = 80
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# page will contain the date and time when the page was generated. Setting this
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# to NO can help when comparing the output of multiple runs.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntHTML_TIMESTAMP = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# documentation will contain sections that can be hidden and shown after the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# page has loaded.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntHTML_DYNAMIC_SECTIONS = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# shown in the various tree structured indices initially; the user can expand
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# and collapse entries dynamically later on. Doxygen will expand the tree to
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# such a level that at most the specified number of entries are visible (unless
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# a fully collapsed tree already exceeds this amount). So setting the number of
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# entries 1 will produce a full collapsed tree by default. 0 is a special value
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# representing an infinite number of entries and will result in a full expanded
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# tree by default.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Minimum value: 0, maximum value: 9999, default value: 100.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntHTML_INDEX_NUM_ENTRIES = 100
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the GENERATE_DOCSET tag is set to YES, additional index files will be
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# generated that can be used as input for Apple's Xcode 3 integrated development
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# environment (see: http://developer.apple.com/tools/xcode/), introduced with
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Makefile in the HTML output directory. Running make will produce the docset in
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# that directory and running make install will install the docset in
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# for more information.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntGENERATE_DOCSET = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag determines the name of the docset feed. A documentation feed provides
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# an umbrella under which multiple documentation sets from a single provider
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# (such as a company or product suite) can be grouped.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: Doxygen generated docs.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_DOCSET is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntDOCSET_FEEDNAME = "Doxygen generated docs"
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag specifies a string that should uniquely identify the documentation
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# set bundle. This should be a reverse domain-name style string, e.g.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: org.doxygen.Project.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_DOCSET is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntDOCSET_BUNDLE_ID = org.doxygen.Project
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the documentation publisher. This should be a reverse domain-name style
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# string, e.g. com.mycompany.MyDocSet.documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: org.doxygen.Publisher.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_DOCSET is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntDOCSET_PUBLISHER_ID = org.doxygen.Publisher
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: Publisher.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_DOCSET is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntDOCSET_PUBLISHER_NAME = Publisher
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The HTML Help Workshop contains a compiler that can convert all HTML output
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# files are now used as the Windows 98 help format, and will replace the old
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Windows help format (.hlp) on all Windows platforms in the future. Compressed
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# HTML files also contain an index, a table of contents, and you can search for
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# words in the documentation. The HTML workshop also contains a viewer for
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# compressed HTML files.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntGENERATE_HTMLHELP = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The CHM_FILE tag can be used to specify the file name of the resulting .chm
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# file. You can add a path in front of the file if the result should not be
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# written to the html output directory.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The HHC_LOCATION tag can be used to specify the location (absolute path
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# including file name) of the HTML help compiler ( hhc.exe). If non-empty
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# doxygen will try to run the HTML help compiler on the generated index.hhp.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The file has to be specified with full path.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntHHC_LOCATION =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The GENERATE_CHI flag controls if a separate .chi index file is generated (
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# YES) or that it should be included in the master .chm file ( NO).
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntGENERATE_CHI = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# and project file content.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntCHM_INDEX_ENCODING =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The BINARY_TOC flag controls whether a binary table of contents is generated (
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# YES) or a normal table of contents ( NO) in the .chm file.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntBINARY_TOC = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The TOC_EXPAND flag can be set to YES to add extra items for group members to
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the table of contents of the HTML help documentation and to the tree view.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntTOC_EXPAND = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# (.qch) of the generated HTML documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntGENERATE_QHP = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the file name of the resulting .qch file. The path specified is relative to
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the HTML output folder.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_QHP is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Project output. For more information please see Qt Help Project / Namespace
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: org.doxygen.Project.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_QHP is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Help Project output. For more information please see Qt Help Project / Virtual
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: doc.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_QHP is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntQHP_VIRTUAL_FOLDER = doc
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# filter to add. For more information please see Qt Help Project / Custom
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_QHP is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntQHP_CUST_FILTER_NAME =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# custom filter to add. For more information please see Qt Help Project / Custom
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_QHP is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntQHP_CUST_FILTER_ATTRS =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# project's filter section matches. Qt Help Project / Filter Attributes (see:
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_QHP is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntQHP_SECT_FILTER_ATTRS =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The QHG_LOCATION tag can be used to specify the location of Qt's
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# generated .qhp file.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_QHP is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntQHG_LOCATION =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# generated, together with the HTML files, they form an Eclipse help plugin. To
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# install this plugin and make it available under the help contents menu in
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Eclipse, the contents of the directory containing the HTML and XML files needs
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# to be copied into the plugins directory of eclipse. The name of the directory
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# After copying Eclipse needs to be restarted before the help appears.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntGENERATE_ECLIPSEHELP = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# A unique identifier for the Eclipse help plugin. When installing the plugin
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the directory name containing the HTML and XML files should also have this
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# name. Each documentation set should have its own identifier.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: org.doxygen.Project.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If you want full control over the layout of the generated HTML pages it might
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# be necessary to disable the index and replace it with your own. The
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# of each HTML page. A value of NO enables the index and the value YES disables
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# it. Since the tabs in the index contain the same information as the navigation
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntDISABLE_INDEX = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# structure should be generated to display hierarchical information. If the tag
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# value is set to YES, a side panel will be generated containing a tree-like
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# index structure (just like the one that is generated for HTML Help). For this
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# to work a browser that supports JavaScript, DHTML, CSS and frames is required
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# (i.e. any modern browser). Windows users are probably better off using the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# further fine-tune the look of the index. As an example, the default style
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# sheet generated by doxygen has an example that shows how to put an image at
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the same information as the tab index, you could consider setting
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# DISABLE_INDEX to YES when enabling this option.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntGENERATE_TREEVIEW = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# doxygen will group on one line in the generated HTML documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note that a value of 0 will completely suppress the enum values from appearing
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# in the overview section.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Minimum value: 0, maximum value: 20, default value: 4.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntENUM_VALUES_PER_LINE = 4
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# to set the initial width (in pixels) of the frame in which the tree is shown.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Minimum value: 0, maximum value: 1500, default value: 250.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntTREEVIEW_WIDTH = 250
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# external symbols imported via tag files in a separate window.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntEXT_LINKS_IN_WINDOW = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Use this tag to change the font size of LaTeX formulas included as images in
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the HTML documentation. When you change the font size after a successful
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# doxygen run you need to manually remove any form_*.png images from the HTML
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# output directory to force them to be regenerated.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Minimum value: 8, maximum value: 50, default value: 10.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntFORMULA_FONTSIZE = 10
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Use the FORMULA_TRANPARENT tag to determine whether or not the images
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# generated for formulas are transparent PNGs. Transparent PNGs are not
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# supported properly for IE 6.0, but are supported on all modern browsers.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note that when changing this option you need to delete any form_*.png files in
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the HTML output directory before the changes have effect.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntFORMULA_TRANSPARENT = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# http://www.mathjax.org) which uses client side Javascript for the rendering
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# instead of using prerendered bitmaps. Use this if you do not have LaTeX
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# installed or if you want to formulas look prettier in the HTML output. When
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# enabled you may also need to install MathJax separately and configure the path
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# to it using the MATHJAX_RELPATH option.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntUSE_MATHJAX = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# When MathJax is enabled you can set the default output format to be used for
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the MathJax output. See the MathJax site (see:
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# http://docs.mathjax.org/en/latest/output.html) for more details.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Possible values are: HTML-CSS (which is slower, but has the best
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# compatibility), NativeMML (i.e. MathML) and SVG.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: HTML-CSS.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag USE_MATHJAX is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntMATHJAX_FORMAT = HTML-CSS
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# When MathJax is enabled you need to specify the location relative to the HTML
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# output directory using the MATHJAX_RELPATH option. The destination directory
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# should contain the MathJax.js script. For instance, if the mathjax directory
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# is located at the same level as the HTML output directory, then
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Content Delivery Network so you can quickly see the result without installing
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# MathJax. However, it is strongly recommended to install a local copy of
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# MathJax from http://www.mathjax.org before deployment.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: http://cdn.mathjax.org/mathjax/latest.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag USE_MATHJAX is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntMATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# extension names that should be enabled during MathJax rendering. For example
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag USE_MATHJAX is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntMATHJAX_EXTENSIONS =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# of code that will be used on startup of the MathJax code. See the MathJax site
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# example see the documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag USE_MATHJAX is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntMATHJAX_CODEFILE =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the HTML output. The underlying search engine uses javascript and DHTML and
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# should work on any modern browser. Note that when using HTML help
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# there is already a search function so this one should typically be disabled.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# For large projects the javascript based search engine can be slow, then
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# search using the keyboard; to jump to the search box use <access key> + S
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# (what the <access key> is depends on the OS and browser, but it is typically
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# key> to jump into the search results window, the results can be navigated
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the search. The filter options can be selected when the cursor is inside the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# to select a filter and <Enter> or <escape> to activate or cancel the filter
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_HTML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntSEARCHENGINE = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# implemented using a web server instead of a web client using Javascript. There
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# are two flavours of web server based searching depending on the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# searching and an index file used by the script. When EXTERNAL_SEARCH is
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# enabled the indexing and searching needs to be provided by external tools. See
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the section "External Indexing and Searching" for details.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag SEARCHENGINE is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntSERVER_BASED_SEARCH = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# script for searching. Instead the search results are written to an XML file
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# which needs to be processed by an external indexer. Doxygen will invoke an
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# search results.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Doxygen ships with an example indexer ( doxyindexer) and search engine
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# (doxysearch.cgi) which are based on the open source search engine library
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Xapian (see: http://xapian.org/).
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# See the section "External Indexing and Searching" for details.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag SEARCHENGINE is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntEXTERNAL_SEARCH = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The SEARCHENGINE_URL should point to a search engine hosted by a web server
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# which will return the search results when EXTERNAL_SEARCH is enabled.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Doxygen ships with an example indexer ( doxyindexer) and search engine
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# (doxysearch.cgi) which are based on the open source search engine library
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Xapian (see: http://xapian.org/). See the section "External Indexing and
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Searching" for details.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag SEARCHENGINE is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntSEARCHENGINE_URL =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# search data is written to a file for indexing by an external tool. With the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# SEARCHDATA_FILE tag the name of this file can be specified.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default file is: searchdata.xml.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag SEARCHENGINE is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntSEARCHDATA_FILE = searchdata.xml
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# projects and redirect the results back to the right project.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag SEARCHENGINE is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntEXTERNAL_SEARCH_ID =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# projects other than the one defined by this configuration file, but that are
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# all added to the same external search index. Each project needs to have a
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# to a relative location where the documentation can be found. The format is:
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag SEARCHENGINE is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntEXTRA_SEARCH_MAPPINGS =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Configuration options related to the LaTeX output
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntGENERATE_LATEX = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default directory is: latex.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_LATEX is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntLATEX_OUTPUT = latex
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note that when enabling USE_PDFLATEX this option is only used for generating
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# bitmaps for formulas in the HTML output, but not in the Makefile that is
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# written to the output directory.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default file is: latex.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_LATEX is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntLATEX_CMD_NAME = latex
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# index for LaTeX.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default file is: makeindex.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_LATEX is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntMAKEINDEX_CMD_NAME = makeindex
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# documents. This may be useful for small projects and may help to save some
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# trees in general.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_LATEX is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntCOMPACT_LATEX = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The PAPER_TYPE tag can be used to set the paper type that is used by the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# 14 inches) and executive (7.25 x 10.5 inches).
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: a4.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_LATEX is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntPAPER_TYPE = a4
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# that should be included in the LaTeX output. To get the times font for
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# instance you can specify
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# EXTRA_PACKAGES=times
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If left blank no extra packages will be included.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_LATEX is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntEXTRA_PACKAGES =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# generated LaTeX document. The header should contain everything until the first
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# chapter. If it is left blank doxygen will generate a standard header. See
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# section "Doxygen usage" for information on how to let doxygen write the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# default header to a separate file.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note: Only use a user-defined header if you know what you are doing! The
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# following commands have a special meaning inside the header: $title,
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# replace them by respectively the title of the page, the current date and time,
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# only the current date, the version number of doxygen, the project name (see
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_LATEX is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntLATEX_HEADER =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# generated LaTeX document. The footer should contain everything after the last
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# chapter. If it is left blank doxygen will generate a standard footer.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note: Only use a user-defined footer if you know what you are doing!
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_LATEX is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntLATEX_FOOTER =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# other source files which should be copied to the LATEX_OUTPUT output
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# directory. Note that the files will be copied as-is; there are no commands or
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# markers available.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_LATEX is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntLATEX_EXTRA_FILES =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# contain links (just like the HTML output) instead of page references. This
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# makes the output suitable for online browsing using a PDF viewer.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_LATEX is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntPDF_HYPERLINKS = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the PDF file directly from the LaTeX files. Set this option to YES to get a
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# higher quality PDF documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_LATEX is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntUSE_PDFLATEX = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# command to the generated LaTeX files. This will instruct LaTeX to keep running
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# if errors occur, instead of asking the user for help. This option is also used
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# when generating formulas in HTML.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_LATEX is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntLATEX_BATCHMODE = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# index chapters (such as File Index, Compound Index, etc.) in the output.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_LATEX is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntLATEX_HIDE_INDICES = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# code with syntax highlighting in the LaTeX output.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note that which sources are shown also depends on other settings such as
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# SOURCE_BROWSER.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_LATEX is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntLATEX_SOURCE_CODE = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# bibliography, e.g. plainnat, or ieeetr. See
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: plain.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_LATEX is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntLATEX_BIB_STYLE = plain
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Configuration options related to the RTF output
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# RTF output is optimized for Word 97 and may not look too pretty with other RTF
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntGENERATE_RTF = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default directory is: rtf.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_RTF is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntRTF_OUTPUT = rtf
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# documents. This may be useful for small projects and may help to save some
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# trees in general.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_RTF is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntCOMPACT_RTF = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# contain hyperlink fields. The RTF file will contain links (just like the HTML
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# output) instead of page references. This makes the output suitable for online
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# browsing using Word or some other Word compatible readers that support those
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note: WordPad (write) and others do not support links.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_RTF is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntRTF_HYPERLINKS = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Load stylesheet definitions from file. Syntax is similar to doxygen's config
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# file, i.e. a series of assignments. You only have to provide replacements,
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# missing definitions are set to their default value.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# See also section "Doxygen usage" for information on how to generate the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# default style sheet that doxygen normally uses.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_RTF is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntRTF_STYLESHEET_FILE =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Set optional variables used in the generation of an RTF document. Syntax is
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# similar to doxygen's config file. A template extensions file can be generated
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# using doxygen -e rtf extensionFile.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_RTF is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntRTF_EXTENSIONS_FILE =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Configuration options related to the man page output
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# classes and files.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntGENERATE_MAN = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# it. A directory man3 will be created inside the directory specified by
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# MAN_OUTPUT.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default directory is: man.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_MAN is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntMAN_OUTPUT = man
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The MAN_EXTENSION tag determines the extension that is added to the generated
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# man pages. In case the manual section does not start with a number, the number
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: .3.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_MAN is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntMAN_EXTENSION = .3
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# will generate one additional man file for each entity documented in the real
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# man page(s). These additional files only source the real man page, but without
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# them the man command would be unable to find the correct page.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_MAN is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntMAN_LINKS = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Configuration options related to the XML output
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# captures the structure of the code including all documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntGENERATE_XML = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default directory is: xml.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_XML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntXML_OUTPUT = xml
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# validating XML parser to check the syntax of the XML files.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_XML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The XML_DTD tag can be used to specify a XML DTD, which can be used by a
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# validating XML parser to check the syntax of the XML files.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_XML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# listings (including syntax highlighting and cross-referencing information) to
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the XML output. Note that enabling this will significantly increase the size
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# of the XML output.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_XML is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntXML_PROGRAMLISTING = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Configuration options related to the DOCBOOK output
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# that can be used to generate PDF.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntGENERATE_DOCBOOK = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# front of it.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default directory is: docbook.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntDOCBOOK_OUTPUT = docbook
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Configuration options for the AutoGen Definitions output
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Definitions (see http://autogen.sf.net) file that captures the structure of
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the code including all documentation. Note that this feature is still
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# experimental and incomplete at the moment.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntGENERATE_AUTOGEN_DEF = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Configuration options related to the Perl module output
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# file that captures the structure of the code including all documentation.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note that this feature is still experimental and incomplete at the moment.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntGENERATE_PERLMOD = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# output from the Perl module output.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_PERLMOD is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntPERLMOD_LATEX = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# formatted so it can be parsed by a human reader. This is useful if you want to
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# understand what is going on. On the other hand, if this tag is set to NO the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# size of the Perl module output will be much smaller and Perl will parse it
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# just the same.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_PERLMOD is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntPERLMOD_PRETTY = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The names of the make variables in the generated doxyrules.make file are
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# so different doxyrules.make files included by the same Makefile don't
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# overwrite each other's variables.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag GENERATE_PERLMOD is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntPERLMOD_MAKEVAR_PREFIX =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Configuration options related to the preprocessor
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# C-preprocessor directives found in the sources and include files.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntENABLE_PREPROCESSING = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# in the source code. If set to NO only conditional compilation will be
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# performed. Macro expansion can be done in a controlled way by setting
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# EXPAND_ONLY_PREDEF to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntMACRO_EXPANSION = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the macro expansion is limited to the macros specified with the PREDEFINED and
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# EXPAND_AS_DEFINED tags.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntEXPAND_ONLY_PREDEF = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the SEARCH_INCLUDES tag is set to YES the includes files in the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# INCLUDE_PATH will be searched if a #include is found.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntSEARCH_INCLUDES = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The INCLUDE_PATH tag can be used to specify one or more directories that
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# contain include files that are not input files but should be processed by the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# preprocessor.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag SEARCH_INCLUDES is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# patterns (like *.h and *.hpp) to filter out the header-files in the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# directories. If left blank, the patterns specified with FILE_PATTERNS will be
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntINCLUDE_FILE_PATTERNS =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The PREDEFINED tag can be used to specify one or more macro names that are
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# defined before the preprocessor is started (similar to the -D option of e.g.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# gcc). The argument of the tag is a list of macros of the form: name or
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# is assumed. To prevent a macro definition from being undefined via #undef or
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# recursively expanded use the := operator instead of the = operator.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# tag can be used to specify a list of macro names that should be expanded. The
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# macro definition that is found in the sources will be used. Use the PREDEFINED
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# tag if you want to use a different macro definition that overrules the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# definition found in the source code.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntEXPAND_AS_DEFINED =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
ec64264d78d4ed608553842ce9e1f07eeab2a032Veres Lajos# remove all references to function-like macros that are alone on a line, have an
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# all uppercase name, and do not end with a semicolon. Such function macros are
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# typically used for boiler-plate code, and will confuse the parser if not
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntSKIP_FUNCTION_MACROS = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Configuration options related to external references
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The TAGFILES tag can be used to specify one or more tag files. For each tag
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# file the location of the external documentation should be added. The format of
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# a tag file without this location is as follows:
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# TAGFILES = file1 file2 ...
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Adding location for the tag files is done as follows:
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# TAGFILES = file1=loc1 "file2 = loc2" ...
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# where loc1 and loc2 can be relative or absolute paths or URLs. See the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# section "Linking to external documentation" for more information about the use
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# of tag files.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note: Each tag file must have an unique name (where the name does NOT include
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the path). If a tag file is not located in the directory in which doxygen is
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# run, you must also specify the path to the tagfile here.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# tag file that is based on the input files it reads. See section "Linking to
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# external documentation" for more information about the usage of tag files.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntGENERATE_TAGFILE =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# class index. If set to NO only the inherited external classes will be listed.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntALLEXTERNALS = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the modules index. If set to NO, only the current project's groups will be
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntEXTERNAL_GROUPS = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the related pages index. If set to NO, only the current project's pages will
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntEXTERNAL_PAGES = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The PERL_PATH should be the absolute path and name of the perl script
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# interpreter (i.e. the result of 'which perl').
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default file (with absolute path) is: /usr/bin/perl.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Configuration options related to the dot tool
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt#---------------------------------------------------------------------------
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# NO turns the diagrams off. Note that this option also works with HAVE_DOT
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# disabled, but it is recommended to install and use dot, since it yields more
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# powerful graphs.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntCLASS_DIAGRAMS = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# You can define message sequence charts within doxygen comments using the \msc
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# command. Doxygen will then run the mscgen tool (see:
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# documentation. The MSCGEN_PATH tag allows you to specify the directory where
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the mscgen tool resides. If left empty the tool is assumed to be found in the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# default search path.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntMSCGEN_PATH =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If set to YES, the inheritance and collaboration graphs will hide inheritance
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# and usage relations if the target is undocumented or is not a class.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntHIDE_UNDOC_RELATIONS = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# available from the path. This tool is part of Graphviz (see:
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Bell Labs. The other options in this section have no effect if this option is
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntHAVE_DOT = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# to run in parallel. When set to 0 doxygen will base this on the number of
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# processors available in the system. You can set it explicitly to a value
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# larger than 0 to get control over the balance between CPU load and processing
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Minimum value: 0, maximum value: 32, default value: 0.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntDOT_NUM_THREADS = 0
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# When you want a differently looking font n the dot files that doxygen
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# generates you can specify the font name using DOT_FONTNAME. You need to make
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# sure dot is able to find the font, which can be done by putting it in a
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# standard location or by setting the DOTFONTPATH environment variable or by
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# setting DOT_FONTPATH to the directory containing the font.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: Helvetica.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntDOT_FONTNAME = Ubuntu
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# dot graphs.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Minimum value: 4, maximum value: 24, default value: 10.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntDOT_FONTSIZE = 10
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# By default doxygen will tell dot to use the default font as specified with
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the path where dot can find it using this tag.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntDOT_FONTPATH =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# each documented class showing the direct and indirect inheritance relations.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntCLASS_GRAPH = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# graph for each documented class showing the direct and indirect implementation
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# dependencies (inheritance, containment, and class references variables) of the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# class with other documented classes.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntCOLLABORATION_GRAPH = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# groups, showing the direct groups dependencies.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntGROUP_GRAPHS = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# collaboration diagrams in a style similar to the OMG's Unified Modeling
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntUML_LOOK = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# class node. If there are many fields or methods and many nodes the graph may
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# number of items for each type to make the size more manageable. Set this to 0
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# for no limit. Note that the threshold may be exceeded by 50% before the limit
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# but if the number exceeds 15, the total amount of fields shown is limited to
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Minimum value: 0, maximum value: 100, default value: 10.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntUML_LIMIT_NUM_FIELDS = 10
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# collaboration graphs will show the relations between templates and their
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntTEMPLATE_RELATIONS = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# YES then doxygen will generate a graph for each documented file showing the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# direct and indirect include dependencies of the file with other documented
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntINCLUDE_GRAPH = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# set to YES then doxygen will generate a graph for each documented file showing
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the direct and indirect include dependencies of the file with other documented
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntINCLUDED_BY_GRAPH = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# dependency graph for every global function or class method.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note that enabling this option will significantly increase the time of a run.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# So in most cases it will be better to enable call graphs for selected
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# functions only using the \callgraph command.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntCALL_GRAPH = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# dependency graph for every global function or class method.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note that enabling this option will significantly increase the time of a run.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# So in most cases it will be better to enable caller graphs for selected
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# functions only using the \callergraph command.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntCALLER_GRAPH = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# hierarchy of all classes instead of a textual one.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntGRAPHICAL_HIERARCHY = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# dependencies a directory has on other directories in a graphical way. The
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# dependency relations are determined by the #include relations between the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# files in the directories.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntDIRECTORY_GRAPH = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# generated by dot.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# to make the SVG files visible in IE 9+ (other browsers do not have this
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# requirement).
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Possible values are: png, jpg, gif and svg.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: png.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntDOT_IMAGE_FORMAT = png
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# enable generation of interactive SVG images that allow zooming and panning.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note that this requires a modern browser other than Internet Explorer. Tested
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# and working are Firefox, Chrome, Safari, and Opera.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the SVG files visible. Older versions of IE do not have SVG support.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntINTERACTIVE_SVG = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The DOT_PATH tag can be used to specify the path where the dot tool can be
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# found. If left blank, it is assumed the dot tool can be found in the path.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The DOTFILE_DIRS tag can be used to specify one or more directories that
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# contain dot files that are included in the documentation (see the \dotfile
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntDOTFILE_DIRS =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The MSCFILE_DIRS tag can be used to specify one or more directories that
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# contain msc files that are included in the documentation (see the \mscfile
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntMSCFILE_DIRS =
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# that will be shown in the graph. If the number of nodes in a graph becomes
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# larger than this value, doxygen will truncate the graph, which is visualized
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# by representing a node as a red box. Note that doxygen if the number of direct
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# children of the root node in a graph is already larger than
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Minimum value: 0, maximum value: 10000, default value: 50.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntDOT_GRAPH_MAX_NODES = 50
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# generated by dot. A depth value of 3 means that only nodes reachable from the
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# root by following a path via at most 3 edges will be shown. Nodes that lay
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# further from the root node will be omitted. Note that setting this option to 1
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# or 2 may greatly reduce the computation time needed for large code bases. Also
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# note that the size of a graph can be further restricted by
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Minimum value: 0, maximum value: 1000, default value: 0.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntMAX_DOT_GRAPH_DEPTH = 0
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# background. This is disabled by default, because dot on Windows does not seem
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# to support this out of the box.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Warning: Depending on the platform used, enabling this option may lead to
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntDOT_TRANSPARENT = NO
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# files in one run (i.e. multiple -o and -T options on the command line). This
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# makes dot run faster, but since only newer versions of dot (>1.8.10) support
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# this, this feature is disabled by default.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: NO.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntDOT_MULTI_TARGETS = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# explaining the meaning of the various boxes and arrows in the dot generated
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntGENERATE_LEGEND = YES
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# files that are used to generate the various graphs.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# The default value is: YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames Hunt# This tag requires that the tag HAVE_DOT is set to YES.
953e611ceabed9ccf986e0b234379c2af4bb331aJames HuntDOT_CLEANUP = YES