Blame docs/Doxyfile

Packit 1fb8d4
# Doxyfile 1.6.1
Packit 1fb8d4
Packit 1fb8d4
# This file describes the settings to be used by the documentation system
Packit 1fb8d4
# doxygen (www.doxygen.org) for a project
Packit 1fb8d4
#
Packit 1fb8d4
# All text after a hash (#) is considered a comment and will be ignored
Packit 1fb8d4
# The format is:
Packit 1fb8d4
#       TAG = value [value, ...]
Packit 1fb8d4
# For lists items can also be appended using:
Packit 1fb8d4
#       TAG += value [value, ...]
Packit 1fb8d4
# Values that contain spaces should be placed between quotes (" ")
Packit 1fb8d4
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
# Project related configuration options
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
Packit 1fb8d4
# This tag specifies the encoding used for all characters in the config file
Packit 1fb8d4
# that follow. The default is UTF-8 which is also the encoding used for all
Packit 1fb8d4
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
Packit 1fb8d4
# iconv built into libc) for the transcoding. See
Packit 1fb8d4
# http://www.gnu.org/software/libiconv for the list of possible encodings.
Packit 1fb8d4
Packit 1fb8d4
DOXYFILE_ENCODING      = UTF-8
Packit 1fb8d4
Packit 1fb8d4
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
Packit 1fb8d4
# by quotes) that should identify the project.
Packit 1fb8d4
Packit 1fb8d4
PROJECT_NAME           = FreeRDP
Packit 1fb8d4
Packit 1fb8d4
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
Packit 1fb8d4
# This could be handy for archiving the generated documentation or
Packit 1fb8d4
# if some version control system is used.
Packit 1fb8d4
Packit 1fb8d4
PROJECT_NUMBER         =
Packit 1fb8d4
Packit 1fb8d4
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
Packit 1fb8d4
# base path where the generated documentation will be put.
Packit 1fb8d4
# If a relative path is entered, it will be relative to the location
Packit 1fb8d4
# where doxygen was started. If left blank the current directory will be used.
Packit 1fb8d4
Packit 1fb8d4
OUTPUT_DIRECTORY       =
Packit 1fb8d4
Packit 1fb8d4
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
Packit 1fb8d4
# 4096 sub-directories (in 2 levels) under the output directory of each output
Packit 1fb8d4
# format and will distribute the generated files over these directories.
Packit 1fb8d4
# Enabling this option can be useful when feeding doxygen a huge amount of
Packit 1fb8d4
# source files, where putting all generated files in the same directory would
Packit 1fb8d4
# otherwise cause performance problems for the file system.
Packit 1fb8d4
Packit 1fb8d4
CREATE_SUBDIRS         = NO
Packit 1fb8d4
Packit 1fb8d4
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
Packit 1fb8d4
# documentation generated by doxygen is written. Doxygen will use this
Packit 1fb8d4
# information to generate all constant output in the proper language.
Packit 1fb8d4
# The default language is English, other supported languages are:
Packit 1fb8d4
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
Packit 1fb8d4
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
Packit 1fb8d4
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
Packit 1fb8d4
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
Packit 1fb8d4
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
Packit 1fb8d4
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
Packit 1fb8d4
Packit 1fb8d4
OUTPUT_LANGUAGE        = English
Packit 1fb8d4
Packit 1fb8d4
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
Packit 1fb8d4
# include brief member descriptions after the members that are listed in
Packit 1fb8d4
# the file and class documentation (similar to JavaDoc).
Packit 1fb8d4
# Set to NO to disable this.
Packit 1fb8d4
Packit 1fb8d4
BRIEF_MEMBER_DESC      = YES
Packit 1fb8d4
Packit 1fb8d4
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
Packit 1fb8d4
# the brief description of a member or function before the detailed description.
Packit 1fb8d4
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
Packit 1fb8d4
# brief descriptions will be completely suppressed.
Packit 1fb8d4
Packit 1fb8d4
REPEAT_BRIEF           = YES
Packit 1fb8d4
Packit 1fb8d4
# This tag implements a quasi-intelligent brief description abbreviator
Packit 1fb8d4
# that is used to form the text in various listings. Each string
Packit 1fb8d4
# in this list, if found as the leading text of the brief description, will be
Packit 1fb8d4
# stripped from the text and the result after processing the whole list, is
Packit 1fb8d4
# used as the annotated text. Otherwise, the brief description is used as-is.
Packit 1fb8d4
# If left blank, the following values are used ("$name" is automatically
Packit 1fb8d4
# replaced with the name of the entity): "The $name class" "The $name widget"
Packit 1fb8d4
# "The $name file" "is" "provides" "specifies" "contains"
Packit 1fb8d4
# "represents" "a" "an" "the"
Packit 1fb8d4
Packit 1fb8d4
ABBREVIATE_BRIEF       =
Packit 1fb8d4
Packit 1fb8d4
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
Packit 1fb8d4
# Doxygen will generate a detailed section even if there is only a brief
Packit 1fb8d4
# description.
Packit 1fb8d4
Packit 1fb8d4
ALWAYS_DETAILED_SEC    = NO
Packit 1fb8d4
Packit 1fb8d4
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
Packit 1fb8d4
# inherited members of a class in the documentation of that class as if those
Packit 1fb8d4
# members were ordinary class members. Constructors, destructors and assignment
Packit 1fb8d4
# operators of the base classes will not be shown.
Packit 1fb8d4
Packit 1fb8d4
INLINE_INHERITED_MEMB  = NO
Packit 1fb8d4
Packit 1fb8d4
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
Packit 1fb8d4
# path before files name in the file list and in the header files. If set
Packit 1fb8d4
# to NO the shortest path that makes the file name unique will be used.
Packit 1fb8d4
Packit 1fb8d4
FULL_PATH_NAMES        = NO
Packit 1fb8d4
Packit 1fb8d4
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
Packit 1fb8d4
# can be used to strip a user-defined part of the path. Stripping is
Packit 1fb8d4
# only done if one of the specified strings matches the left-hand part of
Packit 1fb8d4
# the path. The tag can be used to show relative paths in the file list.
Packit 1fb8d4
# If left blank the directory from which doxygen is run is used as the
Packit 1fb8d4
# path to strip.
Packit 1fb8d4
Packit 1fb8d4
STRIP_FROM_PATH        =
Packit 1fb8d4
Packit 1fb8d4
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
Packit 1fb8d4
# the path mentioned in the documentation of a class, which tells
Packit 1fb8d4
# the reader which header file to include in order to use a class.
Packit 1fb8d4
# If left blank only the name of the header file containing the class
Packit 1fb8d4
# definition is used. Otherwise one should specify the include paths that
Packit 1fb8d4
# are normally passed to the compiler using the -I flag.
Packit 1fb8d4
Packit 1fb8d4
STRIP_FROM_INC_PATH    =
Packit 1fb8d4
Packit 1fb8d4
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
Packit 1fb8d4
# (but less readable) file names. This can be useful is your file systems
Packit 1fb8d4
# doesn't support long names like on DOS, Mac, or CD-ROM.
Packit 1fb8d4
Packit 1fb8d4
SHORT_NAMES            = NO
Packit 1fb8d4
Packit 1fb8d4
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
Packit 1fb8d4
# will interpret the first line (until the first dot) of a JavaDoc-style
Packit 1fb8d4
# comment as the brief description. If set to NO, the JavaDoc
Packit 1fb8d4
# comments will behave just like regular Qt-style comments
Packit 1fb8d4
# (thus requiring an explicit @brief command for a brief description.)
Packit 1fb8d4
Packit 1fb8d4
JAVADOC_AUTOBRIEF      = NO
Packit 1fb8d4
Packit 1fb8d4
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
Packit 1fb8d4
# interpret the first line (until the first dot) of a Qt-style
Packit 1fb8d4
# comment as the brief description. If set to NO, the comments
Packit 1fb8d4
# will behave just like regular Qt-style comments (thus requiring
Packit 1fb8d4
# an explicit \brief command for a brief description.)
Packit 1fb8d4
Packit 1fb8d4
QT_AUTOBRIEF           = NO
Packit 1fb8d4
Packit 1fb8d4
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
Packit 1fb8d4
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
Packit 1fb8d4
# comments) as a brief description. This used to be the default behaviour.
Packit 1fb8d4
# The new default is to treat a multi-line C++ comment block as a detailed
Packit 1fb8d4
# description. Set this tag to YES if you prefer the old behaviour instead.
Packit 1fb8d4
Packit 1fb8d4
MULTILINE_CPP_IS_BRIEF = NO
Packit 1fb8d4
Packit 1fb8d4
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
Packit 1fb8d4
# member inherits the documentation from any documented member that it
Packit 1fb8d4
# re-implements.
Packit 1fb8d4
Packit 1fb8d4
INHERIT_DOCS           = YES
Packit 1fb8d4
Packit 1fb8d4
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
Packit 1fb8d4
# a new page for each member. If set to NO, the documentation of a member will
Packit 1fb8d4
# be part of the file/class/namespace that contains it.
Packit 1fb8d4
Packit 1fb8d4
SEPARATE_MEMBER_PAGES  = NO
Packit 1fb8d4
Packit 1fb8d4
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
Packit 1fb8d4
# Doxygen uses this value to replace tabs by spaces in code fragments.
Packit 1fb8d4
Packit 1fb8d4
TAB_SIZE               = 8
Packit 1fb8d4
Packit 1fb8d4
# This tag can be used to specify a number of aliases that acts
Packit 1fb8d4
# as commands in the documentation. An alias has the form "name=value".
Packit 1fb8d4
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
Packit 1fb8d4
# put the command \sideeffect (or @sideeffect) in the documentation, which
Packit 1fb8d4
# will result in a user-defined paragraph with heading "Side Effects:".
Packit 1fb8d4
# You can put \n's in the value part of an alias to insert newlines.
Packit 1fb8d4
Packit 1fb8d4
ALIASES                = \
Packit 1fb8d4
			  msdn{1}="http://msdn.microsoft.com/en-us/library/\1/"
Packit 1fb8d4
Packit 1fb8d4
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
Packit 1fb8d4
# sources only. Doxygen will then generate output that is more tailored for C.
Packit 1fb8d4
# For instance, some of the names that are used will be different. The list
Packit 1fb8d4
# of all members will be omitted, etc.
Packit 1fb8d4
Packit 1fb8d4
OPTIMIZE_OUTPUT_FOR_C  = YES
Packit 1fb8d4
Packit 1fb8d4
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
Packit 1fb8d4
# sources only. Doxygen will then generate output that is more tailored for
Packit 1fb8d4
# Java. For instance, namespaces will be presented as packages, qualified
Packit 1fb8d4
# scopes will look different, etc.
Packit 1fb8d4
Packit 1fb8d4
OPTIMIZE_OUTPUT_JAVA   = NO
Packit 1fb8d4
Packit 1fb8d4
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
Packit 1fb8d4
# sources only. Doxygen will then generate output that is more tailored for
Packit 1fb8d4
# Fortran.
Packit 1fb8d4
Packit 1fb8d4
OPTIMIZE_FOR_FORTRAN   = NO
Packit 1fb8d4
Packit 1fb8d4
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
Packit 1fb8d4
# sources. Doxygen will then generate output that is tailored for
Packit 1fb8d4
# VHDL.
Packit 1fb8d4
Packit 1fb8d4
OPTIMIZE_OUTPUT_VHDL   = NO
Packit 1fb8d4
Packit 1fb8d4
# Doxygen selects the parser to use depending on the extension of the files it parses.
Packit 1fb8d4
# With this tag you can assign which parser to use for a given extension.
Packit 1fb8d4
# Doxygen has a built-in mapping, but you can override or extend it using this tag.
Packit 1fb8d4
# The format is ext=language, where ext is a file extension, and language is one of
Packit 1fb8d4
# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
Packit 1fb8d4
# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
Packit 1fb8d4
# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
Packit 1fb8d4
# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
Packit 1fb8d4
Packit 1fb8d4
EXTENSION_MAPPING      =
Packit 1fb8d4
Packit 1fb8d4
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
Packit 1fb8d4
# to include (a tag file for) the STL sources as input, then you should
Packit 1fb8d4
# set this tag to YES in order to let doxygen match functions declarations and
Packit 1fb8d4
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
Packit 1fb8d4
# func(std::string) {}). This also make the inheritance and collaboration
Packit 1fb8d4
# diagrams that involve STL classes more complete and accurate.
Packit 1fb8d4
Packit 1fb8d4
BUILTIN_STL_SUPPORT    = NO
Packit 1fb8d4
Packit 1fb8d4
# If you use Microsoft's C++/CLI language, you should set this option to YES to
Packit 1fb8d4
# enable parsing support.
Packit 1fb8d4
Packit 1fb8d4
CPP_CLI_SUPPORT        = NO
Packit 1fb8d4
Packit 1fb8d4
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
Packit 1fb8d4
# Doxygen will parse them like normal C++ but will assume all classes use public
Packit 1fb8d4
# instead of private inheritance when no explicit protection keyword is present.
Packit 1fb8d4
Packit 1fb8d4
SIP_SUPPORT            = NO
Packit 1fb8d4
Packit 1fb8d4
# For Microsoft's IDL there are propget and propput attributes to indicate getter
Packit 1fb8d4
# and setter methods for a property. Setting this option to YES (the default)
Packit 1fb8d4
# will make doxygen to replace the get and set methods by a property in the
Packit 1fb8d4
# documentation. This will only work if the methods are indeed getting or
Packit 1fb8d4
# setting a simple type. If this is not the case, or you want to show the
Packit 1fb8d4
# methods anyway, you should set this option to NO.
Packit 1fb8d4
Packit 1fb8d4
IDL_PROPERTY_SUPPORT   = YES
Packit 1fb8d4
Packit 1fb8d4
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
Packit 1fb8d4
# tag is set to YES, then doxygen will reuse the documentation of the first
Packit 1fb8d4
# member in the group (if any) for the other members of the group. By default
Packit 1fb8d4
# all members of a group must be documented explicitly.
Packit 1fb8d4
Packit 1fb8d4
DISTRIBUTE_GROUP_DOC   = NO
Packit 1fb8d4
Packit 1fb8d4
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
Packit 1fb8d4
# the same type (for instance a group of public functions) to be put as a
Packit 1fb8d4
# subgroup of that type (e.g. under the Public Functions section). Set it to
Packit 1fb8d4
# NO to prevent subgrouping. Alternatively, this can be done per class using
Packit 1fb8d4
# the \nosubgrouping command.
Packit 1fb8d4
Packit 1fb8d4
SUBGROUPING            = YES
Packit 1fb8d4
Packit 1fb8d4
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
Packit 1fb8d4
# is documented as struct, union, or enum with the name of the typedef. So
Packit 1fb8d4
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
Packit 1fb8d4
# with name TypeT. When disabled the typedef will appear as a member of a file,
Packit 1fb8d4
# namespace, or class. And the struct will be named TypeS. This can typically
Packit 1fb8d4
# be useful for C code in case the coding convention dictates that all compound
Packit 1fb8d4
# types are typedef'ed and only the typedef is referenced, never the tag name.
Packit 1fb8d4
Packit 1fb8d4
TYPEDEF_HIDES_STRUCT   = YES
Packit 1fb8d4
Packit 1fb8d4
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
Packit 1fb8d4
# determine which symbols to keep in memory and which to flush to disk.
Packit 1fb8d4
# When the cache is full, less often used symbols will be written to disk.
Packit 1fb8d4
# For small to medium size projects (<1000 input files) the default value is
Packit 1fb8d4
# probably good enough. For larger projects a too small cache size can cause
Packit 1fb8d4
# doxygen to be busy swapping symbols to and from disk most of the time
Packit 1fb8d4
# causing a significant performance penality.
Packit 1fb8d4
# If the system has enough physical memory increasing the cache will improve the
Packit 1fb8d4
# performance by keeping more symbols in memory. Note that the value works on
Packit 1fb8d4
# a logarithmic scale so increasing the size by one will rougly double the
Packit 1fb8d4
# memory usage. The cache size is given by this formula:
Packit 1fb8d4
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
Packit 1fb8d4
# corresponding to a cache size of 2^16 = 65536 symbols
Packit 1fb8d4
Packit 1fb8d4
SYMBOL_CACHE_SIZE      = 0
Packit 1fb8d4
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
# Build related configuration options
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
Packit 1fb8d4
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
Packit 1fb8d4
# documentation are documented, even if no documentation was available.
Packit 1fb8d4
# Private class members and static file members will be hidden unless
Packit 1fb8d4
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
Packit 1fb8d4
Packit 1fb8d4
EXTRACT_ALL            = YES
Packit 1fb8d4
Packit 1fb8d4
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
Packit 1fb8d4
# will be included in the documentation.
Packit 1fb8d4
Packit 1fb8d4
EXTRACT_PRIVATE        = NO
Packit 1fb8d4
Packit 1fb8d4
# If the EXTRACT_STATIC tag is set to YES all static members of a file
Packit 1fb8d4
# will be included in the documentation.
Packit 1fb8d4
Packit 1fb8d4
EXTRACT_STATIC         = YES
Packit 1fb8d4
Packit 1fb8d4
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
Packit 1fb8d4
# defined locally in source files will be included in the documentation.
Packit 1fb8d4
# If set to NO only classes defined in header files are included.
Packit 1fb8d4
Packit 1fb8d4
EXTRACT_LOCAL_CLASSES  = NO
Packit 1fb8d4
Packit 1fb8d4
# This flag is only useful for Objective-C code. When set to YES local
Packit 1fb8d4
# methods, which are defined in the implementation section but not in
Packit 1fb8d4
# the interface are included in the documentation.
Packit 1fb8d4
# If set to NO (the default) only methods in the interface are included.
Packit 1fb8d4
Packit 1fb8d4
EXTRACT_LOCAL_METHODS  = NO
Packit 1fb8d4
Packit 1fb8d4
# If this flag is set to YES, the members of anonymous namespaces will be
Packit 1fb8d4
# extracted and appear in the documentation as a namespace called
Packit 1fb8d4
# 'anonymous_namespace{file}', where file will be replaced with the base
Packit 1fb8d4
# name of the file that contains the anonymous namespace. By default
Packit 1fb8d4
# anonymous namespace are hidden.
Packit 1fb8d4
Packit 1fb8d4
EXTRACT_ANON_NSPACES   = NO
Packit 1fb8d4
Packit 1fb8d4
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
Packit 1fb8d4
# undocumented members of documented classes, files or namespaces.
Packit 1fb8d4
# If set to NO (the default) these members will be included in the
Packit 1fb8d4
# various overviews, but no documentation section is generated.
Packit 1fb8d4
# This option has no effect if EXTRACT_ALL is enabled.
Packit 1fb8d4
Packit 1fb8d4
HIDE_UNDOC_MEMBERS     = NO
Packit 1fb8d4
Packit 1fb8d4
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
Packit 1fb8d4
# undocumented classes that are normally visible in the class hierarchy.
Packit 1fb8d4
# If set to NO (the default) these classes will be included in the various
Packit 1fb8d4
# overviews. This option has no effect if EXTRACT_ALL is enabled.
Packit 1fb8d4
Packit 1fb8d4
HIDE_UNDOC_CLASSES     = NO
Packit 1fb8d4
Packit 1fb8d4
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
Packit 1fb8d4
# friend (class|struct|union) declarations.
Packit 1fb8d4
# If set to NO (the default) these declarations will be included in the
Packit 1fb8d4
# documentation.
Packit 1fb8d4
Packit 1fb8d4
HIDE_FRIEND_COMPOUNDS  = NO
Packit 1fb8d4
Packit 1fb8d4
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
Packit 1fb8d4
# documentation blocks found inside the body of a function.
Packit 1fb8d4
# If set to NO (the default) these blocks will be appended to the
Packit 1fb8d4
# function's detailed documentation block.
Packit 1fb8d4
Packit 1fb8d4
HIDE_IN_BODY_DOCS      = NO
Packit 1fb8d4
Packit 1fb8d4
# The INTERNAL_DOCS tag determines if documentation
Packit 1fb8d4
# that is typed after a \internal command is included. If the tag is set
Packit 1fb8d4
# to NO (the default) then the documentation will be excluded.
Packit 1fb8d4
# Set it to YES to include the internal documentation.
Packit 1fb8d4
Packit 1fb8d4
INTERNAL_DOCS          = NO
Packit 1fb8d4
Packit 1fb8d4
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
Packit 1fb8d4
# file names in lower-case letters. If set to YES upper-case letters are also
Packit 1fb8d4
# allowed. This is useful if you have classes or files whose names only differ
Packit 1fb8d4
# in case and if your file system supports case sensitive file names. Windows
Packit 1fb8d4
# and Mac users are advised to set this option to NO.
Packit 1fb8d4
Packit 1fb8d4
CASE_SENSE_NAMES       = YES
Packit 1fb8d4
Packit 1fb8d4
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
Packit 1fb8d4
# will show members with their full class and namespace scopes in the
Packit 1fb8d4
# documentation. If set to YES the scope will be hidden.
Packit 1fb8d4
Packit 1fb8d4
HIDE_SCOPE_NAMES       = NO
Packit 1fb8d4
Packit 1fb8d4
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
Packit 1fb8d4
# will put a list of the files that are included by a file in the documentation
Packit 1fb8d4
# of that file.
Packit 1fb8d4
Packit 1fb8d4
SHOW_INCLUDE_FILES     = YES
Packit 1fb8d4
Packit 1fb8d4
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
Packit 1fb8d4
# is inserted in the documentation for inline members.
Packit 1fb8d4
Packit 1fb8d4
INLINE_INFO            = YES
Packit 1fb8d4
Packit 1fb8d4
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
Packit 1fb8d4
# will sort the (detailed) documentation of file and class members
Packit 1fb8d4
# alphabetically by member name. If set to NO the members will appear in
Packit 1fb8d4
# declaration order.
Packit 1fb8d4
Packit 1fb8d4
SORT_MEMBER_DOCS       = YES
Packit 1fb8d4
Packit 1fb8d4
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
Packit 1fb8d4
# brief documentation of file, namespace and class members alphabetically
Packit 1fb8d4
# by member name. If set to NO (the default) the members will appear in
Packit 1fb8d4
# declaration order.
Packit 1fb8d4
Packit 1fb8d4
SORT_BRIEF_DOCS        = NO
Packit 1fb8d4
Packit 1fb8d4
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
Packit 1fb8d4
Packit 1fb8d4
SORT_MEMBERS_CTORS_1ST = NO
Packit 1fb8d4
Packit 1fb8d4
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
Packit 1fb8d4
# hierarchy of group names into alphabetical order. If set to NO (the default)
Packit 1fb8d4
# the group names will appear in their defined order.
Packit 1fb8d4
Packit 1fb8d4
SORT_GROUP_NAMES       = NO
Packit 1fb8d4
Packit 1fb8d4
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
Packit 1fb8d4
# sorted by fully-qualified names, including namespaces. If set to
Packit 1fb8d4
# NO (the default), the class list will be sorted only by class name,
Packit 1fb8d4
# not including the namespace part.
Packit 1fb8d4
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
Packit 1fb8d4
# Note: This option applies only to the class list, not to the
Packit 1fb8d4
# alphabetical list.
Packit 1fb8d4
Packit 1fb8d4
SORT_BY_SCOPE_NAME     = NO
Packit 1fb8d4
Packit 1fb8d4
# The GENERATE_TODOLIST tag can be used to enable (YES) or
Packit 1fb8d4
# disable (NO) the todo list. This list is created by putting \todo
Packit 1fb8d4
# commands in the documentation.
Packit 1fb8d4
Packit 1fb8d4
GENERATE_TODOLIST      = NO
Packit 1fb8d4
Packit 1fb8d4
# The GENERATE_TESTLIST tag can be used to enable (YES) or
Packit 1fb8d4
# disable (NO) the test list. This list is created by putting \test
Packit 1fb8d4
# commands in the documentation.
Packit 1fb8d4
Packit 1fb8d4
GENERATE_TESTLIST      = NO
Packit 1fb8d4
Packit 1fb8d4
# The GENERATE_BUGLIST tag can be used to enable (YES) or
Packit 1fb8d4
# disable (NO) the bug list. This list is created by putting \bug
Packit 1fb8d4
# commands in the documentation.
Packit 1fb8d4
Packit 1fb8d4
GENERATE_BUGLIST       = NO
Packit 1fb8d4
Packit 1fb8d4
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
Packit 1fb8d4
# disable (NO) the deprecated list. This list is created by putting
Packit 1fb8d4
# \deprecated commands in the documentation.
Packit 1fb8d4
Packit 1fb8d4
GENERATE_DEPRECATEDLIST= NO
Packit 1fb8d4
Packit 1fb8d4
# The ENABLED_SECTIONS tag can be used to enable conditional
Packit 1fb8d4
# documentation sections, marked by \if sectionname ... \endif.
Packit 1fb8d4
Packit 1fb8d4
ENABLED_SECTIONS       = YES
Packit 1fb8d4
Packit 1fb8d4
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
Packit 1fb8d4
# the initial value of a variable or define consists of for it to appear in
Packit 1fb8d4
# the documentation. If the initializer consists of more lines than specified
Packit 1fb8d4
# here it will be hidden. Use a value of 0 to hide initializers completely.
Packit 1fb8d4
# The appearance of the initializer of individual variables and defines in the
Packit 1fb8d4
# documentation can be controlled using \showinitializer or \hideinitializer
Packit 1fb8d4
# command in the documentation regardless of this setting.
Packit 1fb8d4
Packit 1fb8d4
MAX_INITIALIZER_LINES  = 30
Packit 1fb8d4
Packit 1fb8d4
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
Packit 1fb8d4
# at the bottom of the documentation of classes and structs. If set to YES the
Packit 1fb8d4
# list will mention the files that were used to generate the documentation.
Packit 1fb8d4
Packit 1fb8d4
SHOW_USED_FILES        = YES
Packit 1fb8d4
Packit 1fb8d4
# If the sources in your project are distributed over multiple directories
Packit 1fb8d4
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
Packit 1fb8d4
# in the documentation. The default is NO.
Packit 1fb8d4
Packit 1fb8d4
SHOW_DIRECTORIES       = YES
Packit 1fb8d4
Packit 1fb8d4
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
Packit 1fb8d4
# This will remove the Files entry from the Quick Index and from the
Packit 1fb8d4
# Folder Tree View (if specified). The default is YES.
Packit 1fb8d4
Packit 1fb8d4
SHOW_FILES             = YES
Packit 1fb8d4
Packit 1fb8d4
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
Packit 1fb8d4
# Namespaces page.
Packit 1fb8d4
# This will remove the Namespaces entry from the Quick Index
Packit 1fb8d4
# and from the Folder Tree View (if specified). The default is YES.
Packit 1fb8d4
Packit 1fb8d4
SHOW_NAMESPACES        = YES
Packit 1fb8d4
Packit 1fb8d4
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
Packit 1fb8d4
# doxygen should invoke to get the current version for each file (typically from
Packit 1fb8d4
# the version control system). Doxygen will invoke the program by executing (via
Packit 1fb8d4
# popen()) the command <command> <input-file>, where <command> is the value of
Packit 1fb8d4
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
Packit 1fb8d4
# provided by doxygen. Whatever the program writes to standard output
Packit 1fb8d4
# is used as the file version. See the manual for examples.
Packit 1fb8d4
Packit 1fb8d4
FILE_VERSION_FILTER    =
Packit 1fb8d4
Packit 1fb8d4
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
Packit 1fb8d4
# doxygen. The layout file controls the global structure of the generated output files
Packit 1fb8d4
# in an output format independent way. The create the layout file that represents
Packit 1fb8d4
# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
Packit 1fb8d4
# file name after the option, if omitted DoxygenLayout.xml will be used as the name
Packit 1fb8d4
# of the layout file.
Packit 1fb8d4
Packit 1fb8d4
LAYOUT_FILE            =
Packit 1fb8d4
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
# configuration options related to warning and progress messages
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
Packit 1fb8d4
# The QUIET tag can be used to turn on/off the messages that are generated
Packit 1fb8d4
# by doxygen. Possible values are YES and NO. If left blank NO is used.
Packit 1fb8d4
Packit 1fb8d4
QUIET                  = YES
Packit 1fb8d4
Packit 1fb8d4
# The WARNINGS tag can be used to turn on/off the warning messages that are
Packit 1fb8d4
# generated by doxygen. Possible values are YES and NO. If left blank
Packit 1fb8d4
# NO is used.
Packit 1fb8d4
Packit 1fb8d4
WARNINGS               = YES
Packit 1fb8d4
Packit 1fb8d4
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
Packit 1fb8d4
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
Packit 1fb8d4
# automatically be disabled.
Packit 1fb8d4
Packit 1fb8d4
WARN_IF_UNDOCUMENTED   = YES
Packit 1fb8d4
Packit 1fb8d4
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
Packit 1fb8d4
# potential errors in the documentation, such as not documenting some
Packit 1fb8d4
# parameters in a documented function, or documenting parameters that
Packit 1fb8d4
# don't exist or using markup commands wrongly.
Packit 1fb8d4
Packit 1fb8d4
WARN_IF_DOC_ERROR      = YES
Packit 1fb8d4
Packit 1fb8d4
# This WARN_NO_PARAMDOC option can be abled to get warnings for
Packit 1fb8d4
# functions that are documented, but have no documentation for their parameters
Packit 1fb8d4
# or return value. If set to NO (the default) doxygen will only warn about
Packit 1fb8d4
# wrong or incomplete parameter documentation, but not about the absence of
Packit 1fb8d4
# documentation.
Packit 1fb8d4
Packit 1fb8d4
WARN_NO_PARAMDOC       = NO
Packit 1fb8d4
Packit 1fb8d4
# The WARN_FORMAT tag determines the format of the warning messages that
Packit 1fb8d4
# doxygen can produce. The string should contain the $file, $line, and $text
Packit 1fb8d4
# tags, which will be replaced by the file and line number from which the
Packit 1fb8d4
# warning originated and the warning text. Optionally the format may contain
Packit 1fb8d4
# $version, which will be replaced by the version of the file (if it could
Packit 1fb8d4
# be obtained via FILE_VERSION_FILTER)
Packit 1fb8d4
Packit 1fb8d4
WARN_FORMAT            = "$file:$line: $text"
Packit 1fb8d4
Packit 1fb8d4
# The WARN_LOGFILE tag can be used to specify a file to which warning
Packit 1fb8d4
# and error messages should be written. If left blank the output is written
Packit 1fb8d4
# to stderr.
Packit 1fb8d4
Packit 1fb8d4
WARN_LOGFILE           =
Packit 1fb8d4
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
# configuration options related to the input files
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
Packit 1fb8d4
# The INPUT tag can be used to specify the files and/or directories that contain
Packit 1fb8d4
# documented source files. You may enter file names like "myfile.cpp" or
Packit 1fb8d4
# directories like "/usr/src/myproject". Separate the files or directories
Packit 1fb8d4
# with spaces.
Packit 1fb8d4
Packit 1fb8d4
INPUT                  = ..
Packit 1fb8d4
Packit 1fb8d4
# This tag can be used to specify the character encoding of the source files
Packit 1fb8d4
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
Packit 1fb8d4
# also the default input encoding. Doxygen uses libiconv (or the iconv built
Packit 1fb8d4
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
Packit 1fb8d4
# the list of possible encodings.
Packit 1fb8d4
Packit 1fb8d4
INPUT_ENCODING         = UTF-8
Packit 1fb8d4
Packit 1fb8d4
# If the value of the INPUT tag contains directories, you can use the
Packit 1fb8d4
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
Packit 1fb8d4
# and *.h) to filter out the source-files in the directories. If left
Packit 1fb8d4
# blank the following patterns are tested:
Packit 1fb8d4
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
Packit 1fb8d4
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
Packit 1fb8d4
Packit 1fb8d4
FILE_PATTERNS          =
Packit 1fb8d4
Packit 1fb8d4
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
Packit 1fb8d4
# should be searched for input files as well. Possible values are YES and NO.
Packit 1fb8d4
# If left blank NO is used.
Packit 1fb8d4
Packit 1fb8d4
RECURSIVE              = YES
Packit 1fb8d4
Packit 1fb8d4
# The EXCLUDE tag can be used to specify files and/or directories that should
Packit 1fb8d4
# excluded from the INPUT source files. This way you can easily exclude a
Packit 1fb8d4
# subdirectory from a directory tree whose root is specified with the INPUT tag.
Packit 1fb8d4
Packit 1fb8d4
EXCLUDE                = ../build ../cmake ../CMakeFiles ../cunit ../docs ../keymaps ../resources
Packit 1fb8d4
Packit 1fb8d4
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
Packit 1fb8d4
# directories that are symbolic links (a Unix filesystem feature) are excluded
Packit 1fb8d4
# from the input.
Packit 1fb8d4
Packit 1fb8d4
EXCLUDE_SYMLINKS       = NO
Packit 1fb8d4
Packit 1fb8d4
# If the value of the INPUT tag contains directories, you can use the
Packit 1fb8d4
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
Packit 1fb8d4
# certain files from those directories. Note that the wildcards are matched
Packit 1fb8d4
# against the file with absolute path, so to exclude all test directories
Packit 1fb8d4
# for example use the pattern */test/*
Packit 1fb8d4
Packit 1fb8d4
EXCLUDE_PATTERNS       =
Packit 1fb8d4
Packit 1fb8d4
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
Packit 1fb8d4
# (namespaces, classes, functions, etc.) that should be excluded from the
Packit 1fb8d4
# output. The symbol name can be a fully qualified name, a word, or if the
Packit 1fb8d4
# wildcard * is used, a substring. Examples: ANamespace, AClass,
Packit 1fb8d4
# AClass::ANamespace, ANamespace::*Test
Packit 1fb8d4
Packit 1fb8d4
EXCLUDE_SYMBOLS        =
Packit 1fb8d4
Packit 1fb8d4
# The EXAMPLE_PATH tag can be used to specify one or more files or
Packit 1fb8d4
# directories that contain example code fragments that are included (see
Packit 1fb8d4
# the \include command).
Packit 1fb8d4
Packit 1fb8d4
EXAMPLE_PATH           =
Packit 1fb8d4
Packit 1fb8d4
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
Packit 1fb8d4
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
Packit 1fb8d4
# and *.h) to filter out the source-files in the directories. If left
Packit 1fb8d4
# blank all files are included.
Packit 1fb8d4
Packit 1fb8d4
EXAMPLE_PATTERNS       =
Packit 1fb8d4
Packit 1fb8d4
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
Packit 1fb8d4
# searched for input files to be used with the \include or \dontinclude
Packit 1fb8d4
# commands irrespective of the value of the RECURSIVE tag.
Packit 1fb8d4
# Possible values are YES and NO. If left blank NO is used.
Packit 1fb8d4
Packit 1fb8d4
EXAMPLE_RECURSIVE      = NO
Packit 1fb8d4
Packit 1fb8d4
# The IMAGE_PATH tag can be used to specify one or more files or
Packit 1fb8d4
# directories that contain image that are included in the documentation (see
Packit 1fb8d4
# the \image command).
Packit 1fb8d4
Packit 1fb8d4
IMAGE_PATH             =
Packit 1fb8d4
Packit 1fb8d4
# The INPUT_FILTER tag can be used to specify a program that doxygen should
Packit 1fb8d4
# invoke to filter for each input file. Doxygen will invoke the filter program
Packit 1fb8d4
# by executing (via popen()) the command <filter> <input-file>, where <filter>
Packit 1fb8d4
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
Packit 1fb8d4
# input file. Doxygen will then use the output that the filter program writes
Packit 1fb8d4
# to standard output.
Packit 1fb8d4
# If FILTER_PATTERNS is specified, this tag will be
Packit 1fb8d4
# ignored.
Packit 1fb8d4
Packit 1fb8d4
INPUT_FILTER           =
Packit 1fb8d4
Packit 1fb8d4
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
Packit 1fb8d4
# basis.
Packit 1fb8d4
# Doxygen will compare the file name with each pattern and apply the
Packit 1fb8d4
# filter if there is a match.
Packit 1fb8d4
# The filters are a list of the form:
Packit 1fb8d4
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
Packit 1fb8d4
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
Packit 1fb8d4
# is applied to all files.
Packit 1fb8d4
Packit 1fb8d4
FILTER_PATTERNS        =
Packit 1fb8d4
Packit 1fb8d4
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
Packit 1fb8d4
# INPUT_FILTER) will be used to filter the input files when producing source
Packit 1fb8d4
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
Packit 1fb8d4
Packit 1fb8d4
FILTER_SOURCE_FILES    = NO
Packit 1fb8d4
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
# configuration options related to source browsing
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
Packit 1fb8d4
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
Packit 1fb8d4
# be generated. Documented entities will be cross-referenced with these sources.
Packit 1fb8d4
# Note: To get rid of all source code in the generated output, make sure also
Packit 1fb8d4
# VERBATIM_HEADERS is set to NO.
Packit 1fb8d4
Packit 1fb8d4
SOURCE_BROWSER         = NO
Packit 1fb8d4
Packit 1fb8d4
# Setting the INLINE_SOURCES tag to YES will include the body
Packit 1fb8d4
# of functions and classes directly in the documentation.
Packit 1fb8d4
Packit 1fb8d4
INLINE_SOURCES         = NO
Packit 1fb8d4
Packit 1fb8d4
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
Packit 1fb8d4
# doxygen to hide any special comment blocks from generated source code
Packit 1fb8d4
# fragments. Normal C and C++ comments will always remain visible.
Packit 1fb8d4
Packit 1fb8d4
STRIP_CODE_COMMENTS    = YES
Packit 1fb8d4
Packit 1fb8d4
# If the REFERENCED_BY_RELATION tag is set to YES
Packit 1fb8d4
# then for each documented function all documented
Packit 1fb8d4
# functions referencing it will be listed.
Packit 1fb8d4
Packit 1fb8d4
REFERENCED_BY_RELATION = NO
Packit 1fb8d4
Packit 1fb8d4
# If the REFERENCES_RELATION tag is set to YES
Packit 1fb8d4
# then for each documented function all documented entities
Packit 1fb8d4
# called/used by that function will be listed.
Packit 1fb8d4
Packit 1fb8d4
REFERENCES_RELATION    = NO
Packit 1fb8d4
Packit 1fb8d4
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
Packit 1fb8d4
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
Packit 1fb8d4
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
Packit 1fb8d4
# link to the source code.
Packit 1fb8d4
# Otherwise they will link to the documentation.
Packit 1fb8d4
Packit 1fb8d4
REFERENCES_LINK_SOURCE = YES
Packit 1fb8d4
Packit 1fb8d4
# If the USE_HTAGS tag is set to YES then the references to source code
Packit 1fb8d4
# will point to the HTML generated by the htags(1) tool instead of doxygen
Packit 1fb8d4
# built-in source browser. The htags tool is part of GNU's global source
Packit 1fb8d4
# tagging system (see http://www.gnu.org/software/global/global.html). You
Packit 1fb8d4
# will need version 4.8.6 or higher.
Packit 1fb8d4
Packit 1fb8d4
USE_HTAGS              = NO
Packit 1fb8d4
Packit 1fb8d4
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
Packit 1fb8d4
# will generate a verbatim copy of the header file for each class for
Packit 1fb8d4
# which an include is specified. Set to NO to disable this.
Packit 1fb8d4
Packit 1fb8d4
VERBATIM_HEADERS       = NO
Packit 1fb8d4
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
# configuration options related to the alphabetical class index
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
Packit 1fb8d4
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
Packit 1fb8d4
# of all compounds will be generated. Enable this if the project
Packit 1fb8d4
# contains a lot of classes, structs, unions or interfaces.
Packit 1fb8d4
Packit 1fb8d4
ALPHABETICAL_INDEX     = NO
Packit 1fb8d4
Packit 1fb8d4
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
Packit 1fb8d4
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
Packit 1fb8d4
# in which this list will be split (can be a number in the range [1..20])
Packit 1fb8d4
Packit 1fb8d4
COLS_IN_ALPHA_INDEX    = 5
Packit 1fb8d4
Packit 1fb8d4
# In case all classes in a project start with a common prefix, all
Packit 1fb8d4
# classes will be put under the same header in the alphabetical index.
Packit 1fb8d4
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
Packit 1fb8d4
# should be ignored while generating the index headers.
Packit 1fb8d4
Packit 1fb8d4
IGNORE_PREFIX          =
Packit 1fb8d4
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
# configuration options related to the HTML output
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
Packit 1fb8d4
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
Packit 1fb8d4
# generate HTML output.
Packit 1fb8d4
Packit 1fb8d4
GENERATE_HTML          = YES
Packit 1fb8d4
Packit 1fb8d4
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
Packit 1fb8d4
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
Packit 1fb8d4
# put in front of it. If left blank `html' will be used as the default path.
Packit 1fb8d4
Packit 1fb8d4
HTML_OUTPUT            = api
Packit 1fb8d4
Packit 1fb8d4
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
Packit 1fb8d4
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
Packit 1fb8d4
# doxygen will generate files with .html extension.
Packit 1fb8d4
Packit 1fb8d4
HTML_FILE_EXTENSION    = .html
Packit 1fb8d4
Packit 1fb8d4
# The HTML_HEADER tag can be used to specify a personal HTML header for
Packit 1fb8d4
# each generated HTML page. If it is left blank doxygen will generate a
Packit 1fb8d4
# standard header.
Packit 1fb8d4
Packit 1fb8d4
HTML_HEADER            =
Packit 1fb8d4
Packit 1fb8d4
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
Packit 1fb8d4
# each generated HTML page. If it is left blank doxygen will generate a
Packit 1fb8d4
# standard footer.
Packit 1fb8d4
Packit 1fb8d4
HTML_FOOTER            =
Packit 1fb8d4
Packit 1fb8d4
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
Packit 1fb8d4
# style sheet that is used by each HTML page. It can be used to
Packit 1fb8d4
# fine-tune the look of the HTML output. If the tag is left blank doxygen
Packit 1fb8d4
# will generate a default style sheet. Note that doxygen will try to copy
Packit 1fb8d4
# the style sheet file to the HTML output directory, so don't put your own
Packit 1fb8d4
# stylesheet in the HTML output directory as well, or it will be erased!
Packit 1fb8d4
Packit 1fb8d4
HTML_STYLESHEET        =
Packit 1fb8d4
Packit 1fb8d4
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
Packit 1fb8d4
# files or namespaces will be aligned in HTML using tables. If set to
Packit 1fb8d4
# NO a bullet list will be used.
Packit 1fb8d4
Packit 1fb8d4
HTML_ALIGN_MEMBERS     = YES
Packit 1fb8d4
Packit 1fb8d4
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
Packit 1fb8d4
# documentation will contain sections that can be hidden and shown after the
Packit 1fb8d4
# page has loaded. For this to work a browser that supports
Packit 1fb8d4
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
Packit 1fb8d4
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
Packit 1fb8d4
Packit 1fb8d4
HTML_DYNAMIC_SECTIONS  = NO
Packit 1fb8d4
Packit 1fb8d4
# If the GENERATE_DOCSET tag is set to YES, additional index files
Packit 1fb8d4
# will be generated that can be used as input for Apple's Xcode 3
Packit 1fb8d4
# integrated development environment, introduced with OSX 10.5 (Leopard).
Packit 1fb8d4
# To create a documentation set, doxygen will generate a Makefile in the
Packit 1fb8d4
# HTML output directory. Running make will produce the docset in that
Packit 1fb8d4
# directory and running "make install" will install the docset in
Packit 1fb8d4
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
Packit 1fb8d4
# it at startup.
Packit 1fb8d4
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
Packit 1fb8d4
Packit 1fb8d4
GENERATE_DOCSET        = NO
Packit 1fb8d4
Packit 1fb8d4
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
Packit 1fb8d4
# feed. A documentation feed provides an umbrella under which multiple
Packit 1fb8d4
# documentation sets from a single provider (such as a company or product suite)
Packit 1fb8d4
# can be grouped.
Packit 1fb8d4
Packit 1fb8d4
DOCSET_FEEDNAME        = "Doxygen generated docs"
Packit 1fb8d4
Packit 1fb8d4
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
Packit 1fb8d4
# should uniquely identify the documentation set bundle. This should be a
Packit 1fb8d4
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
Packit 1fb8d4
# will append .docset to the name.
Packit 1fb8d4
Packit 1fb8d4
DOCSET_BUNDLE_ID       = org.doxygen.freerdp
Packit 1fb8d4
Packit 1fb8d4
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
Packit 1fb8d4
# will be generated that can be used as input for tools like the
Packit 1fb8d4
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
Packit 1fb8d4
# of the generated HTML documentation.
Packit 1fb8d4
Packit 1fb8d4
GENERATE_HTMLHELP      = NO
Packit 1fb8d4
Packit 1fb8d4
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
Packit 1fb8d4
# be used to specify the file name of the resulting .chm file. You
Packit 1fb8d4
# can add a path in front of the file if the result should not be
Packit 1fb8d4
# written to the html output directory.
Packit 1fb8d4
Packit 1fb8d4
CHM_FILE               =
Packit 1fb8d4
Packit 1fb8d4
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
Packit 1fb8d4
# be used to specify the location (absolute path including file name) of
Packit 1fb8d4
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
Packit 1fb8d4
# the HTML help compiler on the generated index.hhp.
Packit 1fb8d4
Packit 1fb8d4
HHC_LOCATION           =
Packit 1fb8d4
Packit 1fb8d4
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
Packit 1fb8d4
# controls if a separate .chi index file is generated (YES) or that
Packit 1fb8d4
# it should be included in the master .chm file (NO).
Packit 1fb8d4
Packit 1fb8d4
GENERATE_CHI           = NO
Packit 1fb8d4
Packit 1fb8d4
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
Packit 1fb8d4
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
Packit 1fb8d4
# content.
Packit 1fb8d4
Packit 1fb8d4
CHM_INDEX_ENCODING     =
Packit 1fb8d4
Packit 1fb8d4
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
Packit 1fb8d4
# controls whether a binary table of contents is generated (YES) or a
Packit 1fb8d4
# normal table of contents (NO) in the .chm file.
Packit 1fb8d4
Packit 1fb8d4
BINARY_TOC             = NO
Packit 1fb8d4
Packit 1fb8d4
# The TOC_EXPAND flag can be set to YES to add extra items for group members
Packit 1fb8d4
# to the contents of the HTML help documentation and to the tree view.
Packit 1fb8d4
Packit 1fb8d4
TOC_EXPAND             = NO
Packit 1fb8d4
Packit 1fb8d4
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
Packit 1fb8d4
# are set, an additional index file will be generated that can be used as input for
Packit 1fb8d4
# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
Packit 1fb8d4
# HTML documentation.
Packit 1fb8d4
Packit 1fb8d4
GENERATE_QHP           = NO
Packit 1fb8d4
Packit 1fb8d4
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
Packit 1fb8d4
# be used to specify the file name of the resulting .qch file.
Packit 1fb8d4
# The path specified is relative to the HTML output folder.
Packit 1fb8d4
Packit 1fb8d4
QCH_FILE               =
Packit 1fb8d4
Packit 1fb8d4
# The QHP_NAMESPACE tag specifies the namespace to use when generating
Packit 1fb8d4
# Qt Help Project output. For more information please see
Packit 1fb8d4
# http://doc.trolltech.com/qthelpproject.html#namespace
Packit 1fb8d4
Packit 1fb8d4
QHP_NAMESPACE          =
Packit 1fb8d4
Packit 1fb8d4
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
Packit 1fb8d4
# Qt Help Project output. For more information please see
Packit 1fb8d4
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
Packit 1fb8d4
Packit 1fb8d4
QHP_VIRTUAL_FOLDER     = doc
Packit 1fb8d4
Packit 1fb8d4
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
Packit 1fb8d4
# For more information please see
Packit 1fb8d4
# http://doc.trolltech.com/qthelpproject.html#custom-filters
Packit 1fb8d4
Packit 1fb8d4
QHP_CUST_FILTER_NAME   =
Packit 1fb8d4
Packit 1fb8d4
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
Packit 1fb8d4
# Qt Help Project / Custom Filters.
Packit 1fb8d4
Packit 1fb8d4
QHP_CUST_FILTER_ATTRS  =
Packit 1fb8d4
Packit 1fb8d4
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
Packit 1fb8d4
# filter section matches.
Packit 1fb8d4
# Qt Help Project / Filter Attributes.
Packit 1fb8d4
Packit 1fb8d4
QHP_SECT_FILTER_ATTRS  =
Packit 1fb8d4
Packit 1fb8d4
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
Packit 1fb8d4
# be used to specify the location of Qt's qhelpgenerator.
Packit 1fb8d4
# If non-empty doxygen will try to run qhelpgenerator on the generated
Packit 1fb8d4
# .qhp file.
Packit 1fb8d4
Packit 1fb8d4
QHG_LOCATION           =
Packit 1fb8d4
Packit 1fb8d4
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
Packit 1fb8d4
# top of each HTML page. The value NO (the default) enables the index and
Packit 1fb8d4
# the value YES disables it.
Packit 1fb8d4
Packit 1fb8d4
DISABLE_INDEX          = NO
Packit 1fb8d4
Packit 1fb8d4
# This tag can be used to set the number of enum values (range [1..20])
Packit 1fb8d4
# that doxygen will group on one line in the generated HTML documentation.
Packit 1fb8d4
Packit 1fb8d4
ENUM_VALUES_PER_LINE   = 4
Packit 1fb8d4
Packit 1fb8d4
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
Packit 1fb8d4
# structure should be generated to display hierarchical information.
Packit 1fb8d4
# If the tag value is set to YES, a side panel will be generated
Packit 1fb8d4
# containing a tree-like index structure (just like the one that
Packit 1fb8d4
# is generated for HTML Help). For this to work a browser that supports
Packit 1fb8d4
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
Packit 1fb8d4
# Windows users are probably better off using the HTML help feature.
Packit 1fb8d4
Packit 1fb8d4
GENERATE_TREEVIEW      = YES
Packit 1fb8d4
Packit 1fb8d4
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
Packit 1fb8d4
# and Class Hierarchy pages using a tree view instead of an ordered list.
Packit 1fb8d4
Packit 1fb8d4
USE_INLINE_TREES       = YES
Packit 1fb8d4
Packit 1fb8d4
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
Packit 1fb8d4
# used to set the initial width (in pixels) of the frame in which the tree
Packit 1fb8d4
# is shown.
Packit 1fb8d4
Packit 1fb8d4
TREEVIEW_WIDTH         = 250
Packit 1fb8d4
Packit 1fb8d4
# Use this tag to change the font size of Latex formulas included
Packit 1fb8d4
# as images in the HTML documentation. The default is 10. Note that
Packit 1fb8d4
# when you change the font size after a successful doxygen run you need
Packit 1fb8d4
# to manually remove any form_*.png images from the HTML output directory
Packit 1fb8d4
# to force them to be regenerated.
Packit 1fb8d4
Packit 1fb8d4
FORMULA_FONTSIZE       = 10
Packit 1fb8d4
Packit 1fb8d4
# When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
Packit 1fb8d4
# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
Packit 1fb8d4
# there is already a search function so this one should typically
Packit 1fb8d4
# be disabled.
Packit 1fb8d4
Packit 1fb8d4
SEARCHENGINE           = YES
Packit 1fb8d4
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
# configuration options related to the LaTeX output
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
Packit 1fb8d4
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
Packit 1fb8d4
# generate Latex output.
Packit 1fb8d4
Packit 1fb8d4
GENERATE_LATEX         = NO
Packit 1fb8d4
Packit 1fb8d4
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
Packit 1fb8d4
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
Packit 1fb8d4
# put in front of it. If left blank `latex' will be used as the default path.
Packit 1fb8d4
Packit 1fb8d4
LATEX_OUTPUT           = latex
Packit 1fb8d4
Packit 1fb8d4
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
Packit 1fb8d4
# invoked. If left blank `latex' will be used as the default command name.
Packit 1fb8d4
Packit 1fb8d4
LATEX_CMD_NAME         = latex
Packit 1fb8d4
Packit 1fb8d4
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
Packit 1fb8d4
# generate index for LaTeX. If left blank `makeindex' will be used as the
Packit 1fb8d4
# default command name.
Packit 1fb8d4
Packit 1fb8d4
MAKEINDEX_CMD_NAME     = makeindex
Packit 1fb8d4
Packit 1fb8d4
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
Packit 1fb8d4
# LaTeX documents. This may be useful for small projects and may help to
Packit 1fb8d4
# save some trees in general.
Packit 1fb8d4
Packit 1fb8d4
COMPACT_LATEX          = NO
Packit 1fb8d4
Packit 1fb8d4
# The PAPER_TYPE tag can be used to set the paper type that is used
Packit 1fb8d4
# by the printer. Possible values are: a4, a4wide, letter, legal and
Packit 1fb8d4
# executive. If left blank a4wide will be used.
Packit 1fb8d4
Packit 1fb8d4
PAPER_TYPE             = a4wide
Packit 1fb8d4
Packit 1fb8d4
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
Packit 1fb8d4
# packages that should be included in the LaTeX output.
Packit 1fb8d4
Packit 1fb8d4
EXTRA_PACKAGES         =
Packit 1fb8d4
Packit 1fb8d4
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
Packit 1fb8d4
# the generated latex document. The header should contain everything until
Packit 1fb8d4
# the first chapter. If it is left blank doxygen will generate a
Packit 1fb8d4
# standard header. Notice: only use this tag if you know what you are doing!
Packit 1fb8d4
Packit 1fb8d4
LATEX_HEADER           =
Packit 1fb8d4
Packit 1fb8d4
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
Packit 1fb8d4
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
Packit 1fb8d4
# contain links (just like the HTML output) instead of page references
Packit 1fb8d4
# This makes the output suitable for online browsing using a pdf viewer.
Packit 1fb8d4
Packit 1fb8d4
PDF_HYPERLINKS         = YES
Packit 1fb8d4
Packit 1fb8d4
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
Packit 1fb8d4
# plain latex in the generated Makefile. Set this option to YES to get a
Packit 1fb8d4
# higher quality PDF documentation.
Packit 1fb8d4
Packit 1fb8d4
USE_PDFLATEX           = YES
Packit 1fb8d4
Packit 1fb8d4
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
Packit 1fb8d4
# command to the generated LaTeX files. This will instruct LaTeX to keep
Packit 1fb8d4
# running if errors occur, instead of asking the user for help.
Packit 1fb8d4
# This option is also used when generating formulas in HTML.
Packit 1fb8d4
Packit 1fb8d4
LATEX_BATCHMODE        = NO
Packit 1fb8d4
Packit 1fb8d4
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
Packit 1fb8d4
# include the index chapters (such as File Index, Compound Index, etc.)
Packit 1fb8d4
# in the output.
Packit 1fb8d4
Packit 1fb8d4
LATEX_HIDE_INDICES     = NO
Packit 1fb8d4
Packit 1fb8d4
# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
Packit 1fb8d4
Packit 1fb8d4
LATEX_SOURCE_CODE      = NO
Packit 1fb8d4
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
# configuration options related to the RTF output
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
Packit 1fb8d4
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
Packit 1fb8d4
# The RTF output is optimized for Word 97 and may not look very pretty with
Packit 1fb8d4
# other RTF readers or editors.
Packit 1fb8d4
Packit 1fb8d4
GENERATE_RTF           = NO
Packit 1fb8d4
Packit 1fb8d4
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
Packit 1fb8d4
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
Packit 1fb8d4
# put in front of it. If left blank `rtf' will be used as the default path.
Packit 1fb8d4
Packit 1fb8d4
RTF_OUTPUT             = rtf
Packit 1fb8d4
Packit 1fb8d4
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
Packit 1fb8d4
# RTF documents. This may be useful for small projects and may help to
Packit 1fb8d4
# save some trees in general.
Packit 1fb8d4
Packit 1fb8d4
COMPACT_RTF            = NO
Packit 1fb8d4
Packit 1fb8d4
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
Packit 1fb8d4
# will contain hyperlink fields. The RTF file will
Packit 1fb8d4
# contain links (just like the HTML output) instead of page references.
Packit 1fb8d4
# This makes the output suitable for online browsing using WORD or other
Packit 1fb8d4
# programs which support those fields.
Packit 1fb8d4
# Note: wordpad (write) and others do not support links.
Packit 1fb8d4
Packit 1fb8d4
RTF_HYPERLINKS         = NO
Packit 1fb8d4
Packit 1fb8d4
# Load stylesheet definitions from file. Syntax is similar to doxygen's
Packit 1fb8d4
# config file, i.e. a series of assignments. You only have to provide
Packit 1fb8d4
# replacements, missing definitions are set to their default value.
Packit 1fb8d4
Packit 1fb8d4
RTF_STYLESHEET_FILE    =
Packit 1fb8d4
Packit 1fb8d4
# Set optional variables used in the generation of an rtf document.
Packit 1fb8d4
# Syntax is similar to doxygen's config file.
Packit 1fb8d4
Packit 1fb8d4
RTF_EXTENSIONS_FILE    =
Packit 1fb8d4
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
# configuration options related to the man page output
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
Packit 1fb8d4
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
Packit 1fb8d4
# generate man pages
Packit 1fb8d4
Packit 1fb8d4
GENERATE_MAN           = NO
Packit 1fb8d4
Packit 1fb8d4
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
Packit 1fb8d4
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
Packit 1fb8d4
# put in front of it. If left blank `man' will be used as the default path.
Packit 1fb8d4
Packit 1fb8d4
MAN_OUTPUT             = man
Packit 1fb8d4
Packit 1fb8d4
# The MAN_EXTENSION tag determines the extension that is added to
Packit 1fb8d4
# the generated man pages (default is the subroutine's section .3)
Packit 1fb8d4
Packit 1fb8d4
MAN_EXTENSION          = .3
Packit 1fb8d4
Packit 1fb8d4
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
Packit 1fb8d4
# then it will generate one additional man file for each entity
Packit 1fb8d4
# documented in the real man page(s). These additional files
Packit 1fb8d4
# only source the real man page, but without them the man command
Packit 1fb8d4
# would be unable to find the correct page. The default is NO.
Packit 1fb8d4
Packit 1fb8d4
MAN_LINKS              = NO
Packit 1fb8d4
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
# configuration options related to the XML output
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
Packit 1fb8d4
# If the GENERATE_XML tag is set to YES Doxygen will
Packit 1fb8d4
# generate an XML file that captures the structure of
Packit 1fb8d4
# the code including all documentation.
Packit 1fb8d4
Packit 1fb8d4
GENERATE_XML           = NO
Packit 1fb8d4
Packit 1fb8d4
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
Packit 1fb8d4
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
Packit 1fb8d4
# put in front of it. If left blank `xml' will be used as the default path.
Packit 1fb8d4
Packit 1fb8d4
XML_OUTPUT             = xml
Packit 1fb8d4
Packit 1fb8d4
# The XML_SCHEMA tag can be used to specify an XML schema,
Packit 1fb8d4
# which can be used by a validating XML parser to check the
Packit 1fb8d4
# syntax of the XML files.
Packit 1fb8d4
Packit 1fb8d4
XML_SCHEMA             =
Packit 1fb8d4
Packit 1fb8d4
# The XML_DTD tag can be used to specify an XML DTD,
Packit 1fb8d4
# which can be used by a validating XML parser to check the
Packit 1fb8d4
# syntax of the XML files.
Packit 1fb8d4
Packit 1fb8d4
XML_DTD                =
Packit 1fb8d4
Packit 1fb8d4
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
Packit 1fb8d4
# dump the program listings (including syntax highlighting
Packit 1fb8d4
# and cross-referencing information) to the XML output. Note that
Packit 1fb8d4
# enabling this will significantly increase the size of the XML output.
Packit 1fb8d4
Packit 1fb8d4
XML_PROGRAMLISTING     = YES
Packit 1fb8d4
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
# configuration options for the AutoGen Definitions output
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
Packit 1fb8d4
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
Packit 1fb8d4
# generate an AutoGen Definitions (see autogen.sf.net) file
Packit 1fb8d4
# that captures the structure of the code including all
Packit 1fb8d4
# documentation. Note that this feature is still experimental
Packit 1fb8d4
# and incomplete at the moment.
Packit 1fb8d4
Packit 1fb8d4
GENERATE_AUTOGEN_DEF   = NO
Packit 1fb8d4
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
# configuration options related to the Perl module output
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
Packit 1fb8d4
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
Packit 1fb8d4
# generate a Perl module file that captures the structure of
Packit 1fb8d4
# the code including all documentation. Note that this
Packit 1fb8d4
# feature is still experimental and incomplete at the
Packit 1fb8d4
# moment.
Packit 1fb8d4
Packit 1fb8d4
GENERATE_PERLMOD       = NO
Packit 1fb8d4
Packit 1fb8d4
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
Packit 1fb8d4
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
Packit 1fb8d4
# to generate PDF and DVI output from the Perl module output.
Packit 1fb8d4
Packit 1fb8d4
PERLMOD_LATEX          = NO
Packit 1fb8d4
Packit 1fb8d4
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
Packit 1fb8d4
# nicely formatted so it can be parsed by a human reader.
Packit 1fb8d4
# This is useful
Packit 1fb8d4
# if you want to understand what is going on.
Packit 1fb8d4
# On the other hand, if this
Packit 1fb8d4
# tag is set to NO the size of the Perl module output will be much smaller
Packit 1fb8d4
# and Perl will parse it just the same.
Packit 1fb8d4
Packit 1fb8d4
PERLMOD_PRETTY         = YES
Packit 1fb8d4
Packit 1fb8d4
# The names of the make variables in the generated doxyrules.make file
Packit 1fb8d4
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
Packit 1fb8d4
# This is useful so different doxyrules.make files included by the same
Packit 1fb8d4
# Makefile don't overwrite each other's variables.
Packit 1fb8d4
Packit 1fb8d4
PERLMOD_MAKEVAR_PREFIX =
Packit 1fb8d4
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
# Configuration options related to the preprocessor
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
Packit 1fb8d4
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
Packit 1fb8d4
# evaluate all C-preprocessor directives found in the sources and include
Packit 1fb8d4
# files.
Packit 1fb8d4
Packit 1fb8d4
ENABLE_PREPROCESSING   = YES
Packit 1fb8d4
Packit 1fb8d4
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
Packit 1fb8d4
# names in the source code. If set to NO (the default) only conditional
Packit 1fb8d4
# compilation will be performed. Macro expansion can be done in a controlled
Packit 1fb8d4
# way by setting EXPAND_ONLY_PREDEF to YES.
Packit 1fb8d4
Packit 1fb8d4
MACRO_EXPANSION        = NO
Packit 1fb8d4
Packit 1fb8d4
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
Packit 1fb8d4
# then the macro expansion is limited to the macros specified with the
Packit 1fb8d4
# PREDEFINED and EXPAND_AS_DEFINED tags.
Packit 1fb8d4
Packit 1fb8d4
EXPAND_ONLY_PREDEF     = NO
Packit 1fb8d4
Packit 1fb8d4
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
Packit 1fb8d4
# in the INCLUDE_PATH (see below) will be search if a #include is found.
Packit 1fb8d4
Packit 1fb8d4
SEARCH_INCLUDES        = YES
Packit 1fb8d4
Packit 1fb8d4
# The INCLUDE_PATH tag can be used to specify one or more directories that
Packit 1fb8d4
# contain include files that are not input files but should be processed by
Packit 1fb8d4
# the preprocessor.
Packit 1fb8d4
Packit 1fb8d4
INCLUDE_PATH           =
Packit 1fb8d4
Packit 1fb8d4
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
Packit 1fb8d4
# patterns (like *.h and *.hpp) to filter out the header-files in the
Packit 1fb8d4
# directories. If left blank, the patterns specified with FILE_PATTERNS will
Packit 1fb8d4
# be used.
Packit 1fb8d4
Packit 1fb8d4
INCLUDE_FILE_PATTERNS  =
Packit 1fb8d4
Packit 1fb8d4
# The PREDEFINED tag can be used to specify one or more macro names that
Packit 1fb8d4
# are defined before the preprocessor is started (similar to the -D option of
Packit 1fb8d4
# gcc). The argument of the tag is a list of macros of the form: name
Packit 1fb8d4
# or name=definition (no spaces). If the definition and the = are
Packit 1fb8d4
# omitted =1 is assumed. To prevent a macro definition from being
Packit 1fb8d4
# undefined via #undef or recursively expanded use the := operator
Packit 1fb8d4
# instead of the = operator.
Packit 1fb8d4
Packit 1fb8d4
PREDEFINED             =
Packit 1fb8d4
Packit 1fb8d4
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
Packit 1fb8d4
# this tag can be used to specify a list of macro names that should be expanded.
Packit 1fb8d4
# The macro definition that is found in the sources will be used.
Packit 1fb8d4
# Use the PREDEFINED tag if you want to use a different macro definition.
Packit 1fb8d4
Packit 1fb8d4
EXPAND_AS_DEFINED      =
Packit 1fb8d4
Packit 1fb8d4
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
Packit 1fb8d4
# doxygen's preprocessor will remove all function-like macros that are alone
Packit 1fb8d4
# on a line, have an all uppercase name, and do not end with a semicolon. Such
Packit 1fb8d4
# function macros are typically used for boiler-plate code, and will confuse
Packit 1fb8d4
# the parser if not removed.
Packit 1fb8d4
Packit 1fb8d4
SKIP_FUNCTION_MACROS   = YES
Packit 1fb8d4
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
# Configuration::additions related to external references
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
Packit 1fb8d4
# The TAGFILES option can be used to specify one or more tagfiles.
Packit 1fb8d4
# Optionally an initial location of the external documentation
Packit 1fb8d4
# can be added for each tagfile. The format of a tag file without
Packit 1fb8d4
# this location is as follows:
Packit 1fb8d4
#
Packit 1fb8d4
# TAGFILES = file1 file2 ...
Packit 1fb8d4
# Adding location for the tag files is done as follows:
Packit 1fb8d4
#
Packit 1fb8d4
# TAGFILES = file1=loc1 "file2 = loc2" ...
Packit 1fb8d4
# where "loc1" and "loc2" can be relative or absolute paths or
Packit 1fb8d4
# URLs. If a location is present for each tag, the installdox tool
Packit 1fb8d4
# does not have to be run to correct the links.
Packit 1fb8d4
# Note that each tag file must have a unique name
Packit 1fb8d4
# (where the name does NOT include the path)
Packit 1fb8d4
# If a tag file is not located in the directory in which doxygen
Packit 1fb8d4
# is run, you must also specify the path to the tagfile here.
Packit 1fb8d4
Packit 1fb8d4
TAGFILES               =
Packit 1fb8d4
Packit 1fb8d4
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
Packit 1fb8d4
# a tag file that is based on the input files it reads.
Packit 1fb8d4
Packit 1fb8d4
GENERATE_TAGFILE       =
Packit 1fb8d4
Packit 1fb8d4
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
Packit 1fb8d4
# in the class index. If set to NO only the inherited external classes
Packit 1fb8d4
# will be listed.
Packit 1fb8d4
Packit 1fb8d4
ALLEXTERNALS           = NO
Packit 1fb8d4
Packit 1fb8d4
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
Packit 1fb8d4
# in the modules index. If set to NO, only the current project's groups will
Packit 1fb8d4
# be listed.
Packit 1fb8d4
Packit 1fb8d4
EXTERNAL_GROUPS        = YES
Packit 1fb8d4
Packit 1fb8d4
# The PERL_PATH should be the absolute path and name of the perl script
Packit 1fb8d4
# interpreter (i.e. the result of `which perl').
Packit 1fb8d4
Packit 1fb8d4
PERL_PATH              = /usr/bin/perl
Packit 1fb8d4
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
# Configuration options related to the dot tool
Packit 1fb8d4
#---------------------------------------------------------------------------
Packit 1fb8d4
Packit 1fb8d4
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
Packit 1fb8d4
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
Packit 1fb8d4
# or super classes. Setting the tag to NO turns the diagrams off. Note that
Packit 1fb8d4
# this option is superseded by the HAVE_DOT option below. This is only a
Packit 1fb8d4
# fallback. It is recommended to install and use dot, since it yields more
Packit 1fb8d4
# powerful graphs.
Packit 1fb8d4
Packit 1fb8d4
CLASS_DIAGRAMS         = YES
Packit 1fb8d4
Packit 1fb8d4
# You can define message sequence charts within doxygen comments using the \msc
Packit 1fb8d4
# command. Doxygen will then run the mscgen tool (see
Packit 1fb8d4
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
Packit 1fb8d4
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
Packit 1fb8d4
# the mscgen tool resides. If left empty the tool is assumed to be found in the
Packit 1fb8d4
# default search path.
Packit 1fb8d4
Packit 1fb8d4
MSCGEN_PATH            =
Packit 1fb8d4
Packit 1fb8d4
# If set to YES, the inheritance and collaboration graphs will hide
Packit 1fb8d4
# inheritance and usage relations if the target is undocumented
Packit 1fb8d4
# or is not a class.
Packit 1fb8d4
Packit 1fb8d4
HIDE_UNDOC_RELATIONS   = YES
Packit 1fb8d4
Packit 1fb8d4
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
Packit 1fb8d4
# available from the path. This tool is part of Graphviz, a graph visualization
Packit 1fb8d4
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
Packit 1fb8d4
# have no effect if this option is set to NO (the default)
Packit 1fb8d4
Packit 1fb8d4
HAVE_DOT               = YES
Packit 1fb8d4
Packit 1fb8d4
# By default doxygen will write a font called FreeSans.ttf to the output
Packit 1fb8d4
# directory and reference it in all dot files that doxygen generates. This
Packit 1fb8d4
# font does not include all possible unicode characters however, so when you need
Packit 1fb8d4
# these (or just want a differently looking font) you can specify the font name
Packit 1fb8d4
# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
Packit 1fb8d4
# which can be done by putting it in a standard location or by setting the
Packit 1fb8d4
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
Packit 1fb8d4
# containing the font.
Packit 1fb8d4
Packit 1fb8d4
DOT_FONTNAME           = FreeSans
Packit 1fb8d4
Packit 1fb8d4
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
Packit 1fb8d4
# The default size is 10pt.
Packit 1fb8d4
Packit 1fb8d4
DOT_FONTSIZE           = 10
Packit 1fb8d4
Packit 1fb8d4
# By default doxygen will tell dot to use the output directory to look for the
Packit 1fb8d4
# FreeSans.ttf font (which doxygen will put there itself). If you specify a
Packit 1fb8d4
# different font using DOT_FONTNAME you can set the path where dot
Packit 1fb8d4
# can find it using this tag.
Packit 1fb8d4
Packit 1fb8d4
DOT_FONTPATH           =
Packit 1fb8d4
Packit 1fb8d4
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
Packit 1fb8d4
# will generate a graph for each documented class showing the direct and
Packit 1fb8d4
# indirect inheritance relations. Setting this tag to YES will force the
Packit 1fb8d4
# the CLASS_DIAGRAMS tag to NO.
Packit 1fb8d4
Packit 1fb8d4
CLASS_GRAPH            = YES
Packit 1fb8d4
Packit 1fb8d4
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
Packit 1fb8d4
# will generate a graph for each documented class showing the direct and
Packit 1fb8d4
# indirect implementation dependencies (inheritance, containment, and
Packit 1fb8d4
# class references variables) of the class with other documented classes.
Packit 1fb8d4
Packit 1fb8d4
COLLABORATION_GRAPH    = YES
Packit 1fb8d4
Packit 1fb8d4
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
Packit 1fb8d4
# will generate a graph for groups, showing the direct groups dependencies
Packit 1fb8d4
Packit 1fb8d4
GROUP_GRAPHS           = YES
Packit 1fb8d4
Packit 1fb8d4
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
Packit 1fb8d4
# collaboration diagrams in a style similar to the OMG's Unified Modeling
Packit 1fb8d4
# Language.
Packit 1fb8d4
Packit 1fb8d4
UML_LOOK               = NO
Packit 1fb8d4
Packit 1fb8d4
# If set to YES, the inheritance and collaboration graphs will show the
Packit 1fb8d4
# relations between templates and their instances.
Packit 1fb8d4
Packit 1fb8d4
TEMPLATE_RELATIONS     = NO
Packit 1fb8d4
Packit 1fb8d4
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
Packit 1fb8d4
# tags are set to YES then doxygen will generate a graph for each documented
Packit 1fb8d4
# file showing the direct and indirect include dependencies of the file with
Packit 1fb8d4
# other documented files.
Packit 1fb8d4
Packit 1fb8d4
INCLUDE_GRAPH          = NO
Packit 1fb8d4
Packit 1fb8d4
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
Packit 1fb8d4
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
Packit 1fb8d4
# documented header file showing the documented files that directly or
Packit 1fb8d4
# indirectly include this file.
Packit 1fb8d4
Packit 1fb8d4
INCLUDED_BY_GRAPH      = YES
Packit 1fb8d4
Packit 1fb8d4
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
Packit 1fb8d4
# doxygen will generate a call dependency graph for every global function
Packit 1fb8d4
# or class method. Note that enabling this option will significantly increase
Packit 1fb8d4
# the time of a run. So in most cases it will be better to enable call graphs
Packit 1fb8d4
# for selected functions only using the \callgraph command.
Packit 1fb8d4
Packit 1fb8d4
CALL_GRAPH             = YES
Packit 1fb8d4
Packit 1fb8d4
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
Packit 1fb8d4
# doxygen will generate a caller dependency graph for every global function
Packit 1fb8d4
# or class method. Note that enabling this option will significantly increase
Packit 1fb8d4
# the time of a run. So in most cases it will be better to enable caller
Packit 1fb8d4
# graphs for selected functions only using the \callergraph command.
Packit 1fb8d4
Packit 1fb8d4
CALLER_GRAPH           = YES
Packit 1fb8d4
Packit 1fb8d4
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
Packit 1fb8d4
# will graphical hierarchy of all classes instead of a textual one.
Packit 1fb8d4
Packit 1fb8d4
GRAPHICAL_HIERARCHY    = YES
Packit 1fb8d4
Packit 1fb8d4
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
Packit 1fb8d4
# then doxygen will show the dependencies a directory has on other directories
Packit 1fb8d4
# in a graphical way. The dependency relations are determined by the #include
Packit 1fb8d4
# relations between the files in the directories.
Packit 1fb8d4
Packit 1fb8d4
DIRECTORY_GRAPH        = YES
Packit 1fb8d4
Packit 1fb8d4
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
Packit 1fb8d4
# generated by dot. Possible values are png, jpg, or gif
Packit 1fb8d4
# If left blank png will be used.
Packit 1fb8d4
Packit 1fb8d4
DOT_IMAGE_FORMAT       = png
Packit 1fb8d4
Packit 1fb8d4
# The tag DOT_PATH can be used to specify the path where the dot tool can be
Packit 1fb8d4
# found. If left blank, it is assumed the dot tool can be found in the path.
Packit 1fb8d4
Packit 1fb8d4
DOT_PATH               =
Packit 1fb8d4
Packit 1fb8d4
# The DOTFILE_DIRS tag can be used to specify one or more directories that
Packit 1fb8d4
# contain dot files that are included in the documentation (see the
Packit 1fb8d4
# \dotfile command).
Packit 1fb8d4
Packit 1fb8d4
DOTFILE_DIRS           =
Packit 1fb8d4
Packit 1fb8d4
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
Packit 1fb8d4
# nodes that will be shown in the graph. If the number of nodes in a graph
Packit 1fb8d4
# becomes larger than this value, doxygen will truncate the graph, which is
Packit 1fb8d4
# visualized by representing a node as a red box. Note that doxygen if the
Packit 1fb8d4
# number of direct children of the root node in a graph is already larger than
Packit 1fb8d4
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
Packit 1fb8d4
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
Packit 1fb8d4
Packit 1fb8d4
DOT_GRAPH_MAX_NODES    = 50
Packit 1fb8d4
Packit 1fb8d4
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
Packit 1fb8d4
# graphs generated by dot. A depth value of 3 means that only nodes reachable
Packit 1fb8d4
# from the root by following a path via at most 3 edges will be shown. Nodes
Packit 1fb8d4
# that lay further from the root node will be omitted. Note that setting this
Packit 1fb8d4
# option to 1 or 2 may greatly reduce the computation time needed for large
Packit 1fb8d4
# code bases. Also note that the size of a graph can be further restricted by
Packit 1fb8d4
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
Packit 1fb8d4
Packit 1fb8d4
MAX_DOT_GRAPH_DEPTH    = 0
Packit 1fb8d4
Packit 1fb8d4
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
Packit 1fb8d4
# background. This is disabled by default, because dot on Windows does not
Packit 1fb8d4
# seem to support this out of the box. Warning: Depending on the platform used,
Packit 1fb8d4
# enabling this option may lead to badly anti-aliased labels on the edges of
Packit 1fb8d4
# a graph (i.e. they become hard to read).
Packit 1fb8d4
Packit 1fb8d4
DOT_TRANSPARENT        = NO
Packit 1fb8d4
Packit 1fb8d4
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
Packit 1fb8d4
# files in one run (i.e. multiple -o and -T options on the command line). This
Packit 1fb8d4
# makes dot run faster, but since only newer versions of dot (>1.8.10)
Packit 1fb8d4
# support this, this feature is disabled by default.
Packit 1fb8d4
Packit 1fb8d4
DOT_MULTI_TARGETS      = YES
Packit 1fb8d4
Packit 1fb8d4
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
Packit 1fb8d4
# generate a legend page explaining the meaning of the various boxes and
Packit 1fb8d4
# arrows in the dot generated graphs.
Packit 1fb8d4
Packit 1fb8d4
GENERATE_LEGEND        = YES
Packit 1fb8d4
Packit 1fb8d4
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
Packit 1fb8d4
# remove the intermediate dot files that are used to generate
Packit 1fb8d4
# the various graphs.
Packit 1fb8d4
Packit 1fb8d4
DOT_CLEANUP            = YES