Blame doc/doxyfile

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