|
Packit |
16808d |
# Doxyfile 1.3.6
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# This file describes the settings to be used by the documentation system
|
|
Packit |
16808d |
# doxygen (www.doxygen.org) for a project
|
|
Packit |
16808d |
#
|
|
Packit |
16808d |
# All text after a hash (#) is considered a comment and will be ignored
|
|
Packit |
16808d |
# The format is:
|
|
Packit |
16808d |
# TAG = value [value, ...]
|
|
Packit |
16808d |
# For lists items can also be appended using:
|
|
Packit |
16808d |
# TAG += value [value, ...]
|
|
Packit |
16808d |
# Values that contain spaces should be placed between quotes (" ")
|
|
Packit |
16808d |
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
# Project related configuration options
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
|
|
Packit |
16808d |
# by quotes) that should identify the project.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
PROJECT_NAME = @PACKAGE@
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
|
|
Packit |
16808d |
# This could be handy for archiving the generated documentation or
|
|
Packit |
16808d |
# if some version control system is used.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
PROJECT_NUMBER = @VERSION@
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
|
|
Packit |
16808d |
# base path where the generated documentation will be put.
|
|
Packit |
16808d |
# If a relative path is entered, it will be relative to the location
|
|
Packit |
16808d |
# where doxygen was started. If left blank the current directory will be used.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
OUTPUT_DIRECTORY =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
|
|
Packit |
16808d |
# documentation generated by doxygen is written. Doxygen will use this
|
|
Packit |
16808d |
# information to generate all constant output in the proper language.
|
|
Packit |
16808d |
# The default language is English, other supported languages are:
|
|
Packit |
16808d |
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech,
|
|
Packit |
16808d |
# Danish, Dutch, Finnish, French, German, Greek, Hungarian, Italian,
|
|
Packit |
16808d |
# Japanese, Japanese-en (Japanese with English messages), Korean,
|
|
Packit |
16808d |
# Korean-en, Norwegian, Polish, Portuguese, Romanian, Russian,
|
|
Packit |
16808d |
# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
OUTPUT_LANGUAGE = English
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# This tag can be used to specify the encoding used in the generated
|
|
Packit |
16808d |
# output. The encoding is not always determined by the language that
|
|
Packit |
16808d |
# is chosen, but also whether or not the output is meant for Windows
|
|
Packit |
16808d |
# or non-Windows users. In case there is a difference, setting the
|
|
Packit |
16808d |
# USE_WINDOWS_ENCODING tag to YES forces the Windows encoding (this is
|
|
Packit |
16808d |
# the default for the Windows binary), whereas setting the tag to NO
|
|
Packit |
16808d |
# uses a Unix-style encoding (the default for all platforms other than
|
|
Packit |
16808d |
# Windows).
|
|
Packit |
16808d |
|
|
Packit |
16808d |
USE_WINDOWS_ENCODING = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
|
|
Packit |
16808d |
# include brief member descriptions after the members that are listed in
|
|
Packit |
16808d |
# the file and class documentation (similar to JavaDoc).
|
|
Packit |
16808d |
# Set to NO to disable this.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
BRIEF_MEMBER_DESC = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will
|
|
Packit |
16808d |
# prepend the brief description of a member or function before the
|
|
Packit |
16808d |
# detailed description. Note: if both HIDE_UNDOC_MEMBERS and
|
|
Packit |
16808d |
# BRIEF_MEMBER_DESC are set to NO, the brief descriptions will be
|
|
Packit |
16808d |
# completely suppressed.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
REPEAT_BRIEF = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# This tag implements a quasi-intelligent brief description
|
|
Packit |
16808d |
# abbreviator that is used to form the text in various listings. Each
|
|
Packit |
16808d |
# string in this list, if found as the leading text of the brief
|
|
Packit |
16808d |
# description, will be stripped from the text and the result after
|
|
Packit |
16808d |
# processing the whole list, is used as the annotated text. Otherwise,
|
|
Packit |
16808d |
# the brief description is used as-is. If left blank, the following
|
|
Packit |
16808d |
# values are used ("$name" is automatically replaced with the name of
|
|
Packit |
16808d |
# the entity): "The $name class" "The $name widget" "The $name file"
|
|
Packit |
16808d |
# "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
|
|
Packit |
16808d |
|
|
Packit |
16808d |
ABBREVIATE_BRIEF =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
|
|
Packit |
16808d |
# Doxygen will generate a detailed section even if there is only a brief
|
|
Packit |
16808d |
# description.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
ALWAYS_DETAILED_SEC = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show
|
|
Packit |
16808d |
# all inherited members of a class in the documentation of that class
|
|
Packit |
16808d |
# as if those members were ordinary class members. Constructors,
|
|
Packit |
16808d |
# destructors and assignment operators of the base classes will not be
|
|
Packit |
16808d |
# shown.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
INLINE_INHERITED_MEMB = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
|
|
Packit |
16808d |
# path before files name in the file list and in the header files. If set
|
|
Packit |
16808d |
# to NO the shortest path that makes the file name unique will be used.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
FULL_PATH_NAMES = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
|
|
Packit |
16808d |
# can be used to strip a user-defined part of the path. Stripping is
|
|
Packit |
16808d |
# only done if one of the specified strings matches the left-hand part of
|
|
Packit |
16808d |
# the path. It is allowed to use relative paths in the argument list.
|
|
Packit |
16808d |
# If left blank the directory from which doxygen is run is used as the
|
|
Packit |
16808d |
# path to strip.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
STRIP_FROM_PATH =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
|
|
Packit |
16808d |
# (but less readable) file names. This can be useful is your file systems
|
|
Packit |
16808d |
# doesn't support long names like on DOS, Mac, or CD-ROM.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
SHORT_NAMES = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
|
|
Packit |
16808d |
# will interpret the first line (until the first dot) of a JavaDoc-style
|
|
Packit |
16808d |
# comment as the brief description. If set to NO, the JavaDoc
|
|
Packit |
16808d |
# comments will behave just like the Qt-style comments (thus requiring an
|
|
Packit |
16808d |
# explicit @brief command for a brief description.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
JAVADOC_AUTOBRIEF = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
|
|
Packit |
16808d |
# treat a multi-line C++ special comment block (i.e. a block of //! or
|
|
Packit |
16808d |
# /// comments) as a brief description. This used to be the default
|
|
Packit |
16808d |
# behaviour. The new default is to treat a multi-line C++ comment
|
|
Packit |
16808d |
# block as a detailed description. Set this tag to YES if you prefer
|
|
Packit |
16808d |
# the old behaviour instead.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
MULTILINE_CPP_IS_BRIEF = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
|
|
Packit |
16808d |
# will output the detailed description near the top, like JavaDoc.
|
|
Packit |
16808d |
# If set to NO, the detailed description appears after the member
|
|
Packit |
16808d |
# documentation.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
DETAILS_AT_TOP = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
|
|
Packit |
16808d |
# member inherits the documentation from any documented member that it
|
|
Packit |
16808d |
# re-implements.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
INHERIT_DOCS = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If member grouping is used in the documentation and the
|
|
Packit |
16808d |
# DISTRIBUTE_GROUP_DOC tag is set to YES, then doxygen will reuse the
|
|
Packit |
16808d |
# documentation of the first member in the group (if any) for the
|
|
Packit |
16808d |
# other members of the group. By default all members of a group must
|
|
Packit |
16808d |
# be documented explicitly.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
DISTRIBUTE_GROUP_DOC = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
|
|
Packit |
16808d |
# Doxygen uses this value to replace tabs by spaces in code fragments.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
TAB_SIZE = 8
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# This tag can be used to specify a number of aliases that acts
|
|
Packit |
16808d |
# as commands in the documentation. An alias has the form "name=value".
|
|
Packit |
16808d |
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
|
|
Packit |
16808d |
# put the command \sideeffect (or @sideeffect) in the documentation, which
|
|
Packit |
16808d |
# will result in a user-defined paragraph with heading "Side Effects:".
|
|
Packit |
16808d |
# You can put \n's in the value part of an alias to insert newlines.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
ALIASES =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of
|
|
Packit |
16808d |
# C sources only. Doxygen will then generate output that is more
|
|
Packit |
16808d |
# tailored for C. For instance, some of the names that are used will
|
|
Packit |
16808d |
# be different. The list of all members will be omitted, etc.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
OPTIMIZE_OUTPUT_FOR_C = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of
|
|
Packit |
16808d |
# Java sources only. Doxygen will then generate output that is more
|
|
Packit |
16808d |
# tailored for Java. For instance, namespaces will be presented as
|
|
Packit |
16808d |
# packages, qualified scopes will look different, etc.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
OPTIMIZE_OUTPUT_JAVA = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
|
|
Packit |
16808d |
# the same type (for instance a group of public functions) to be put as a
|
|
Packit |
16808d |
# subgroup of that type (e.g. under the Public Functions section). Set it to
|
|
Packit |
16808d |
# NO to prevent subgrouping. Alternatively, this can be done per class using
|
|
Packit |
16808d |
# the \nosubgrouping command.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
SUBGROUPING = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
# Build related configuration options
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
|
|
Packit |
16808d |
# documentation are documented, even if no documentation was available.
|
|
Packit |
16808d |
# Private class members and static file members will be hidden unless
|
|
Packit |
16808d |
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
EXTRACT_ALL = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
|
|
Packit |
16808d |
# will be included in the documentation.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
EXTRACT_PRIVATE = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the EXTRACT_STATIC tag is set to YES all static members of a file
|
|
Packit |
16808d |
# will be included in the documentation.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
EXTRACT_STATIC = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
|
|
Packit |
16808d |
# defined locally in source files will be included in the documentation.
|
|
Packit |
16808d |
# If set to NO only classes defined in header files are included.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
EXTRACT_LOCAL_CLASSES = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
|
|
Packit |
16808d |
# undocumented members of documented classes, files or namespaces.
|
|
Packit |
16808d |
# If set to NO (the default) these members will be included in the
|
|
Packit |
16808d |
# various overviews, but no documentation section is generated.
|
|
Packit |
16808d |
# This option has no effect if EXTRACT_ALL is enabled.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
HIDE_UNDOC_MEMBERS = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
|
|
Packit |
16808d |
# undocumented classes that are normally visible in the class hierarchy.
|
|
Packit |
16808d |
# If set to NO (the default) these classes will be included in the various
|
|
Packit |
16808d |
# overviews. This option has no effect if EXTRACT_ALL is enabled.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
HIDE_UNDOC_CLASSES = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
|
|
Packit |
16808d |
# friend (class|struct|union) declarations.
|
|
Packit |
16808d |
# If set to NO (the default) these declarations will be included in the
|
|
Packit |
16808d |
# documentation.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
HIDE_FRIEND_COMPOUNDS = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
|
|
Packit |
16808d |
# documentation blocks found inside the body of a function.
|
|
Packit |
16808d |
# If set to NO (the default) these blocks will be appended to the
|
|
Packit |
16808d |
# function's detailed documentation block.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
HIDE_IN_BODY_DOCS = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The INTERNAL_DOCS tag determines if documentation
|
|
Packit |
16808d |
# that is typed after a \internal command is included. If the tag is set
|
|
Packit |
16808d |
# to NO (the default) then the documentation will be excluded.
|
|
Packit |
16808d |
# Set it to YES to include the internal documentation.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
INTERNAL_DOCS = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
|
|
Packit |
16808d |
# file names in lower-case letters. If set to YES upper-case letters are also
|
|
Packit |
16808d |
# allowed. This is useful if you have classes or files whose names only differ
|
|
Packit |
16808d |
# in case and if your file system supports case sensitive file names. Windows
|
|
Packit |
16808d |
# users are advised to set this option to NO.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
CASE_SENSE_NAMES = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
|
|
Packit |
16808d |
# will show members with their full class and namespace scopes in the
|
|
Packit |
16808d |
# documentation. If set to YES the scope will be hidden.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
HIDE_SCOPE_NAMES = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then
|
|
Packit |
16808d |
# Doxygen will put a list of the files that are included by a file in
|
|
Packit |
16808d |
# the documentation of that file.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
SHOW_INCLUDE_FILES = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
|
|
Packit |
16808d |
# is inserted in the documentation for inline members.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
INLINE_INFO = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
|
|
Packit |
16808d |
# will sort the (detailed) documentation of file and class members
|
|
Packit |
16808d |
# alphabetically by member name. If set to NO the members will appear in
|
|
Packit |
16808d |
# declaration order.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
SORT_MEMBER_DOCS = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
|
|
Packit |
16808d |
# brief documentation of file, namespace and class members alphabetically
|
|
Packit |
16808d |
# by member name. If set to NO (the default) the members will appear in
|
|
Packit |
16808d |
# declaration order.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
SORT_BRIEF_DOCS = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
|
|
Packit |
16808d |
# sorted by fully-qualified names, including namespaces. If set to
|
|
Packit |
16808d |
# NO (the default), the class list will be sorted only by class name,
|
|
Packit |
16808d |
# not including the namespace part.
|
|
Packit |
16808d |
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
|
|
Packit |
16808d |
# Note: This option applies only to the class list, not to the
|
|
Packit |
16808d |
# alphabetical list.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
SORT_BY_SCOPE_NAME = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The GENERATE_TODOLIST tag can be used to enable (YES) or
|
|
Packit |
16808d |
# disable (NO) the todo list. This list is created by putting \todo
|
|
Packit |
16808d |
# commands in the documentation.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
GENERATE_TODOLIST = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The GENERATE_TESTLIST tag can be used to enable (YES) or
|
|
Packit |
16808d |
# disable (NO) the test list. This list is created by putting \test
|
|
Packit |
16808d |
# commands in the documentation.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
GENERATE_TESTLIST = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The GENERATE_BUGLIST tag can be used to enable (YES) or
|
|
Packit |
16808d |
# disable (NO) the bug list. This list is created by putting \bug
|
|
Packit |
16808d |
# commands in the documentation.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
GENERATE_BUGLIST = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
|
|
Packit |
16808d |
# disable (NO) the deprecated list. This list is created by putting
|
|
Packit |
16808d |
# \deprecated commands in the documentation.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
GENERATE_DEPRECATEDLIST= YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The ENABLED_SECTIONS tag can be used to enable conditional
|
|
Packit |
16808d |
# documentation sections, marked by \if sectionname ... \endif.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
ENABLED_SECTIONS =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
|
|
Packit |
16808d |
# the initial value of a variable or define consists of for it to
|
|
Packit |
16808d |
# appear in the documentation. If the initializer consists of more
|
|
Packit |
16808d |
# lines than specified here it will be hidden. Use a value of 0 to
|
|
Packit |
16808d |
# hide initializers completely. The appearance of the initializer of
|
|
Packit |
16808d |
# individual variables and defines in the documentation can be
|
|
Packit |
16808d |
# controlled using \showinitializer or \hideinitializer command in the
|
|
Packit |
16808d |
# documentation regardless of this setting.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
MAX_INITIALIZER_LINES = 30
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# Set the SHOW_USED_FILES tag to NO to disable the list of files
|
|
Packit |
16808d |
# generated at the bottom of the documentation of classes and
|
|
Packit |
16808d |
# structs. If set to YES the list will mention the files that were
|
|
Packit |
16808d |
# used to generate the documentation.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
SHOW_USED_FILES = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
# configuration options related to warning and progress messages
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The QUIET tag can be used to turn on/off the messages that are generated
|
|
Packit |
16808d |
# by doxygen. Possible values are YES and NO. If left blank NO is used.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
QUIET = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The WARNINGS tag can be used to turn on/off the warning messages that are
|
|
Packit |
16808d |
# generated by doxygen. Possible values are YES and NO. If left blank
|
|
Packit |
16808d |
# NO is used.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
WARNINGS = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
|
|
Packit |
16808d |
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
|
|
Packit |
16808d |
# automatically be disabled.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
WARN_IF_UNDOCUMENTED = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
|
|
Packit |
16808d |
# potential errors in the documentation, such as not documenting some
|
|
Packit |
16808d |
# parameters in a documented function, or documenting parameters that
|
|
Packit |
16808d |
# don't exist or using markup commands wrongly.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
WARN_IF_DOC_ERROR = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The WARN_FORMAT tag determines the format of the warning messages that
|
|
Packit |
16808d |
# doxygen can produce. The string should contain the $file, $line, and $text
|
|
Packit |
16808d |
# tags, which will be replaced by the file and line number from which the
|
|
Packit |
16808d |
# warning originated and the warning text.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
WARN_FORMAT = "$file:$line: $text"
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The WARN_LOGFILE tag can be used to specify a file to which warning
|
|
Packit |
16808d |
# and error messages should be written. If left blank the output is written
|
|
Packit |
16808d |
# to stderr.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
WARN_LOGFILE =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
# configuration options related to the input files
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The INPUT tag can be used to specify the files and/or directories that contain
|
|
Packit |
16808d |
# documented source files. You may enter file names like "myfile.cpp" or
|
|
Packit |
16808d |
# directories like "/usr/src/myproject". Separate the files or directories
|
|
Packit |
16808d |
# with spaces.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
INPUT = ../src
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the value of the INPUT tag contains directories, you can use the
|
|
Packit |
16808d |
# FILE_PATTERNS tag to specify one or more wildcard pattern (like
|
|
Packit |
16808d |
# *.cpp and *.h) to filter out the source-files in the directories. If
|
|
Packit |
16808d |
# left blank the following patterns are tested: *.c *.cc *.cxx *.cpp
|
|
Packit |
16808d |
# *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp *.h++
|
|
Packit |
16808d |
# *.idl *.odl *.cs *.php *.php3 *.inc
|
|
Packit |
16808d |
|
|
Packit |
16808d |
FILE_PATTERNS = *.h
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
|
|
Packit |
16808d |
# should be searched for input files as well. Possible values are YES and NO.
|
|
Packit |
16808d |
# If left blank NO is used.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
RECURSIVE = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The EXCLUDE tag can be used to specify files and/or directories that
|
|
Packit |
16808d |
# should excluded from the INPUT source files. This way you can easily
|
|
Packit |
16808d |
# exclude a subdirectory from a directory tree whose root is specified
|
|
Packit |
16808d |
# with the INPUT tag.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
EXCLUDE =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
|
|
Packit |
16808d |
# directories that are symbolic links (a Unix filesystem feature) are
|
|
Packit |
16808d |
# excluded from the input.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
EXCLUDE_SYMLINKS = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the value of the INPUT tag contains directories, you can use the
|
|
Packit |
16808d |
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
|
|
Packit |
16808d |
# certain files from those directories.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
EXCLUDE_PATTERNS =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The EXAMPLE_PATH tag can be used to specify one or more files or
|
|
Packit |
16808d |
# directories that contain example code fragments that are included (see
|
|
Packit |
16808d |
# the \include command).
|
|
Packit |
16808d |
|
|
Packit |
16808d |
EXAMPLE_PATH =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
|
|
Packit |
16808d |
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
|
|
Packit |
16808d |
# and *.h) to filter out the source-files in the directories. If left
|
|
Packit |
16808d |
# blank all files are included.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
EXAMPLE_PATTERNS =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
|
|
Packit |
16808d |
# searched for input files to be used with the \include or \dontinclude
|
|
Packit |
16808d |
# commands irrespective of the value of the RECURSIVE tag.
|
|
Packit |
16808d |
# Possible values are YES and NO. If left blank NO is used.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
EXAMPLE_RECURSIVE = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The IMAGE_PATH tag can be used to specify one or more files or
|
|
Packit |
16808d |
# directories that contain image that are included in the documentation (see
|
|
Packit |
16808d |
# the \image command).
|
|
Packit |
16808d |
|
|
Packit |
16808d |
IMAGE_PATH =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The INPUT_FILTER tag can be used to specify a program that doxygen
|
|
Packit |
16808d |
# should invoke to filter for each input file. Doxygen will invoke the
|
|
Packit |
16808d |
# filter program by executing (via popen()) the command <filter>
|
|
Packit |
16808d |
# <input-file>, where <filter> is the value of the INPUT_FILTER tag,
|
|
Packit |
16808d |
# and <input-file> is the name of an input file. Doxygen will then use
|
|
Packit |
16808d |
# the output that the filter program writes to standard output.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
INPUT_FILTER =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if
|
|
Packit |
16808d |
# set using INPUT_FILTER) will be used to filter the input files when
|
|
Packit |
16808d |
# producing source files to browse (i.e. when SOURCE_BROWSER is set to
|
|
Packit |
16808d |
# YES).
|
|
Packit |
16808d |
|
|
Packit |
16808d |
FILTER_SOURCE_FILES = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
# configuration options related to source browsing
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the SOURCE_BROWSER tag is set to YES then a list of source files
|
|
Packit |
16808d |
# will be generated. Documented entities will be cross-referenced with
|
|
Packit |
16808d |
# these sources. Note: To get rid of all source code in the generated
|
|
Packit |
16808d |
# output, make sure also VERBATIM_HEADERS is set to NO.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
SOURCE_BROWSER = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# Setting the INLINE_SOURCES tag to YES will include the body
|
|
Packit |
16808d |
# of functions and classes directly in the documentation.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
INLINE_SOURCES = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
|
|
Packit |
16808d |
# doxygen to hide any special comment blocks from generated source code
|
|
Packit |
16808d |
# fragments. Normal C and C++ comments will always remain visible.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
STRIP_CODE_COMMENTS = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
|
|
Packit |
16808d |
# then for each documented function all documented
|
|
Packit |
16808d |
# functions referencing it will be listed.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
REFERENCED_BY_RELATION = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the REFERENCES_RELATION tag is set to YES (the default)
|
|
Packit |
16808d |
# then for each documented function all documented entities
|
|
Packit |
16808d |
# called/used by that function will be listed.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
REFERENCES_RELATION = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
|
|
Packit |
16808d |
# will generate a verbatim copy of the header file for each class for
|
|
Packit |
16808d |
# which an include is specified. Set to NO to disable this.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
VERBATIM_HEADERS = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
# configuration options related to the alphabetical class index
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
|
|
Packit |
16808d |
# of all compounds will be generated. Enable this if the project
|
|
Packit |
16808d |
# contains a lot of classes, structs, unions or interfaces.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
ALPHABETICAL_INDEX = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
|
|
Packit |
16808d |
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
|
|
Packit |
16808d |
# in which this list will be split (can be a number in the range [1..20])
|
|
Packit |
16808d |
|
|
Packit |
16808d |
COLS_IN_ALPHA_INDEX = 5
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# In case all classes in a project start with a common prefix, all
|
|
Packit |
16808d |
# classes will be put under the same header in the alphabetical index.
|
|
Packit |
16808d |
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
|
|
Packit |
16808d |
# should be ignored while generating the index headers.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
IGNORE_PREFIX = mw
|
|
Packit |
16808d |
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
# configuration options related to the HTML output
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
|
|
Packit |
16808d |
# generate HTML output.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
GENERATE_HTML = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
|
|
Packit |
16808d |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
|
Packit |
16808d |
# put in front of it. If left blank `html' will be used as the default path.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
HTML_OUTPUT = html
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
|
|
Packit |
16808d |
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
|
|
Packit |
16808d |
# doxygen will generate files with .html extension.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
HTML_FILE_EXTENSION = .html
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The HTML_HEADER tag can be used to specify a personal HTML header for
|
|
Packit |
16808d |
# each generated HTML page. If it is left blank doxygen will generate a
|
|
Packit |
16808d |
# standard header.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
HTML_HEADER =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
|
|
Packit |
16808d |
# each generated HTML page. If it is left blank doxygen will generate a
|
|
Packit |
16808d |
# standard footer.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
HTML_FOOTER =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
|
|
Packit |
16808d |
# style sheet that is used by each HTML page. It can be used to
|
|
Packit |
16808d |
# fine-tune the look of the HTML output. If the tag is left blank doxygen
|
|
Packit |
16808d |
# will generate a default style sheet. Note that doxygen will try to copy
|
|
Packit |
16808d |
# the style sheet file to the HTML output directory, so don't put your own
|
|
Packit |
16808d |
# stylesheet in the HTML output directory as well, or it will be erased!
|
|
Packit |
16808d |
|
|
Packit |
16808d |
HTML_STYLESHEET =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
|
|
Packit |
16808d |
# files or namespaces will be aligned in HTML using tables. If set to
|
|
Packit |
16808d |
# NO a bullet list will be used.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
HTML_ALIGN_MEMBERS = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
|
|
Packit |
16808d |
# will be generated that can be used as input for tools like the
|
|
Packit |
16808d |
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
|
|
Packit |
16808d |
# of the generated HTML documentation.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
GENERATE_HTMLHELP = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
|
|
Packit |
16808d |
# be used to specify the file name of the resulting .chm file. You
|
|
Packit |
16808d |
# can add a path in front of the file if the result should not be
|
|
Packit |
16808d |
# written to the html output directory.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
CHM_FILE =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
|
|
Packit |
16808d |
# be used to specify the location (absolute path including file name) of
|
|
Packit |
16808d |
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
|
|
Packit |
16808d |
# the HTML help compiler on the generated index.hhp.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
HHC_LOCATION =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
|
|
Packit |
16808d |
# controls if a separate .chi index file is generated (YES) or that
|
|
Packit |
16808d |
# it should be included in the master .chm file (NO).
|
|
Packit |
16808d |
|
|
Packit |
16808d |
GENERATE_CHI = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
|
|
Packit |
16808d |
# controls whether a binary table of contents is generated (YES) or a
|
|
Packit |
16808d |
# normal table of contents (NO) in the .chm file.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
BINARY_TOC = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The TOC_EXPAND flag can be set to YES to add extra items for group members
|
|
Packit |
16808d |
# to the contents of the HTML help documentation and to the tree view.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
TOC_EXPAND = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
|
|
Packit |
16808d |
# top of each HTML page. The value NO (the default) enables the index and
|
|
Packit |
16808d |
# the value YES disables it.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
DISABLE_INDEX = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# This tag can be used to set the number of enum values (range [1..20])
|
|
Packit |
16808d |
# that doxygen will group on one line in the generated HTML documentation.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
ENUM_VALUES_PER_LINE = 1
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
|
|
Packit |
16808d |
# generated containing a tree-like index structure (just like the one that
|
|
Packit |
16808d |
# is generated for HTML Help). For this to work a browser that supports
|
|
Packit |
16808d |
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
|
|
Packit |
16808d |
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
|
|
Packit |
16808d |
# probably better off using the HTML help feature.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
GENERATE_TREEVIEW = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
|
|
Packit |
16808d |
# used to set the initial width (in pixels) of the frame in which the tree
|
|
Packit |
16808d |
# is shown.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
TREEVIEW_WIDTH = 250
|
|
Packit |
16808d |
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
# configuration options related to the LaTeX output
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
|
|
Packit |
16808d |
# generate Latex output.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
GENERATE_LATEX = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
|
|
Packit |
16808d |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
|
Packit |
16808d |
# put in front of it. If left blank `latex' will be used as the default path.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
LATEX_OUTPUT = latex
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
|
|
Packit |
16808d |
# invoked. If left blank `latex' will be used as the default command name.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
LATEX_CMD_NAME = latex
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
|
|
Packit |
16808d |
# generate index for LaTeX. If left blank `makeindex' will be used as the
|
|
Packit |
16808d |
# default command name.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
MAKEINDEX_CMD_NAME = makeindex
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
|
|
Packit |
16808d |
# LaTeX documents. This may be useful for small projects and may help to
|
|
Packit |
16808d |
# save some trees in general.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
COMPACT_LATEX = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The PAPER_TYPE tag can be used to set the paper type that is used
|
|
Packit |
16808d |
# by the printer. Possible values are: a4, a4wide, letter, legal and
|
|
Packit |
16808d |
# executive. If left blank a4wide will be used.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
PAPER_TYPE = a4wide
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
|
|
Packit |
16808d |
# packages that should be included in the LaTeX output.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
EXTRA_PACKAGES =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
|
|
Packit |
16808d |
# the generated latex document. The header should contain everything until
|
|
Packit |
16808d |
# the first chapter. If it is left blank doxygen will generate a
|
|
Packit |
16808d |
# standard header. Notice: only use this tag if you know what you are doing!
|
|
Packit |
16808d |
|
|
Packit |
16808d |
LATEX_HEADER =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
|
|
Packit |
16808d |
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
|
|
Packit |
16808d |
# contain links (just like the HTML output) instead of page references
|
|
Packit |
16808d |
# This makes the output suitable for online browsing using a pdf viewer.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
PDF_HYPERLINKS = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
|
|
Packit |
16808d |
# plain latex in the generated Makefile. Set this option to YES to get a
|
|
Packit |
16808d |
# higher quality PDF documentation.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
USE_PDFLATEX = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
|
|
Packit |
16808d |
# command to the generated LaTeX files. This will instruct LaTeX to keep
|
|
Packit |
16808d |
# running if errors occur, instead of asking the user for help.
|
|
Packit |
16808d |
# This option is also used when generating formulas in HTML.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
LATEX_BATCHMODE = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
|
|
Packit |
16808d |
# include the index chapters (such as File Index, Compound Index, etc.)
|
|
Packit |
16808d |
# in the output.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
LATEX_HIDE_INDICES = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
# configuration options related to the RTF output
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
|
|
Packit |
16808d |
# The RTF output is optimized for Word 97 and may not look very pretty with
|
|
Packit |
16808d |
# other RTF readers or editors.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
GENERATE_RTF = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
|
|
Packit |
16808d |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
|
Packit |
16808d |
# put in front of it. If left blank `rtf' will be used as the default path.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
RTF_OUTPUT = rtf
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
|
|
Packit |
16808d |
# RTF documents. This may be useful for small projects and may help to
|
|
Packit |
16808d |
# save some trees in general.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
COMPACT_RTF = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
|
|
Packit |
16808d |
# will contain hyperlink fields. The RTF file will
|
|
Packit |
16808d |
# contain links (just like the HTML output) instead of page references.
|
|
Packit |
16808d |
# This makes the output suitable for online browsing using WORD or other
|
|
Packit |
16808d |
# programs which support those fields.
|
|
Packit |
16808d |
# Note: wordpad (write) and others do not support links.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
RTF_HYPERLINKS = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# Load stylesheet definitions from file. Syntax is similar to doxygen's
|
|
Packit |
16808d |
# config file, i.e. a series of assignments. You only have to provide
|
|
Packit |
16808d |
# replacements, missing definitions are set to their default value.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
RTF_STYLESHEET_FILE =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# Set optional variables used in the generation of an rtf document.
|
|
Packit |
16808d |
# Syntax is similar to doxygen's config file.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
RTF_EXTENSIONS_FILE =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
# configuration options related to the man page output
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
|
|
Packit |
16808d |
# generate man pages
|
|
Packit |
16808d |
|
|
Packit |
16808d |
GENERATE_MAN = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
|
|
Packit |
16808d |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
|
Packit |
16808d |
# put in front of it. If left blank `man' will be used as the default path.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
MAN_OUTPUT = man
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The MAN_EXTENSION tag determines the extension that is added to
|
|
Packit |
16808d |
# the generated man pages (default is the subroutine's section .3)
|
|
Packit |
16808d |
|
|
Packit |
16808d |
MAN_EXTENSION = .3
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
|
|
Packit |
16808d |
# then it will generate one additional man file for each entity
|
|
Packit |
16808d |
# documented in the real man page(s). These additional files
|
|
Packit |
16808d |
# only source the real man page, but without them the man command
|
|
Packit |
16808d |
# would be unable to find the correct page. The default is NO.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
MAN_LINKS = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
# configuration options related to the XML output
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the GENERATE_XML tag is set to YES Doxygen will
|
|
Packit |
16808d |
# generate an XML file that captures the structure of
|
|
Packit |
16808d |
# the code including all documentation.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
GENERATE_XML = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
|
|
Packit |
16808d |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
|
Packit |
16808d |
# put in front of it. If left blank `xml' will be used as the default path.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
XML_OUTPUT = xml
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The XML_SCHEMA tag can be used to specify an XML schema,
|
|
Packit |
16808d |
# which can be used by a validating XML parser to check the
|
|
Packit |
16808d |
# syntax of the XML files.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
XML_SCHEMA =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The XML_DTD tag can be used to specify an XML DTD,
|
|
Packit |
16808d |
# which can be used by a validating XML parser to check the
|
|
Packit |
16808d |
# syntax of the XML files.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
XML_DTD =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
|
|
Packit |
16808d |
# dump the program listings (including syntax highlighting
|
|
Packit |
16808d |
# and cross-referencing information) to the XML output. Note that
|
|
Packit |
16808d |
# enabling this will significantly increase the size of the XML output.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
XML_PROGRAMLISTING = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
# configuration options for the AutoGen Definitions output
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
|
|
Packit |
16808d |
# generate an AutoGen Definitions (see autogen.sf.net) file
|
|
Packit |
16808d |
# that captures the structure of the code including all
|
|
Packit |
16808d |
# documentation. Note that this feature is still experimental
|
|
Packit |
16808d |
# and incomplete at the moment.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
GENERATE_AUTOGEN_DEF = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
# configuration options related to the Perl module output
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
|
|
Packit |
16808d |
# generate a Perl module file that captures the structure of
|
|
Packit |
16808d |
# the code including all documentation. Note that this
|
|
Packit |
16808d |
# feature is still experimental and incomplete at the
|
|
Packit |
16808d |
# moment.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
GENERATE_PERLMOD = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
|
|
Packit |
16808d |
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
|
|
Packit |
16808d |
# to generate PDF and DVI output from the Perl module output.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
PERLMOD_LATEX = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
|
|
Packit |
16808d |
# nicely formatted so it can be parsed by a human reader. This is useful
|
|
Packit |
16808d |
# if you want to understand what is going on. On the other hand, if this
|
|
Packit |
16808d |
# tag is set to NO the size of the Perl module output will be much smaller
|
|
Packit |
16808d |
# and Perl will parse it just the same.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
PERLMOD_PRETTY = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The names of the make variables in the generated doxyrules.make file
|
|
Packit |
16808d |
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
|
|
Packit |
16808d |
# This is useful so different doxyrules.make files included by the same
|
|
Packit |
16808d |
# Makefile don't overwrite each other's variables.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
PERLMOD_MAKEVAR_PREFIX =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
# Configuration options related to the preprocessor
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
|
|
Packit |
16808d |
# evaluate all C-preprocessor directives found in the sources and include
|
|
Packit |
16808d |
# files.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
ENABLE_PREPROCESSING = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
|
|
Packit |
16808d |
# names in the source code. If set to NO (the default) only conditional
|
|
Packit |
16808d |
# compilation will be performed. Macro expansion can be done in a controlled
|
|
Packit |
16808d |
# way by setting EXPAND_ONLY_PREDEF to YES.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
MACRO_EXPANSION = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
|
|
Packit |
16808d |
# then the macro expansion is limited to the macros specified with the
|
|
Packit |
16808d |
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
EXPAND_ONLY_PREDEF = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
|
|
Packit |
16808d |
# in the INCLUDE_PATH (see below) will be search if a #include is found.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
SEARCH_INCLUDES = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The INCLUDE_PATH tag can be used to specify one or more directories that
|
|
Packit |
16808d |
# contain include files that are not input files but should be processed by
|
|
Packit |
16808d |
# the preprocessor.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
INCLUDE_PATH =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
|
|
Packit |
16808d |
# patterns (like *.h and *.hpp) to filter out the header-files in the
|
|
Packit |
16808d |
# directories. If left blank, the patterns specified with FILE_PATTERNS will
|
|
Packit |
16808d |
# be used.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
INCLUDE_FILE_PATTERNS =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The PREDEFINED tag can be used to specify one or more macro names that
|
|
Packit |
16808d |
# are defined before the preprocessor is started (similar to the -D option of
|
|
Packit |
16808d |
# gcc). The argument of the tag is a list of macros of the form: name
|
|
Packit |
16808d |
# or name=definition (no spaces). If the definition and the = are
|
|
Packit |
16808d |
# omitted =1 is assumed.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
PREDEFINED =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES
|
|
Packit |
16808d |
# then this tag can be used to specify a list of macro names that
|
|
Packit |
16808d |
# should be expanded. The macro definition that is found in the
|
|
Packit |
16808d |
# sources will be used. Use the PREDEFINED tag if you want to use a
|
|
Packit |
16808d |
# different macro definition.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
EXPAND_AS_DEFINED =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
|
|
Packit |
16808d |
# doxygen's preprocessor will remove all function-like macros that are
|
|
Packit |
16808d |
# alone on a line, have an all uppercase name, and do not end with a
|
|
Packit |
16808d |
# semicolon. Such function macros are typically used for boiler-plate
|
|
Packit |
16808d |
# code, and will confuse the parser if not removed.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
SKIP_FUNCTION_MACROS = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
# Configuration::additions related to external references
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The TAGFILES option can be used to specify one or more tagfiles.
|
|
Packit |
16808d |
# Optionally an initial location of the external documentation
|
|
Packit |
16808d |
# can be added for each tagfile. The format of a tag file without
|
|
Packit |
16808d |
# this location is as follows:
|
|
Packit |
16808d |
# TAGFILES = file1 file2 ...
|
|
Packit |
16808d |
# Adding location for the tag files is done as follows:
|
|
Packit |
16808d |
# TAGFILES = file1=loc1 "file2 = loc2" ...
|
|
Packit |
16808d |
# where "loc1" and "loc2" can be relative or absolute paths or
|
|
Packit |
16808d |
# URLs. If a location is present for each tag, the installdox tool
|
|
Packit |
16808d |
# does not have to be run to correct the links.
|
|
Packit |
16808d |
# Note that each tag file must have a unique name
|
|
Packit |
16808d |
# (where the name does NOT include the path)
|
|
Packit |
16808d |
# If a tag file is not located in the directory in which doxygen
|
|
Packit |
16808d |
# is run, you must also specify the path to the tagfile here.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
TAGFILES =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
|
|
Packit |
16808d |
# a tag file that is based on the input files it reads.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
GENERATE_TAGFILE =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
|
|
Packit |
16808d |
# in the class index. If set to NO only the inherited external classes
|
|
Packit |
16808d |
# will be listed.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
ALLEXTERNALS = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
|
|
Packit |
16808d |
# in the modules index. If set to NO, only the current project's groups will
|
|
Packit |
16808d |
# be listed.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
EXTERNAL_GROUPS = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The PERL_PATH should be the absolute path and name of the perl script
|
|
Packit |
16808d |
# interpreter (i.e. the result of `which perl').
|
|
Packit |
16808d |
|
|
Packit |
16808d |
PERL_PATH = /usr/bin/perl
|
|
Packit |
16808d |
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
# Configuration options related to the dot tool
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
|
|
Packit |
16808d |
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes
|
|
Packit |
16808d |
# with base or super classes. Setting the tag to NO turns the diagrams
|
|
Packit |
16808d |
# off. Note that this option is superseded by the HAVE_DOT option
|
|
Packit |
16808d |
# below. This is only a fallback. It is recommended to install and use
|
|
Packit |
16808d |
# dot, since it yields more powerful graphs.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
CLASS_DIAGRAMS = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If set to YES, the inheritance and collaboration graphs will hide
|
|
Packit |
16808d |
# inheritance and usage relations if the target is undocumented
|
|
Packit |
16808d |
# or is not a class.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
HIDE_UNDOC_RELATIONS = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot
|
|
Packit |
16808d |
# tool is available from the path. This tool is part of Graphviz, a
|
|
Packit |
16808d |
# graph visualization toolkit from AT&T and Lucent Bell Labs. The
|
|
Packit |
16808d |
# other options in this section have no effect if this option is set
|
|
Packit |
16808d |
# to NO (the default)
|
|
Packit |
16808d |
|
|
Packit |
16808d |
HAVE_DOT = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
|
|
Packit |
16808d |
# will generate a graph for each documented class showing the direct and
|
|
Packit |
16808d |
# indirect inheritance relations. Setting this tag to YES will force the
|
|
Packit |
16808d |
# the CLASS_DIAGRAMS tag to NO.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
CLASS_GRAPH = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
|
|
Packit |
16808d |
# will generate a graph for each documented class showing the direct and
|
|
Packit |
16808d |
# indirect implementation dependencies (inheritance, containment, and
|
|
Packit |
16808d |
# class references variables) of the class with other documented classes.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
COLLABORATION_GRAPH = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
|
|
Packit |
16808d |
# collaboration diagrams in a style similar to the OMG's Unified Modeling
|
|
Packit |
16808d |
# Language.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
UML_LOOK = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If set to YES, the inheritance and collaboration graphs will show the
|
|
Packit |
16808d |
# relations between templates and their instances.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
TEMPLATE_RELATIONS = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
|
|
Packit |
16808d |
# tags are set to YES then doxygen will generate a graph for each documented
|
|
Packit |
16808d |
# file showing the direct and indirect include dependencies of the file with
|
|
Packit |
16808d |
# other documented files.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
INCLUDE_GRAPH = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
|
|
Packit |
16808d |
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
|
|
Packit |
16808d |
# documented header file showing the documented files that directly or
|
|
Packit |
16808d |
# indirectly include this file.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
INCLUDED_BY_GRAPH = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
|
|
Packit |
16808d |
# generate a call dependency graph for every global function or class
|
|
Packit |
16808d |
# method. Note that enabling this option will significantly increase
|
|
Packit |
16808d |
# the time of a run. So in most cases it will be better to enable
|
|
Packit |
16808d |
# call graphs for selected functions only using the \callgraph
|
|
Packit |
16808d |
# command.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
CALL_GRAPH = NO
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
|
|
Packit |
16808d |
# will graphical hierarchy of all classes instead of a textual one.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
GRAPHICAL_HIERARCHY = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
|
|
Packit |
16808d |
# generated by dot. Possible values are png, jpg, or gif
|
|
Packit |
16808d |
# If left blank png will be used.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
DOT_IMAGE_FORMAT = png
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The tag DOT_PATH can be used to specify the path where the dot tool can be
|
|
Packit |
16808d |
# found. If left blank, it is assumed the dot tool can be found on the path.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
DOT_PATH =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The DOTFILE_DIRS tag can be used to specify one or more directories that
|
|
Packit |
16808d |
# contain dot files that are included in the documentation (see the
|
|
Packit |
16808d |
# \dotfile command).
|
|
Packit |
16808d |
|
|
Packit |
16808d |
DOTFILE_DIRS =
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
|
|
Packit |
16808d |
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
|
|
Packit |
16808d |
# this value, doxygen will try to truncate the graph, so that it fits within
|
|
Packit |
16808d |
# the specified constraint. Beware that most browsers cannot cope with very
|
|
Packit |
16808d |
# large images.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
MAX_DOT_GRAPH_WIDTH = 1024
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
|
|
Packit |
16808d |
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
|
|
Packit |
16808d |
# this value, doxygen will try to truncate the graph, so that it fits within
|
|
Packit |
16808d |
# the specified constraint. Beware that most browsers cannot cope with very
|
|
Packit |
16808d |
# large images.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
MAX_DOT_GRAPH_HEIGHT = 1024
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of
|
|
Packit |
16808d |
# the graphs generated by dot. A depth value of 3 means that only
|
|
Packit |
16808d |
# nodes reachable from the root by following a path via at most 3
|
|
Packit |
16808d |
# edges will be shown. Nodes that lay further from the root node will
|
|
Packit |
16808d |
# be omitted. Note that setting this option to 1 or 2 may greatly
|
|
Packit |
16808d |
# reduce the computation time needed for large code bases. Also note
|
|
Packit |
16808d |
# that a graph may be further truncated if the graph's image
|
|
Packit |
16808d |
# dimensions are not sufficient to fit the graph (see
|
|
Packit |
16808d |
# MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the
|
|
Packit |
16808d |
# depth value (the default), the graph is not depth-constrained.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
MAX_DOT_GRAPH_DEPTH = 0
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
|
|
Packit |
16808d |
# generate a legend page explaining the meaning of the various boxes and
|
|
Packit |
16808d |
# arrows in the dot generated graphs.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
GENERATE_LEGEND = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
|
|
Packit |
16808d |
# remove the intermediate dot files that are used to generate
|
|
Packit |
16808d |
# the various graphs.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
DOT_CLEANUP = YES
|
|
Packit |
16808d |
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
# Configuration::additions related to the search engine
|
|
Packit |
16808d |
#---------------------------------------------------------------------------
|
|
Packit |
16808d |
|
|
Packit |
16808d |
# The SEARCHENGINE tag specifies whether or not a search engine should be
|
|
Packit |
16808d |
# used. If set to NO the values of all tags below this one will be ignored.
|
|
Packit |
16808d |
|
|
Packit |
16808d |
SEARCHENGINE = NO
|