|
Packit Service |
a1973e |
# Doxyfile 1.6.2
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# This file describes the settings to be used by the documentation system
|
|
Packit Service |
a1973e |
# doxygen (www.doxygen.org) for a project
|
|
Packit Service |
a1973e |
#
|
|
Packit Service |
a1973e |
# All text after a hash (#) is considered a comment and will be ignored
|
|
Packit Service |
a1973e |
# The format is:
|
|
Packit Service |
a1973e |
# TAG = value [value, ...]
|
|
Packit Service |
a1973e |
# For lists items can also be appended using:
|
|
Packit Service |
a1973e |
# TAG += value [value, ...]
|
|
Packit Service |
a1973e |
# Values that contain spaces should be placed between quotes (" ")
|
|
Packit Service |
a1973e |
@INCLUDE = Doxyfile-common
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
#---------------------------------------------------------------------------
|
|
Packit Service |
a1973e |
# Configuration options related to the preprocessor
|
|
Packit Service |
a1973e |
#---------------------------------------------------------------------------
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
|
|
Packit Service |
a1973e |
# evaluate all C-preprocessor directives found in the sources and include
|
|
Packit Service |
a1973e |
# files.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
ENABLE_PREPROCESSING = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
|
|
Packit Service |
a1973e |
# names in the source code. If set to NO (the default) only conditional
|
|
Packit Service |
a1973e |
# compilation will be performed. Macro expansion can be done in a controlled
|
|
Packit Service |
a1973e |
# way by setting EXPAND_ONLY_PREDEF to YES.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
MACRO_EXPANSION = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
|
|
Packit Service |
a1973e |
# then the macro expansion is limited to the macros specified with the
|
|
Packit Service |
a1973e |
# PREDEFINED and EXPAND_AS_DEFINED tags.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
EXPAND_ONLY_PREDEF = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# The PREDEFINED tag can be used to specify one or more macro names that
|
|
Packit Service |
a1973e |
# are defined before the preprocessor is started (similar to the -D option of
|
|
Packit Service |
a1973e |
# gcc). The argument of the tag is a list of macros of the form: name
|
|
Packit Service |
a1973e |
# or name=definition (no spaces). If the definition and the = are
|
|
Packit Service |
a1973e |
# omitted =1 is assumed. To prevent a macro definition from being
|
|
Packit Service |
a1973e |
# undefined via #undef or recursively expanded use the := operator
|
|
Packit Service |
a1973e |
# instead of the = operator.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
PREDEFINED = DEBUG
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
|
|
Packit Service |
a1973e |
# this tag can be used to specify a list of macro names that should be expanded.
|
|
Packit Service |
a1973e |
# The macro definition that is found in the sources will be used.
|
|
Packit Service |
a1973e |
# Use the PREDEFINED tag if you want to use a different macro definition that
|
|
Packit Service |
a1973e |
# overrules the definition found in the source code.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
EXPAND_AS_DEFINED = PAPIERROR LEAKDBG MEMDBG MPXDBG OVFDBG PAPIDEBUG SUBDBG PRFDBG INTDBG THRDBG APIDBG
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
#---------------------------------------------------------------------------
|
|
Packit Service |
a1973e |
# Build related configuration options
|
|
Packit Service |
a1973e |
#---------------------------------------------------------------------------
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
|
|
Packit Service |
a1973e |
# 4096 sub-directories (in 2 levels) under the output directory of each output
|
|
Packit Service |
a1973e |
# format and will distribute the generated files over these directories.
|
|
Packit Service |
a1973e |
# Enabling this option can be useful when feeding doxygen a huge amount of
|
|
Packit Service |
a1973e |
# source files, where putting all generated files in the same directory would
|
|
Packit Service |
a1973e |
# otherwise cause performance problems for the file system.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
CREATE_SUBDIRS = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
|
|
Packit Service |
a1973e |
# documentation are documented, even if no documentation was available.
|
|
Packit Service |
a1973e |
# Private class members and static file members will be hidden unless
|
|
Packit Service |
a1973e |
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
EXTRACT_ALL = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the EXTRACT_STATIC tag is set to YES all static members of a file
|
|
Packit Service |
a1973e |
# will be included in the documentation.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
EXTRACT_STATIC = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# The INTERNAL_DOCS tag determines if documentation
|
|
Packit Service |
a1973e |
# that is typed after a \internal command is included. If the tag is set
|
|
Packit Service |
a1973e |
# to NO (the default) then the documentation will be excluded.
|
|
Packit Service |
a1973e |
# Set it to YES to include the internal documentation.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
INTERNAL_DOCS = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
|
|
Packit Service |
a1973e |
# file names in lower-case letters. If set to YES upper-case letters are also
|
|
Packit Service |
a1973e |
# allowed. This is useful if you have classes or files whose names only differ
|
|
Packit Service |
a1973e |
# in case and if your file system supports case sensitive file names. Windows
|
|
Packit Service |
a1973e |
# and Mac users are advised to set this option to NO.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
CASE_SENSE_NAMES = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# The GENERATE_TODOLIST tag can be used to enable (YES) or
|
|
Packit Service |
a1973e |
# disable (NO) the todo list. This list is created by putting \todo
|
|
Packit Service |
a1973e |
# commands in the documentation.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
GENERATE_TODOLIST = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# The GENERATE_TESTLIST tag can be used to enable (YES) or
|
|
Packit Service |
a1973e |
# disable (NO) the test list. This list is created by putting \test
|
|
Packit Service |
a1973e |
# commands in the documentation.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
GENERATE_TESTLIST = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# The GENERATE_BUGLIST tag can be used to enable (YES) or
|
|
Packit Service |
a1973e |
# disable (NO) the bug list. This list is created by putting \bug
|
|
Packit Service |
a1973e |
# commands in the documentation.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
GENERATE_BUGLIST = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
|
|
Packit Service |
a1973e |
# disable (NO) the deprecated list. This list is created by putting
|
|
Packit Service |
a1973e |
# \deprecated commands in the documentation.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
GENERATE_DEPRECATEDLIST= YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
|
|
Packit Service |
a1973e |
# at the bottom of the documentation of classes and structs. If set to YES the
|
|
Packit Service |
a1973e |
# list will mention the files that were used to generate the documentation.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
SHOW_USED_FILES = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the sources in your project are distributed over multiple directories
|
|
Packit Service |
a1973e |
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
|
|
Packit Service |
a1973e |
# in the documentation. The default is NO.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
SHOW_DIRECTORIES = NO
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
|
|
Packit Service |
a1973e |
# This will remove the Files entry from the Quick Index and from the
|
|
Packit Service |
a1973e |
# Folder Tree View (if specified). The default is YES.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
SHOW_FILES = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
|
|
Packit Service |
a1973e |
# Namespaces page.
|
|
Packit Service |
a1973e |
# This will remove the Namespaces entry from the Quick Index
|
|
Packit Service |
a1973e |
# and from the Folder Tree View (if specified). The default is YES.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
SHOW_NAMESPACES = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
#---------------------------------------------------------------------------
|
|
Packit Service |
a1973e |
# configuration options related to the input files
|
|
Packit Service |
a1973e |
#---------------------------------------------------------------------------
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# The INPUT tag can be used to specify the files and/or directories that contain
|
|
Packit Service |
a1973e |
# documented source files. You may enter file names like "myfile.cpp" or
|
|
Packit Service |
a1973e |
# directories like "/usr/src/myproject". Separate the files or directories
|
|
Packit Service |
a1973e |
# with spaces.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
INPUT = ../src ../src/components/README
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
|
|
Packit Service |
a1973e |
# should be searched for input files as well. Possible values are YES and NO.
|
|
Packit Service |
a1973e |
# If left blank NO is used.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
RECURSIVE = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
#---------------------------------------------------------------------------
|
|
Packit Service |
a1973e |
# configuration options related to source browsing
|
|
Packit Service |
a1973e |
#---------------------------------------------------------------------------
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
|
|
Packit Service |
a1973e |
# be generated. Documented entities will be cross-referenced with these sources.
|
|
Packit Service |
a1973e |
# Note: To get rid of all source code in the generated output, make sure also
|
|
Packit Service |
a1973e |
# VERBATIM_HEADERS is set to NO.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
SOURCE_BROWSER = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# Setting the INLINE_SOURCES tag to YES will include the body
|
|
Packit Service |
a1973e |
# of functions and classes directly in the documentation.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
INLINE_SOURCES = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
|
|
Packit Service |
a1973e |
# doxygen to hide any special comment blocks from generated source code
|
|
Packit Service |
a1973e |
# fragments. Normal C and C++ comments will always remain visible.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
STRIP_CODE_COMMENTS = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the REFERENCED_BY_RELATION tag is set to YES
|
|
Packit Service |
a1973e |
# then for each documented function all documented
|
|
Packit Service |
a1973e |
# functions referencing it will be listed.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
REFERENCED_BY_RELATION = NO
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the REFERENCES_RELATION tag is set to YES
|
|
Packit Service |
a1973e |
# then for each documented function all documented entities
|
|
Packit Service |
a1973e |
# called/used by that function will be listed.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
REFERENCES_RELATION = NO
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
|
|
Packit Service |
a1973e |
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
|
|
Packit Service |
a1973e |
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
|
|
Packit Service |
a1973e |
# link to the source code.
|
|
Packit Service |
a1973e |
# Otherwise they will link to the documentation.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
REFERENCES_LINK_SOURCE = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
#---------------------------------------------------------------------------
|
|
Packit Service |
a1973e |
# configuration options related to the HTML output
|
|
Packit Service |
a1973e |
#---------------------------------------------------------------------------
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
|
|
Packit Service |
a1973e |
# generate HTML output.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
GENERATE_HTML = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
|
|
Packit Service |
a1973e |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
|
Packit Service |
a1973e |
# put in front of it. If left blank `html' will be used as the default path.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
HTML_OUTPUT = html
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
|
|
Packit Service |
a1973e |
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
|
|
Packit Service |
a1973e |
# doxygen will generate files with .html extension.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
HTML_FILE_EXTENSION = .html
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# The HTML_HEADER tag can be used to specify a personal HTML header for
|
|
Packit Service |
a1973e |
# each generated HTML page. If it is left blank doxygen will generate a
|
|
Packit Service |
a1973e |
# standard header.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
HTML_HEADER =
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
|
|
Packit Service |
a1973e |
# each generated HTML page. If it is left blank doxygen will generate a
|
|
Packit Service |
a1973e |
# standard footer.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
HTML_FOOTER =
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
|
|
Packit Service |
a1973e |
# style sheet that is used by each HTML page. It can be used to
|
|
Packit Service |
a1973e |
# fine-tune the look of the HTML output. If the tag is left blank doxygen
|
|
Packit Service |
a1973e |
# will generate a default style sheet. Note that doxygen will try to copy
|
|
Packit Service |
a1973e |
# the style sheet file to the HTML output directory, so don't put your own
|
|
Packit Service |
a1973e |
# stylesheet in the HTML output directory as well, or it will be erased!
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
HTML_STYLESHEET =
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
|
|
Packit Service |
a1973e |
# page will contain the date and time when the page was generated. Setting
|
|
Packit Service |
a1973e |
# this to NO can help when comparing the output of multiple runs.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
HTML_TIMESTAMP = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
|
|
Packit Service |
a1973e |
# files or namespaces will be aligned in HTML using tables. If set to
|
|
Packit Service |
a1973e |
# NO a bullet list will be used.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
HTML_ALIGN_MEMBERS = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
|
|
Packit Service |
a1973e |
# documentation will contain sections that can be hidden and shown after the
|
|
Packit Service |
a1973e |
# page has loaded. For this to work a browser that supports
|
|
Packit Service |
a1973e |
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
|
|
Packit Service |
a1973e |
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
HTML_DYNAMIC_SECTIONS = NO
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# This tag can be used to set the number of enum values (range [1..20])
|
|
Packit Service |
a1973e |
# that doxygen will group on one line in the generated HTML documentation.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
ENUM_VALUES_PER_LINE = 4
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
|
|
Packit Service |
a1973e |
# structure should be generated to display hierarchical information.
|
|
Packit Service |
a1973e |
# If the tag value is set to YES, a side panel will be generated
|
|
Packit Service |
a1973e |
# containing a tree-like index structure (just like the one that
|
|
Packit Service |
a1973e |
# is generated for HTML Help). For this to work a browser that supports
|
|
Packit Service |
a1973e |
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
|
|
Packit Service |
a1973e |
# Windows users are probably better off using the HTML help feature.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
GENERATE_TREEVIEW = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
|
|
Packit Service |
a1973e |
# and Class Hierarchy pages using a tree view instead of an ordered list.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
USE_INLINE_TREES = NO
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
|
|
Packit Service |
a1973e |
# used to set the initial width (in pixels) of the frame in which the tree
|
|
Packit Service |
a1973e |
# is shown.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
TREEVIEW_WIDTH = 250
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# Use this tag to change the font size of Latex formulas included
|
|
Packit Service |
a1973e |
# as images in the HTML documentation. The default is 10. Note that
|
|
Packit Service |
a1973e |
# when you change the font size after a successful doxygen run you need
|
|
Packit Service |
a1973e |
# to manually remove any form_*.png images from the HTML output directory
|
|
Packit Service |
a1973e |
# to force them to be regenerated.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
FORMULA_FONTSIZE = 10
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
|
|
Packit Service |
a1973e |
# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should
|
|
Packit Service |
a1973e |
# typically be disabled. For large projects the javascript based search engine
|
|
Packit Service |
a1973e |
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
SEARCHENGINE = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a PHP enabled web server instead of at the web client using Javascript. Doxygen will generate the search PHP script and index
|
|
Packit Service |
a1973e |
# file to put on the web server. The advantage of the server based approach is that it scales better to large projects and allows full text search. The disadvances is that it is more difficult to setup
|
|
Packit Service |
a1973e |
# and does not have live searching capabilities.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
SERVER_BASED_SEARCH = NO
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
#---------------------------------------------------------------------------
|
|
Packit Service |
a1973e |
# Configuration options related to the dot tool
|
|
Packit Service |
a1973e |
#---------------------------------------------------------------------------
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
|
|
Packit Service |
a1973e |
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
|
|
Packit Service |
a1973e |
# or super classes. Setting the tag to NO turns the diagrams off. Note that
|
|
Packit Service |
a1973e |
# this option is superseded by the HAVE_DOT option below. This is only a
|
|
Packit Service |
a1973e |
# fallback. It is recommended to install and use dot, since it yields more
|
|
Packit Service |
a1973e |
# powerful graphs.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
CLASS_DIAGRAMS = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
|
|
Packit Service |
a1973e |
# will generate a graph for each documented class showing the direct and
|
|
Packit Service |
a1973e |
# indirect inheritance relations. Setting this tag to YES will force the
|
|
Packit Service |
a1973e |
# the CLASS_DIAGRAMS tag to NO.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
CLASS_GRAPH = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
|
|
Packit Service |
a1973e |
# will generate a graph for each documented class showing the direct and
|
|
Packit Service |
a1973e |
# indirect implementation dependencies (inheritance, containment, and
|
|
Packit Service |
a1973e |
# class references variables) of the class with other documented classes.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
COLLABORATION_GRAPH = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
|
|
Packit Service |
a1973e |
# will generate a graph for groups, showing the direct groups dependencies
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
GROUP_GRAPHS = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
|
|
Packit Service |
a1973e |
# collaboration diagrams in a style similar to the OMG's Unified Modeling
|
|
Packit Service |
a1973e |
# Language.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
UML_LOOK = NO
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If set to YES, the inheritance and collaboration graphs will show the
|
|
Packit Service |
a1973e |
# relations between templates and their instances.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
TEMPLATE_RELATIONS = NO
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
|
|
Packit Service |
a1973e |
# tags are set to YES then doxygen will generate a graph for each documented
|
|
Packit Service |
a1973e |
# file showing the direct and indirect include dependencies of the file with
|
|
Packit Service |
a1973e |
# other documented files.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
INCLUDE_GRAPH = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
|
|
Packit Service |
a1973e |
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
|
|
Packit Service |
a1973e |
# documented header file showing the documented files that directly or
|
|
Packit Service |
a1973e |
# indirectly include this file.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
INCLUDED_BY_GRAPH = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
|
|
Packit Service |
a1973e |
# doxygen will generate a call dependency graph for every global function
|
|
Packit Service |
a1973e |
# or class method. Note that enabling this option will significantly increase
|
|
Packit Service |
a1973e |
# the time of a run. So in most cases it will be better to enable call graphs
|
|
Packit Service |
a1973e |
# for selected functions only using the \callgraph command.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
CALL_GRAPH = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
|
|
Packit Service |
a1973e |
# doxygen will generate a caller dependency graph for every global function
|
|
Packit Service |
a1973e |
# or class method. Note that enabling this option will significantly increase
|
|
Packit Service |
a1973e |
# the time of a run. So in most cases it will be better to enable caller
|
|
Packit Service |
a1973e |
# graphs for selected functions only using the \callergraph command.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
CALLER_GRAPH = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
|
|
Packit Service |
a1973e |
# will graphical hierarchy of all classes instead of a textual one.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
GRAPHICAL_HIERARCHY = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
|
|
Packit Service |
a1973e |
# then doxygen will show the dependencies a directory has on other directories
|
|
Packit Service |
a1973e |
# in a graphical way. The dependency relations are determined by the #include
|
|
Packit Service |
a1973e |
# relations between the files in the directories.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
DIRECTORY_GRAPH = NO
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
|
|
Packit Service |
a1973e |
# generated by dot. Possible values are png, jpg, or gif
|
|
Packit Service |
a1973e |
# If left blank png will be used.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
DOT_IMAGE_FORMAT = png
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# The tag DOT_PATH can be used to specify the path where the dot tool can be
|
|
Packit Service |
a1973e |
# found. If left blank, it is assumed the dot tool can be found in the path.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
DOT_PATH =
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# The DOTFILE_DIRS tag can be used to specify one or more directories that
|
|
Packit Service |
a1973e |
# contain dot files that are included in the documentation (see the
|
|
Packit Service |
a1973e |
# \dotfile command).
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
DOTFILE_DIRS =
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
|
|
Packit Service |
a1973e |
# nodes that will be shown in the graph. If the number of nodes in a graph
|
|
Packit Service |
a1973e |
# becomes larger than this value, doxygen will truncate the graph, which is
|
|
Packit Service |
a1973e |
# visualized by representing a node as a red box. Note that doxygen if the
|
|
Packit Service |
a1973e |
# number of direct children of the root node in a graph is already larger than
|
|
Packit Service |
a1973e |
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
|
|
Packit Service |
a1973e |
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
DOT_GRAPH_MAX_NODES = 50
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
|
|
Packit Service |
a1973e |
# graphs generated by dot. A depth value of 3 means that only nodes reachable
|
|
Packit Service |
a1973e |
# from the root by following a path via at most 3 edges will be shown. Nodes
|
|
Packit Service |
a1973e |
# that lay further from the root node will be omitted. Note that setting this
|
|
Packit Service |
a1973e |
# option to 1 or 2 may greatly reduce the computation time needed for large
|
|
Packit Service |
a1973e |
# code bases. Also note that the size of a graph can be further restricted by
|
|
Packit Service |
a1973e |
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
MAX_DOT_GRAPH_DEPTH = 0
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
|
|
Packit Service |
a1973e |
# background. This is disabled by default, because dot on Windows does not
|
|
Packit Service |
a1973e |
# seem to support this out of the box. Warning: Depending on the platform used,
|
|
Packit Service |
a1973e |
# enabling this option may lead to badly anti-aliased labels on the edges of
|
|
Packit Service |
a1973e |
# a graph (i.e. they become hard to read).
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
DOT_TRANSPARENT = NO
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
|
|
Packit Service |
a1973e |
# files in one run (i.e. multiple -o and -T options on the command line). This
|
|
Packit Service |
a1973e |
# makes dot run faster, but since only newer versions of dot (>1.8.10)
|
|
Packit Service |
a1973e |
# support this, this feature is disabled by default.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
DOT_MULTI_TARGETS = NO
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
|
|
Packit Service |
a1973e |
# generate a legend page explaining the meaning of the various boxes and
|
|
Packit Service |
a1973e |
# arrows in the dot generated graphs.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
GENERATE_LEGEND = YES
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
|
|
Packit Service |
a1973e |
# remove the intermediate dot files that are used to generate
|
|
Packit Service |
a1973e |
# the various graphs.
|
|
Packit Service |
a1973e |
|
|
Packit Service |
a1973e |
DOT_CLEANUP = YES
|