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