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