Path: blob/master/runtime/gc_doc/DoxygenConfig.txt
5986 views
###############################################################################1# Copyright (c) 1991, 2021 IBM Corp. and others2#3# This program and the accompanying materials are made available under4# the terms of the Eclipse Public License 2.0 which accompanies this5# distribution and is available at https://www.eclipse.org/legal/epl-2.0/6# or the Apache License, Version 2.0 which accompanies this distribution and7# is available at https://www.apache.org/licenses/LICENSE-2.0.8#9# This Source Code may also be made available under the following10# Secondary Licenses when the conditions for such availability set11# forth in the Eclipse Public License, v. 2.0 are satisfied: GNU12# General Public License, version 2 with the GNU Classpath13# Exception [1] and GNU General Public License, version 2 with the14# OpenJDK Assembly Exception [2].15#16# [1] https://www.gnu.org/software/classpath/license.html17# [2] http://openjdk.java.net/legal/assembly-exception.html18#19# SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 OR LicenseRef-GPL-2.0 WITH Assembly-exception20##############################################################################2122# Doxyfile 1.8.3.12324# This file describes the settings to be used by the documentation system25# doxygen (www.doxygen.org) for a project26#27# All text after a hash (#) is considered a comment and will be ignored28# The format is:29# TAG = value [value, ...]30# For lists items can also be appended using:31# TAG += value [value, ...]32# Values that contain spaces should be placed between quotes (" ")3334#---------------------------------------------------------------------------35# Project related configuration options36#---------------------------------------------------------------------------3738# This tag specifies the encoding used for all characters in the config file39# that follow. The default is UTF-8 which is also the encoding used for all40# text before the first occurrence of this tag. Doxygen uses libiconv (or the41# iconv built into libc) for the transcoding. See42# http://www.gnu.org/software/libiconv for the list of possible encodings.4344DOXYFILE_ENCODING = UTF-84546# The PROJECT_NAME tag is a single word (or sequence of words) that should47# identify the project. Note that if you do not use Doxywizard you need48# to put quotes around the project name if it contains spaces.4950PROJECT_NAME = "J9 Memory Manager (Modron)"5152# The PROJECT_NUMBER tag can be used to enter a project or revision number.53# This could be handy for archiving the generated documentation or54# if some version control system is used.5556PROJECT_NUMBER = 2.85758# Using the PROJECT_BRIEF tag one can provide an optional one line description59# for a project that appears at the top of each page and should give viewer60# a quick idea about the purpose of the project. Keep the description short.6162PROJECT_BRIEF =6364# With the PROJECT_LOGO tag one can specify an logo or icon that is65# included in the documentation. The maximum height of the logo should not66# exceed 55 pixels and the maximum width should not exceed 200 pixels.67# Doxygen will copy the logo to the output directory.6869PROJECT_LOGO =7071# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)72# base path where the generated documentation will be put.73# If a relative path is entered, it will be relative to the location74# where doxygen was started. If left blank the current directory will be used.7576OUTPUT_DIRECTORY =7778# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create79# 4096 sub-directories (in 2 levels) under the output directory of each output80# format and will distribute the generated files over these directories.81# Enabling this option can be useful when feeding doxygen a huge amount of82# source files, where putting all generated files in the same directory would83# otherwise cause performance problems for the file system.8485CREATE_SUBDIRS = NO8687# The OUTPUT_LANGUAGE tag is used to specify the language in which all88# documentation generated by doxygen is written. Doxygen will use this89# information to generate all constant output in the proper language.90# The default language is English, other supported languages are:91# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,92# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,93# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English94# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,95# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,96# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.9798OUTPUT_LANGUAGE = English99100# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will101# include brief member descriptions after the members that are listed in102# the file and class documentation (similar to JavaDoc).103# Set to NO to disable this.104105BRIEF_MEMBER_DESC = YES106107# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend108# the brief description of a member or function before the detailed description.109# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the110# brief descriptions will be completely suppressed.111112REPEAT_BRIEF = YES113114# This tag implements a quasi-intelligent brief description abbreviator115# that is used to form the text in various listings. Each string116# in this list, if found as the leading text of the brief description, will be117# stripped from the text and the result after processing the whole list, is118# used as the annotated text. Otherwise, the brief description is used as-is.119# If left blank, the following values are used ("$name" is automatically120# replaced with the name of the entity): "The $name class" "The $name widget"121# "The $name file" "is" "provides" "specifies" "contains"122# "represents" "a" "an" "the"123124ABBREVIATE_BRIEF =125126# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then127# Doxygen will generate a detailed section even if there is only a brief128# description.129130ALWAYS_DETAILED_SEC = YES131132# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all133# inherited members of a class in the documentation of that class as if those134# members were ordinary class members. Constructors, destructors and assignment135# operators of the base classes will not be shown.136137INLINE_INHERITED_MEMB = NO138139# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full140# path before files name in the file list and in the header files. If set141# to NO the shortest path that makes the file name unique will be used.142143FULL_PATH_NAMES = NO144145# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag146# can be used to strip a user-defined part of the path. Stripping is147# only done if one of the specified strings matches the left-hand part of148# the path. The tag can be used to show relative paths in the file list.149# If left blank the directory from which doxygen is run is used as the150# path to strip. Note that you specify absolute paths here, but also151# relative paths, which will be relative from the directory where doxygen is152# started.153154STRIP_FROM_PATH =155156# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of157# the path mentioned in the documentation of a class, which tells158# the reader which header file to include in order to use a class.159# If left blank only the name of the header file containing the class160# definition is used. Otherwise one should specify the include paths that161# are normally passed to the compiler using the -I flag.162163STRIP_FROM_INC_PATH =164165# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter166# (but less readable) file names. This can be useful if your file system167# doesn't support long names like on DOS, Mac, or CD-ROM.168169SHORT_NAMES = NO170171# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen172# will interpret the first line (until the first dot) of a JavaDoc-style173# comment as the brief description. If set to NO, the JavaDoc174# comments will behave just like regular Qt-style comments175# (thus requiring an explicit @brief command for a brief description.)176177JAVADOC_AUTOBRIEF = YES178179# If the QT_AUTOBRIEF tag is set to YES then Doxygen will180# interpret the first line (until the first dot) of a Qt-style181# comment as the brief description. If set to NO, the comments182# will behave just like regular Qt-style comments (thus requiring183# an explicit \brief command for a brief description.)184185QT_AUTOBRIEF = NO186187# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen188# treat a multi-line C++ special comment block (i.e. a block of //! or ///189# comments) as a brief description. This used to be the default behaviour.190# The new default is to treat a multi-line C++ comment block as a detailed191# description. Set this tag to YES if you prefer the old behaviour instead.192193MULTILINE_CPP_IS_BRIEF = NO194195# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented196# member inherits the documentation from any documented member that it197# re-implements.198199INHERIT_DOCS = YES200201# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce202# a new page for each member. If set to NO, the documentation of a member will203# be part of the file/class/namespace that contains it.204205SEPARATE_MEMBER_PAGES = NO206207# The TAB_SIZE tag can be used to set the number of spaces in a tab.208# Doxygen uses this value to replace tabs by spaces in code fragments.209210TAB_SIZE = 4211212# This tag can be used to specify a number of aliases that acts213# as commands in the documentation. An alias has the form "name=value".214# For example adding "sideeffect=\par Side Effects:\n" will allow you to215# put the command \sideeffect (or @sideeffect) in the documentation, which216# will result in a user-defined paragraph with heading "Side Effects:".217# You can put \n's in the value part of an alias to insert newlines.218219ALIASES =220221# This tag can be used to specify a number of word-keyword mappings (TCL only).222# A mapping has the form "name=value". For example adding223# "class=itcl::class" will allow you to use the command class in the224# itcl::class meaning.225226TCL_SUBST =227228# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C229# sources only. Doxygen will then generate output that is more tailored for C.230# For instance, some of the names that are used will be different. The list231# of all members will be omitted, etc.232233OPTIMIZE_OUTPUT_FOR_C = NO234235# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java236# sources only. Doxygen will then generate output that is more tailored for237# Java. For instance, namespaces will be presented as packages, qualified238# scopes will look different, etc.239240OPTIMIZE_OUTPUT_JAVA = NO241242# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran243# sources only. Doxygen will then generate output that is more tailored for244# Fortran.245246OPTIMIZE_FOR_FORTRAN = NO247248# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL249# sources. Doxygen will then generate output that is tailored for250# VHDL.251252OPTIMIZE_OUTPUT_VHDL = NO253254# Doxygen selects the parser to use depending on the extension of the files it255# parses. With this tag you can assign which parser to use for a given256# extension. Doxygen has a built-in mapping, but you can override or extend it257# using this tag. The format is ext=language, where ext is a file extension,258# and language is one of the parsers supported by doxygen: IDL, Java,259# JavaScript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,260# C++. For instance to make doxygen treat .inc files as Fortran files (default261# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note262# that for custom extensions you also need to set FILE_PATTERNS otherwise the263# files are not read by doxygen.264265EXTENSION_MAPPING =266267# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all268# comments according to the Markdown format, which allows for more readable269# documentation. See http://daringfireball.net/projects/markdown/ for details.270# The output of markdown processing is further processed by doxygen, so you271# can mix doxygen, HTML, and XML commands with Markdown formatting.272# Disable only in case of backward compatibilities issues.273274MARKDOWN_SUPPORT = YES275276# When enabled doxygen tries to link words that correspond to documented classes,277# or namespaces to their corresponding documentation. Such a link can be278# prevented in individual cases by putting a % sign in front of the word or279# globally by setting AUTOLINK_SUPPORT to NO.280281AUTOLINK_SUPPORT = YES282283# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want284# to include (a tag file for) the STL sources as input, then you should285# set this tag to YES in order to let doxygen match functions declarations and286# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.287# func(std::string) {}). This also makes the inheritance and collaboration288# diagrams that involve STL classes more complete and accurate.289290BUILTIN_STL_SUPPORT = NO291292# If you use Microsoft's C++/CLI language, you should set this option to YES to293# enable parsing support.294295CPP_CLI_SUPPORT = NO296297# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.298# Doxygen will parse them like normal C++ but will assume all classes use public299# instead of private inheritance when no explicit protection keyword is present.300301SIP_SUPPORT = NO302303# For Microsoft's IDL there are propget and propput attributes to indicate304# getter and setter methods for a property. Setting this option to YES (the305# default) will make doxygen replace the get and set methods by a property in306# the documentation. This will only work if the methods are indeed getting or307# setting a simple type. If this is not the case, or you want to show the308# methods anyway, you should set this option to NO.309310IDL_PROPERTY_SUPPORT = YES311312# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC313# tag is set to YES, then doxygen will reuse the documentation of the first314# member in the group (if any) for the other members of the group. By default315# all members of a group must be documented explicitly.316317DISTRIBUTE_GROUP_DOC = YES318319# Set the SUBGROUPING tag to YES (the default) to allow class member groups of320# the same type (for instance a group of public functions) to be put as a321# subgroup of that type (e.g. under the Public Functions section). Set it to322# NO to prevent subgrouping. Alternatively, this can be done per class using323# the \nosubgrouping command.324325SUBGROUPING = YES326327# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and328# unions are shown inside the group in which they are included (e.g. using329# @ingroup) instead of on a separate page (for HTML and Man pages) or330# section (for LaTeX and RTF).331332INLINE_GROUPED_CLASSES = NO333334# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and335# unions with only public data fields will be shown inline in the documentation336# of the scope in which they are defined (i.e. file, namespace, or group337# documentation), provided this scope is documented. If set to NO (the default),338# structs, classes, and unions are shown on a separate page (for HTML and Man339# pages) or section (for LaTeX and RTF).340341INLINE_SIMPLE_STRUCTS = NO342343# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum344# is documented as struct, union, or enum with the name of the typedef. So345# typedef struct TypeS {} TypeT, will appear in the documentation as a struct346# with name TypeT. When disabled the typedef will appear as a member of a file,347# namespace, or class. And the struct will be named TypeS. This can typically348# be useful for C code in case the coding convention dictates that all compound349# types are typedef'ed and only the typedef is referenced, never the tag name.350351TYPEDEF_HIDES_STRUCT = NO352353# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to354# determine which symbols to keep in memory and which to flush to disk.355# When the cache is full, less often used symbols will be written to disk.356# For small to medium size projects (<1000 input files) the default value is357# probably good enough. For larger projects a too small cache size can cause358# doxygen to be busy swapping symbols to and from disk most of the time359# causing a significant performance penalty.360# If the system has enough physical memory increasing the cache will improve the361# performance by keeping more symbols in memory. Note that the value works on362# a logarithmic scale so increasing the size by one will roughly double the363# memory usage. The cache size is given by this formula:364# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,365# corresponding to a cache size of 2^16 = 65536 symbols.366367SYMBOL_CACHE_SIZE = 0368369# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be370# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given371# their name and scope. Since this can be an expensive process and often the372# same symbol appear multiple times in the code, doxygen keeps a cache of373# pre-resolved symbols. If the cache is too small doxygen will become slower.374# If the cache is too large, memory is wasted. The cache size is given by this375# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,376# corresponding to a cache size of 2^16 = 65536 symbols.377378LOOKUP_CACHE_SIZE = 0379380#---------------------------------------------------------------------------381# Build related configuration options382#---------------------------------------------------------------------------383384# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in385# documentation are documented, even if no documentation was available.386# Private class members and static file members will be hidden unless387# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES388389EXTRACT_ALL = YES390391# If the EXTRACT_PRIVATE tag is set to YES all private members of a class392# will be included in the documentation.393394EXTRACT_PRIVATE = YES395396# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal397# scope will be included in the documentation.398399EXTRACT_PACKAGE = NO400401# If the EXTRACT_STATIC tag is set to YES all static members of a file402# will be included in the documentation.403404EXTRACT_STATIC = YES405406# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)407# defined locally in source files will be included in the documentation.408# If set to NO only classes defined in header files are included.409410EXTRACT_LOCAL_CLASSES = YES411412# This flag is only useful for Objective-C code. When set to YES local413# methods, which are defined in the implementation section but not in414# the interface are included in the documentation.415# If set to NO (the default) only methods in the interface are included.416417EXTRACT_LOCAL_METHODS = NO418419# If this flag is set to YES, the members of anonymous namespaces will be420# extracted and appear in the documentation as a namespace called421# 'anonymous_namespace{file}', where file will be replaced with the base422# name of the file that contains the anonymous namespace. By default423# anonymous namespaces are hidden.424425EXTRACT_ANON_NSPACES = NO426427# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all428# undocumented members of documented classes, files or namespaces.429# If set to NO (the default) these members will be included in the430# various overviews, but no documentation section is generated.431# This option has no effect if EXTRACT_ALL is enabled.432433HIDE_UNDOC_MEMBERS = NO434435# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all436# undocumented classes that are normally visible in the class hierarchy.437# If set to NO (the default) these classes will be included in the various438# overviews. This option has no effect if EXTRACT_ALL is enabled.439440HIDE_UNDOC_CLASSES = NO441442# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all443# friend (class|struct|union) declarations.444# If set to NO (the default) these declarations will be included in the445# documentation.446447HIDE_FRIEND_COMPOUNDS = NO448449# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any450# documentation blocks found inside the body of a function.451# If set to NO (the default) these blocks will be appended to the452# function's detailed documentation block.453454HIDE_IN_BODY_DOCS = YES455456# The INTERNAL_DOCS tag determines if documentation457# that is typed after a \internal command is included. If the tag is set458# to NO (the default) then the documentation will be excluded.459# Set it to YES to include the internal documentation.460461INTERNAL_DOCS = NO462463# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate464# file names in lower-case letters. If set to YES upper-case letters are also465# allowed. This is useful if you have classes or files whose names only differ466# in case and if your file system supports case sensitive file names. Windows467# and Mac users are advised to set this option to NO.468469CASE_SENSE_NAMES = YES470471# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen472# will show members with their full class and namespace scopes in the473# documentation. If set to YES the scope will be hidden.474475HIDE_SCOPE_NAMES = NO476477# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen478# will put a list of the files that are included by a file in the documentation479# of that file.480481SHOW_INCLUDE_FILES = YES482483# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen484# will list include files with double quotes in the documentation485# rather than with sharp brackets.486487FORCE_LOCAL_INCLUDES = NO488489# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]490# is inserted in the documentation for inline members.491492INLINE_INFO = YES493494# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen495# will sort the (detailed) documentation of file and class members496# alphabetically by member name. If set to NO the members will appear in497# declaration order.498499SORT_MEMBER_DOCS = NO500501# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the502# brief documentation of file, namespace and class members alphabetically503# by member name. If set to NO (the default) the members will appear in504# declaration order.505506SORT_BRIEF_DOCS = NO507508# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen509# will sort the (brief and detailed) documentation of class members so that510# constructors and destructors are listed first. If set to NO (the default)511# the constructors will appear in the respective orders defined by512# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.513# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO514# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.515516SORT_MEMBERS_CTORS_1ST = NO517518# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the519# hierarchy of group names into alphabetical order. If set to NO (the default)520# the group names will appear in their defined order.521522SORT_GROUP_NAMES = NO523524# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be525# sorted by fully-qualified names, including namespaces. If set to526# NO (the default), the class list will be sorted only by class name,527# not including the namespace part.528# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.529# Note: This option applies only to the class list, not to the530# alphabetical list.531532SORT_BY_SCOPE_NAME = NO533534# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to535# do proper type resolution of all parameters of a function it will reject a536# match between the prototype and the implementation of a member function even537# if there is only one candidate or it is obvious which candidate to choose538# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen539# will still accept a match between prototype and implementation in such cases.540541STRICT_PROTO_MATCHING = NO542543# The GENERATE_TODOLIST tag can be used to enable (YES) or544# disable (NO) the todo list. This list is created by putting \todo545# commands in the documentation.546547GENERATE_TODOLIST = YES548549# The GENERATE_TESTLIST tag can be used to enable (YES) or550# disable (NO) the test list. This list is created by putting \test551# commands in the documentation.552553GENERATE_TESTLIST = NO554555# The GENERATE_BUGLIST tag can be used to enable (YES) or556# disable (NO) the bug list. This list is created by putting \bug557# commands in the documentation.558559GENERATE_BUGLIST = NO560561# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or562# disable (NO) the deprecated list. This list is created by putting563# \deprecated commands in the documentation.564565GENERATE_DEPRECATEDLIST= YES566567# The ENABLED_SECTIONS tag can be used to enable conditional568# documentation sections, marked by \if section-label ... \endif569# and \cond section-label ... \endcond blocks.570571ENABLED_SECTIONS =572573# The MAX_INITIALIZER_LINES tag determines the maximum number of lines574# the initial value of a variable or macro consists of for it to appear in575# the documentation. If the initializer consists of more lines than specified576# here it will be hidden. Use a value of 0 to hide initializers completely.577# The appearance of the initializer of individual variables and macros in the578# documentation can be controlled using \showinitializer or \hideinitializer579# command in the documentation regardless of this setting.580581MAX_INITIALIZER_LINES = 30582583# Set the SHOW_USED_FILES tag to NO to disable the list of files generated584# at the bottom of the documentation of classes and structs. If set to YES the585# list will mention the files that were used to generate the documentation.586587SHOW_USED_FILES = YES588589# Set the SHOW_FILES tag to NO to disable the generation of the Files page.590# This will remove the Files entry from the Quick Index and from the591# Folder Tree View (if specified). The default is YES.592593SHOW_FILES = YES594595# Set the SHOW_NAMESPACES tag to NO to disable the generation of the596# Namespaces page. This will remove the Namespaces entry from the Quick Index597# and from the Folder Tree View (if specified). The default is YES.598599SHOW_NAMESPACES = YES600601# The FILE_VERSION_FILTER tag can be used to specify a program or script that602# doxygen should invoke to get the current version for each file (typically from603# the version control system). Doxygen will invoke the program by executing (via604# popen()) the command <command> <input-file>, where <command> is the value of605# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file606# provided by doxygen. Whatever the program writes to standard output607# is used as the file version. See the manual for examples.608609FILE_VERSION_FILTER =610611# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed612# by doxygen. The layout file controls the global structure of the generated613# output files in an output format independent way. To create the layout file614# that represents doxygen's defaults, run doxygen with the -l option.615# You can optionally specify a file name after the option, if omitted616# DoxygenLayout.xml will be used as the name of the layout file.617618LAYOUT_FILE =619620# The CITE_BIB_FILES tag can be used to specify one or more bib files621# containing the references data. This must be a list of .bib files. The622# .bib extension is automatically appended if omitted. Using this command623# requires the bibtex tool to be installed. See also624# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style625# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this626# feature you need bibtex and perl available in the search path. Do not use627# file names with spaces, bibtex cannot handle them.628629CITE_BIB_FILES =630631#---------------------------------------------------------------------------632# configuration options related to warning and progress messages633#---------------------------------------------------------------------------634635# The QUIET tag can be used to turn on/off the messages that are generated636# by doxygen. Possible values are YES and NO. If left blank NO is used.637638QUIET = NO639640# The WARNINGS tag can be used to turn on/off the warning messages that are641# generated by doxygen. Possible values are YES and NO. If left blank642# NO is used.643644WARNINGS = YES645646# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings647# for undocumented members. If EXTRACT_ALL is set to YES then this flag will648# automatically be disabled.649650WARN_IF_UNDOCUMENTED = YES651652# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for653# potential errors in the documentation, such as not documenting some654# parameters in a documented function, or documenting parameters that655# don't exist or using markup commands wrongly.656657WARN_IF_DOC_ERROR = YES658659# The WARN_NO_PARAMDOC option can be enabled to get warnings for660# functions that are documented, but have no documentation for their parameters661# or return value. If set to NO (the default) doxygen will only warn about662# wrong or incomplete parameter documentation, but not about the absence of663# documentation.664665WARN_NO_PARAMDOC = NO666667# The WARN_FORMAT tag determines the format of the warning messages that668# doxygen can produce. The string should contain the $file, $line, and $text669# tags, which will be replaced by the file and line number from which the670# warning originated and the warning text. Optionally the format may contain671# $version, which will be replaced by the version of the file (if it could672# be obtained via FILE_VERSION_FILTER)673674WARN_FORMAT = "$file:$line: $text"675676# The WARN_LOGFILE tag can be used to specify a file to which warning677# and error messages should be written. If left blank the output is written678# to stderr.679680WARN_LOGFILE = DoxygenLog.txt681682#---------------------------------------------------------------------------683# configuration options related to the input files684#---------------------------------------------------------------------------685686# The INPUT tag can be used to specify the files and/or directories that contain687# documented source files. You may enter file names like "myfile.cpp" or688# directories like "/usr/src/myproject". Separate the files or directories689# with spaces.690691INPUT = DoxygenSupport.txt \692../omr/gc/base \693../omr/gc/base/standard \694../omr/gc/base/segregated \695../omr/gc/include \696../omr/gc/startup \697../omr/gc/stats \698../omr/gc/structs \699../omr/gc/verbose \700../omr/gc/verbose/handler_standard \701../gc \702../gc_api \703../gc_base \704../gc_check \705../gcchk \706../gc_glue_java \707../gc_include \708../gc_modron_standard \709../gc_modron_startup \710../gc_realtime \711../gc_stats \712../gc_structs \713../gc_tests \714../gc_trace \715../gc_trace_standard \716../gc_trace_vlhgc \717../gc_verbose_java \718../gc_verbose_old \719../gc_verbose_old_events \720../gc_verbose_handler_realtime \721../gc_verbose_handler_vlhgc \722../gc_vlhgc723724# This tag can be used to specify the character encoding of the source files725# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is726# also the default input encoding. Doxygen uses libiconv (or the iconv built727# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for728# the list of possible encodings.729730INPUT_ENCODING = UTF-8731732# If the value of the INPUT tag contains directories, you can use the733# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp734# and *.h) to filter out the source-files in the directories. If left735# blank the following patterns are tested:736# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh737# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py738# *.f90 *.f *.for *.vhd *.vhdl739740FILE_PATTERNS =741742# The RECURSIVE tag can be used to turn specify whether or not subdirectories743# should be searched for input files as well. Possible values are YES and NO.744# If left blank NO is used.745746RECURSIVE = YES747748# The EXCLUDE tag can be used to specify files and/or directories that should be749# excluded from the INPUT source files. This way you can easily exclude a750# subdirectory from a directory tree whose root is specified with the INPUT tag.751# Note that relative paths are relative to the directory from which doxygen is752# run.753754EXCLUDE =755756# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or757# directories that are symbolic links (a Unix file system feature) are excluded758# from the input.759760EXCLUDE_SYMLINKS = NO761762# If the value of the INPUT tag contains directories, you can use the763# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude764# certain files from those directories. Note that the wildcards are matched765# against the file with absolute path, so to exclude all test directories766# for example use the pattern */test/*767768EXCLUDE_PATTERNS =769770# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names771# (namespaces, classes, functions, etc.) that should be excluded from the772# output. The symbol name can be a fully qualified name, a word, or if the773# wildcard * is used, a substring. Examples: ANamespace, AClass,774# AClass::ANamespace, ANamespace::*Test775776EXCLUDE_SYMBOLS =777778# The EXAMPLE_PATH tag can be used to specify one or more files or779# directories that contain example code fragments that are included (see780# the \include command).781782EXAMPLE_PATH =783784# If the value of the EXAMPLE_PATH tag contains directories, you can use the785# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp786# and *.h) to filter out the source-files in the directories. If left787# blank all files are included.788789EXAMPLE_PATTERNS =790791# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be792# searched for input files to be used with the \include or \dontinclude793# commands irrespective of the value of the RECURSIVE tag.794# Possible values are YES and NO. If left blank NO is used.795796EXAMPLE_RECURSIVE = NO797798# The IMAGE_PATH tag can be used to specify one or more files or799# directories that contain image that are included in the documentation (see800# the \image command).801802IMAGE_PATH =803804# The INPUT_FILTER tag can be used to specify a program that doxygen should805# invoke to filter for each input file. Doxygen will invoke the filter program806# by executing (via popen()) the command <filter> <input-file>, where <filter>807# is the value of the INPUT_FILTER tag, and <input-file> is the name of an808# input file. Doxygen will then use the output that the filter program writes809# to standard output. If FILTER_PATTERNS is specified, this tag will be810# ignored.811812INPUT_FILTER =813814# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern815# basis. Doxygen will compare the file name with each pattern and apply the816# filter if there is a match. The filters are a list of the form:817# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further818# info on how filters are used. If FILTER_PATTERNS is empty or if819# non of the patterns match the file name, INPUT_FILTER is applied.820821FILTER_PATTERNS =822823# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using824# INPUT_FILTER) will be used to filter the input files when producing source825# files to browse (i.e. when SOURCE_BROWSER is set to YES).826827FILTER_SOURCE_FILES = NO828829# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file830# pattern. A pattern will override the setting for FILTER_PATTERN (if any)831# and it is also possible to disable source filtering for a specific pattern832# using *.ext= (so without naming a filter). This option only has effect when833# FILTER_SOURCE_FILES is enabled.834835FILTER_SOURCE_PATTERNS =836837# If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that838# is part of the input, its contents will be placed on the main page (index.html).839# This can be useful if you have a project on for instance GitHub and want reuse840# the introduction page also for the doxygen output.841842USE_MDFILE_AS_MAINPAGE =843844#---------------------------------------------------------------------------845# configuration options related to source browsing846#---------------------------------------------------------------------------847848# If the SOURCE_BROWSER tag is set to YES then a list of source files will849# be generated. Documented entities will be cross-referenced with these sources.850# Note: To get rid of all source code in the generated output, make sure also851# VERBATIM_HEADERS is set to NO.852853SOURCE_BROWSER = YES854855# Setting the INLINE_SOURCES tag to YES will include the body856# of functions and classes directly in the documentation.857858INLINE_SOURCES = NO859860# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct861# doxygen to hide any special comment blocks from generated source code862# fragments. Normal C, C++ and Fortran comments will always remain visible.863864STRIP_CODE_COMMENTS = YES865866# If the REFERENCED_BY_RELATION tag is set to YES867# then for each documented function all documented868# functions referencing it will be listed.869870REFERENCED_BY_RELATION = YES871872# If the REFERENCES_RELATION tag is set to YES873# then for each documented function all documented entities874# called/used by that function will be listed.875876REFERENCES_RELATION = YES877878# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)879# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from880# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will881# link to the source code. Otherwise they will link to the documentation.882883REFERENCES_LINK_SOURCE = YES884885# If the USE_HTAGS tag is set to YES then the references to source code886# will point to the HTML generated by the htags(1) tool instead of doxygen887# built-in source browser. The htags tool is part of GNU's global source888# tagging system (see http://www.gnu.org/software/global/global.html). You889# will need version 4.8.6 or higher.890891USE_HTAGS = NO892893# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen894# will generate a verbatim copy of the header file for each class for895# which an include is specified. Set to NO to disable this.896897VERBATIM_HEADERS = NO898899#---------------------------------------------------------------------------900# configuration options related to the alphabetical class index901#---------------------------------------------------------------------------902903# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index904# of all compounds will be generated. Enable this if the project905# contains a lot of classes, structs, unions or interfaces.906907ALPHABETICAL_INDEX = NO908909# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then910# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns911# in which this list will be split (can be a number in the range [1..20])912913COLS_IN_ALPHA_INDEX = 5914915# In case all classes in a project start with a common prefix, all916# classes will be put under the same header in the alphabetical index.917# The IGNORE_PREFIX tag can be used to specify one or more prefixes that918# should be ignored while generating the index headers.919920IGNORE_PREFIX =921922#---------------------------------------------------------------------------923# configuration options related to the HTML output924#---------------------------------------------------------------------------925926# If the GENERATE_HTML tag is set to YES (the default) Doxygen will927# generate HTML output.928929GENERATE_HTML = YES930931# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.932# If a relative path is entered the value of OUTPUT_DIRECTORY will be933# put in front of it. If left blank `html' will be used as the default path.934935HTML_OUTPUT = html936937# The HTML_FILE_EXTENSION tag can be used to specify the file extension for938# each generated HTML page (for example: .htm,.php,.asp). If it is left blank939# doxygen will generate files with .html extension.940941HTML_FILE_EXTENSION = .html942943# The HTML_HEADER tag can be used to specify a personal HTML header for944# each generated HTML page. If it is left blank doxygen will generate a945# standard header. Note that when using a custom header you are responsible946# for the proper inclusion of any scripts and style sheets that doxygen947# needs, which is dependent on the configuration options used.948# It is advised to generate a default header using "doxygen -w html949# header.html footer.html stylesheet.css YourConfigFile" and then modify950# that header. Note that the header is subject to change so you typically951# have to redo this when upgrading to a newer version of doxygen or when952# changing the value of configuration settings such as GENERATE_TREEVIEW!953954HTML_HEADER =955956# The HTML_FOOTER tag can be used to specify a personal HTML footer for957# each generated HTML page. If it is left blank doxygen will generate a958# standard footer.959960HTML_FOOTER =961962# The HTML_STYLESHEET tag can be used to specify a user-defined cascading963# style sheet that is used by each HTML page. It can be used to964# fine-tune the look of the HTML output. If left blank doxygen will965# generate a default style sheet. Note that it is recommended to use966# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this967# tag will in the future become obsolete.968969HTML_STYLESHEET =970971# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional972# user-defined cascading style sheet that is included after the standard973# style sheets created by doxygen. Using this option one can overrule974# certain style aspects. This is preferred over using HTML_STYLESHEET975# since it does not replace the standard style sheet and is therefore more976# robust against future updates. Doxygen will copy the style sheet file to977# the output directory.978979HTML_EXTRA_STYLESHEET =980981# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or982# other source files which should be copied to the HTML output directory. Note983# that these files will be copied to the base HTML output directory. Use the984# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these985# files. In the HTML_STYLESHEET file, use the file name only. Also note that986# the files will be copied as-is; there are no commands or markers available.987988HTML_EXTRA_FILES =989990# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.991# Doxygen will adjust the colors in the style sheet and background images992# according to this color. Hue is specified as an angle on a colorwheel,993# see http://en.wikipedia.org/wiki/Hue for more information.994# For instance the value 0 represents red, 60 is yellow, 120 is green,995# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.996# The allowed range is 0 to 359.997998HTML_COLORSTYLE_HUE = 2209991000# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of1001# the colors in the HTML output. For a value of 0 the output will use1002# grayscales only. A value of 255 will produce the most vivid colors.10031004HTML_COLORSTYLE_SAT = 10010051006# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to1007# the luminance component of the colors in the HTML output. Values below1008# 100 gradually make the output lighter, whereas values above 100 make1009# the output darker. The value divided by 100 is the actual gamma applied,1010# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,1011# and 100 does not change the gamma.10121013HTML_COLORSTYLE_GAMMA = 8010141015# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML1016# page will contain the date and time when the page was generated. Setting1017# this to NO can help when comparing the output of multiple runs.10181019HTML_TIMESTAMP = YES10201021# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML1022# documentation will contain sections that can be hidden and shown after the1023# page has loaded.10241025HTML_DYNAMIC_SECTIONS = NO10261027# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of1028# entries shown in the various tree structured indices initially; the user1029# can expand and collapse entries dynamically later on. Doxygen will expand1030# the tree to such a level that at most the specified number of entries are1031# visible (unless a fully collapsed tree already exceeds this amount).1032# So setting the number of entries 1 will produce a full collapsed tree by1033# default. 0 is a special value representing an infinite number of entries1034# and will result in a full expanded tree by default.10351036HTML_INDEX_NUM_ENTRIES = 10010371038# If the GENERATE_DOCSET tag is set to YES, additional index files1039# will be generated that can be used as input for Apple's Xcode 31040# integrated development environment, introduced with OSX 10.5 (Leopard).1041# To create a documentation set, doxygen will generate a Makefile in the1042# HTML output directory. Running make will produce the docset in that1043# directory and running "make install" will install the docset in1044# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find1045# it at startup.1046# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html1047# for more information.10481049GENERATE_DOCSET = NO10501051# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the1052# feed. A documentation feed provides an umbrella under which multiple1053# documentation sets from a single provider (such as a company or product suite)1054# can be grouped.10551056DOCSET_FEEDNAME = "Doxygen generated docs"10571058# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that1059# should uniquely identify the documentation set bundle. This should be a1060# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen1061# will append .docset to the name.10621063DOCSET_BUNDLE_ID = org.doxygen.Project10641065# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely1066# identify the documentation publisher. This should be a reverse domain-name1067# style string, e.g. com.mycompany.MyDocSet.documentation.10681069DOCSET_PUBLISHER_ID = org.doxygen.Publisher10701071# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.10721073DOCSET_PUBLISHER_NAME = Publisher10741075# If the GENERATE_HTMLHELP tag is set to YES, additional index files1076# will be generated that can be used as input for tools like the1077# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)1078# of the generated HTML documentation.10791080GENERATE_HTMLHELP = NO10811082# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can1083# be used to specify the file name of the resulting .chm file. You1084# can add a path in front of the file if the result should not be1085# written to the html output directory.10861087CHM_FILE =10881089# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can1090# be used to specify the location (absolute path including file name) of1091# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run1092# the HTML help compiler on the generated index.hhp.10931094HHC_LOCATION =10951096# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag1097# controls if a separate .chi index file is generated (YES) or that1098# it should be included in the main .chm file (NO).10991100GENERATE_CHI = NO11011102# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING1103# is used to encode HtmlHelp index (hhk), content (hhc) and project file1104# content.11051106CHM_INDEX_ENCODING =11071108# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag1109# controls whether a binary table of contents is generated (YES) or a1110# normal table of contents (NO) in the .chm file.11111112BINARY_TOC = NO11131114# The TOC_EXPAND flag can be set to YES to add extra items for group members1115# to the contents of the HTML help documentation and to the tree view.11161117TOC_EXPAND = NO11181119# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and1120# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated1121# that can be used as input for Qt's qhelpgenerator to generate a1122# Qt Compressed Help (.qch) of the generated HTML documentation.11231124GENERATE_QHP = NO11251126# If the QHG_LOCATION tag is specified, the QCH_FILE tag can1127# be used to specify the file name of the resulting .qch file.1128# The path specified is relative to the HTML output folder.11291130QCH_FILE =11311132# The QHP_NAMESPACE tag specifies the namespace to use when generating1133# Qt Help Project output. For more information please see1134# http://doc.trolltech.com/qthelpproject.html#namespace11351136QHP_NAMESPACE = org.doxygen.Project11371138# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating1139# Qt Help Project output. For more information please see1140# http://doc.trolltech.com/qthelpproject.html#virtual-folders11411142QHP_VIRTUAL_FOLDER = doc11431144# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to1145# add. For more information please see1146# http://doc.trolltech.com/qthelpproject.html#custom-filters11471148QHP_CUST_FILTER_NAME =11491150# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the1151# custom filter to add. For more information please see1152# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">1153# Qt Help Project / Custom Filters</a>.11541155QHP_CUST_FILTER_ATTRS =11561157# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this1158# project's1159# filter section matches.1160# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">1161# Qt Help Project / Filter Attributes</a>.11621163QHP_SECT_FILTER_ATTRS =11641165# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can1166# be used to specify the location of Qt's qhelpgenerator.1167# If non-empty doxygen will try to run qhelpgenerator on the generated1168# .qhp file.11691170QHG_LOCATION =11711172# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files1173# will be generated, which together with the HTML files, form an Eclipse help1174# plugin. To install this plugin and make it available under the help contents1175# menu in Eclipse, the contents of the directory containing the HTML and XML1176# files needs to be copied into the plugins directory of eclipse. The name of1177# the directory within the plugins directory should be the same as1178# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before1179# the help appears.11801181GENERATE_ECLIPSEHELP = NO11821183# A unique identifier for the eclipse help plugin. When installing the plugin1184# the directory name containing the HTML and XML files should also have1185# this name.11861187ECLIPSE_DOC_ID = org.doxygen.Project11881189# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)1190# at top of each HTML page. The value NO (the default) enables the index and1191# the value YES disables it. Since the tabs have the same information as the1192# navigation tree you can set this option to NO if you already set1193# GENERATE_TREEVIEW to YES.11941195DISABLE_INDEX = NO11961197# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index1198# structure should be generated to display hierarchical information.1199# If the tag value is set to YES, a side panel will be generated1200# containing a tree-like index structure (just like the one that1201# is generated for HTML Help). For this to work a browser that supports1202# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).1203# Windows users are probably better off using the HTML help feature.1204# Since the tree basically has the same information as the tab index you1205# could consider to set DISABLE_INDEX to NO when enabling this option.12061207GENERATE_TREEVIEW = YES12081209# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values1210# (range [0,1..20]) that doxygen will group on one line in the generated HTML1211# documentation. Note that a value of 0 will completely suppress the enum1212# values from appearing in the overview section.12131214ENUM_VALUES_PER_LINE = 412151216# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be1217# used to set the initial width (in pixels) of the frame in which the tree1218# is shown.12191220TREEVIEW_WIDTH = 25012211222# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open1223# links to external symbols imported via tag files in a separate window.12241225EXT_LINKS_IN_WINDOW = NO12261227# Use this tag to change the font size of Latex formulas included1228# as images in the HTML documentation. The default is 10. Note that1229# when you change the font size after a successful doxygen run you need1230# to manually remove any form_*.png images from the HTML output directory1231# to force them to be regenerated.12321233FORMULA_FONTSIZE = 1012341235# Use the FORMULA_TRANSPARENT tag to determine whether or not the images1236# generated for formulas are transparent PNGs. Transparent PNGs are1237# not supported properly for IE 6.0, but are supported on all modern browsers.1238# Note that when changing this option you need to delete any form_*.png files1239# in the HTML output before the changes have effect.12401241FORMULA_TRANSPARENT = YES12421243# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax1244# (see http://www.mathjax.org) which uses client side JavaScript for the1245# rendering instead of using prerendered bitmaps. Use this if you do not1246# have LaTeX installed or if you want to formulas look prettier in the HTML1247# output. When enabled you may also need to install MathJax separately and1248# configure the path to it using the MATHJAX_RELPATH option.12491250USE_MATHJAX = NO12511252# When MathJax is enabled you can set the default output format to be used for1253# thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and1254# SVG. The default value is HTML-CSS, which is slower, but has the best1255# compatibility.12561257MATHJAX_FORMAT = HTML-CSS12581259# When MathJax is enabled you need to specify the location relative to the1260# HTML output directory using the MATHJAX_RELPATH option. The destination1261# directory should contain the MathJax.js script. For instance, if the mathjax1262# directory is located at the same level as the HTML output directory, then1263# MATHJAX_RELPATH should be ../mathjax. The default value points to1264# the MathJax Content Delivery Network so you can quickly see the result without1265# installing MathJax. However, it is strongly recommended to install a local1266# copy of MathJax from http://www.mathjax.org before deployment.12671268MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest12691270# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension1271# names that should be enabled during MathJax rendering.12721273MATHJAX_EXTENSIONS =12741275# When the SEARCHENGINE tag is enabled doxygen will generate a search box1276# for the HTML output. The underlying search engine uses javascript1277# and DHTML and should work on any modern browser. Note that when using1278# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets1279# (GENERATE_DOCSET) there is already a search function so this one should1280# typically be disabled. For large projects the javascript based search engine1281# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.12821283SEARCHENGINE = YES12841285# When the SERVER_BASED_SEARCH tag is enabled the search engine will be1286# implemented using a web server instead of a web client using JavaScript.1287# There are two flavours of web server based search depending on the1288# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for1289# searching and an index file used by the script. When EXTERNAL_SEARCH is1290# enabled the indexing and searching needs to be provided by external tools.1291# See the manual for details.12921293SERVER_BASED_SEARCH = NO12941295# When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP1296# script for searching. Instead the search results are written to an XML file1297# which needs to be processed by an external indexer. Doxygen will invoke an1298# external search engine pointed to by the SEARCHENGINE_URL option to obtain1299# the search results. Doxygen ships with an example indexer (doxyindexer) and1300# search engine (doxysearch.cgi) which are based on the open source search engine1301# library Xapian. See the manual for configuration details.13021303EXTERNAL_SEARCH = NO13041305# The SEARCHENGINE_URL should point to a search engine hosted by a web server1306# which will returned the search results when EXTERNAL_SEARCH is enabled.1307# Doxygen ships with an example search engine (doxysearch) which is based on1308# the open source search engine library Xapian. See the manual for configuration1309# details.13101311SEARCHENGINE_URL =13121313# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed1314# search data is written to a file for indexing by an external tool. With the1315# SEARCHDATA_FILE tag the name of this file can be specified.13161317SEARCHDATA_FILE = searchdata.xml13181319# When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the1320# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is1321# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple1322# projects and redirect the results back to the right project.13231324EXTERNAL_SEARCH_ID =13251326# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen1327# projects other than the one defined by this configuration file, but that are1328# all added to the same external search index. Each project needs to have a1329# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id1330# of to a relative location where the documentation can be found.1331# The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ...13321333EXTRA_SEARCH_MAPPINGS =13341335#---------------------------------------------------------------------------1336# configuration options related to the LaTeX output1337#---------------------------------------------------------------------------13381339# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will1340# generate Latex output.13411342GENERATE_LATEX = NO13431344# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.1345# If a relative path is entered the value of OUTPUT_DIRECTORY will be1346# put in front of it. If left blank `latex' will be used as the default path.13471348LATEX_OUTPUT = latex13491350# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be1351# invoked. If left blank `latex' will be used as the default command name.1352# Note that when enabling USE_PDFLATEX this option is only used for1353# generating bitmaps for formulas in the HTML output, but not in the1354# Makefile that is written to the output directory.13551356LATEX_CMD_NAME = latex13571358# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to1359# generate index for LaTeX. If left blank `makeindex' will be used as the1360# default command name.13611362MAKEINDEX_CMD_NAME = makeindex13631364# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact1365# LaTeX documents. This may be useful for small projects and may help to1366# save some trees in general.13671368COMPACT_LATEX = NO13691370# The PAPER_TYPE tag can be used to set the paper type that is used1371# by the printer. Possible values are: a4, letter, legal and1372# executive. If left blank a4wide will be used.13731374PAPER_TYPE = a4wide13751376# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX1377# packages that should be included in the LaTeX output.13781379EXTRA_PACKAGES =13801381# The LATEX_HEADER tag can be used to specify a personal LaTeX header for1382# the generated latex document. The header should contain everything until1383# the first chapter. If it is left blank doxygen will generate a1384# standard header. Notice: only use this tag if you know what you are doing!13851386LATEX_HEADER =13871388# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for1389# the generated latex document. The footer should contain everything after1390# the last chapter. If it is left blank doxygen will generate a1391# standard footer. Notice: only use this tag if you know what you are doing!13921393LATEX_FOOTER =13941395# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated1396# is prepared for conversion to pdf (using ps2pdf). The pdf file will1397# contain links (just like the HTML output) instead of page references1398# This makes the output suitable for online browsing using a pdf viewer.13991400PDF_HYPERLINKS = NO14011402# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of1403# plain latex in the generated Makefile. Set this option to YES to get a1404# higher quality PDF documentation.14051406USE_PDFLATEX = NO14071408# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.1409# command to the generated LaTeX files. This will instruct LaTeX to keep1410# running if errors occur, instead of asking the user for help.1411# This option is also used when generating formulas in HTML.14121413LATEX_BATCHMODE = NO14141415# If LATEX_HIDE_INDICES is set to YES then doxygen will not1416# include the index chapters (such as File Index, Compound Index, etc.)1417# in the output.14181419LATEX_HIDE_INDICES = NO14201421# If LATEX_SOURCE_CODE is set to YES then doxygen will include1422# source code with syntax highlighting in the LaTeX output.1423# Note that which sources are shown also depends on other settings1424# such as SOURCE_BROWSER.14251426LATEX_SOURCE_CODE = NO14271428# The LATEX_BIB_STYLE tag can be used to specify the style to use for the1429# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See1430# http://en.wikipedia.org/wiki/BibTeX for more info.14311432LATEX_BIB_STYLE = plain14331434#---------------------------------------------------------------------------1435# configuration options related to the RTF output1436#---------------------------------------------------------------------------14371438# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output1439# The RTF output is optimized for Word 97 and may not look very pretty with1440# other RTF readers or editors.14411442GENERATE_RTF = NO14431444# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.1445# If a relative path is entered the value of OUTPUT_DIRECTORY will be1446# put in front of it. If left blank `rtf' will be used as the default path.14471448RTF_OUTPUT = rtf14491450# If the COMPACT_RTF tag is set to YES Doxygen generates more compact1451# RTF documents. This may be useful for small projects and may help to1452# save some trees in general.14531454COMPACT_RTF = NO14551456# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated1457# will contain hyperlink fields. The RTF file will1458# contain links (just like the HTML output) instead of page references.1459# This makes the output suitable for online browsing using WORD or other1460# programs which support those fields.1461# Note: wordpad (write) and others do not support links.14621463RTF_HYPERLINKS = NO14641465# Load style sheet definitions from file. Syntax is similar to doxygen's1466# config file, i.e. a series of assignments. You only have to provide1467# replacements, missing definitions are set to their default value.14681469RTF_STYLESHEET_FILE =14701471# Set optional variables used in the generation of an rtf document.1472# Syntax is similar to doxygen's config file.14731474RTF_EXTENSIONS_FILE =14751476#---------------------------------------------------------------------------1477# configuration options related to the man page output1478#---------------------------------------------------------------------------14791480# If the GENERATE_MAN tag is set to YES (the default) Doxygen will1481# generate man pages14821483GENERATE_MAN = NO14841485# The MAN_OUTPUT tag is used to specify where the man pages will be put.1486# If a relative path is entered the value of OUTPUT_DIRECTORY will be1487# put in front of it. If left blank `man' will be used as the default path.14881489MAN_OUTPUT = man14901491# The MAN_EXTENSION tag determines the extension that is added to1492# the generated man pages (default is the subroutine's section .3)14931494MAN_EXTENSION = .314951496# If the MAN_LINKS tag is set to YES and Doxygen generates man output,1497# then it will generate one additional man file for each entity1498# documented in the real man page(s). These additional files1499# only source the real man page, but without them the man command1500# would be unable to find the correct page. The default is NO.15011502MAN_LINKS = NO15031504#---------------------------------------------------------------------------1505# configuration options related to the XML output1506#---------------------------------------------------------------------------15071508# If the GENERATE_XML tag is set to YES Doxygen will1509# generate an XML file that captures the structure of1510# the code including all documentation.15111512GENERATE_XML = NO15131514# The XML_OUTPUT tag is used to specify where the XML pages will be put.1515# If a relative path is entered the value of OUTPUT_DIRECTORY will be1516# put in front of it. If left blank `xml' will be used as the default path.15171518XML_OUTPUT = xml15191520# The XML_SCHEMA tag can be used to specify an XML schema,1521# which can be used by a validating XML parser to check the1522# syntax of the XML files.15231524XML_SCHEMA =15251526# The XML_DTD tag can be used to specify an XML DTD,1527# which can be used by a validating XML parser to check the1528# syntax of the XML files.15291530XML_DTD =15311532# If the XML_PROGRAMLISTING tag is set to YES Doxygen will1533# dump the program listings (including syntax highlighting1534# and cross-referencing information) to the XML output. Note that1535# enabling this will significantly increase the size of the XML output.15361537XML_PROGRAMLISTING = YES15381539#---------------------------------------------------------------------------1540# configuration options for the AutoGen Definitions output1541#---------------------------------------------------------------------------15421543# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will1544# generate an AutoGen Definitions (see autogen.sf.net) file1545# that captures the structure of the code including all1546# documentation. Note that this feature is still experimental1547# and incomplete at the moment.15481549GENERATE_AUTOGEN_DEF = NO15501551#---------------------------------------------------------------------------1552# configuration options related to the Perl module output1553#---------------------------------------------------------------------------15541555# If the GENERATE_PERLMOD tag is set to YES Doxygen will1556# generate a Perl module file that captures the structure of1557# the code including all documentation. Note that this1558# feature is still experimental and incomplete at the1559# moment.15601561GENERATE_PERLMOD = NO15621563# If the PERLMOD_LATEX tag is set to YES Doxygen will generate1564# the necessary Makefile rules, Perl scripts and LaTeX code to be able1565# to generate PDF and DVI output from the Perl module output.15661567PERLMOD_LATEX = NO15681569# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be1570# nicely formatted so it can be parsed by a human reader. This is useful1571# if you want to understand what is going on. On the other hand, if this1572# tag is set to NO the size of the Perl module output will be much smaller1573# and Perl will parse it just the same.15741575PERLMOD_PRETTY = YES15761577# The names of the make variables in the generated doxyrules.make file1578# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.1579# This is useful so different doxyrules.make files included by the same1580# Makefile don't overwrite each other's variables.15811582PERLMOD_MAKEVAR_PREFIX =15831584#---------------------------------------------------------------------------1585# Configuration options related to the preprocessor1586#---------------------------------------------------------------------------15871588# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will1589# evaluate all C-preprocessor directives found in the sources and include1590# files.15911592ENABLE_PREPROCESSING = YES15931594# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro1595# names in the source code. If set to NO (the default) only conditional1596# compilation will be performed. Macro expansion can be done in a controlled1597# way by setting EXPAND_ONLY_PREDEF to YES.15981599MACRO_EXPANSION = NO16001601# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES1602# then the macro expansion is limited to the macros specified with the1603# PREDEFINED and EXPAND_AS_DEFINED tags.16041605EXPAND_ONLY_PREDEF = NO16061607# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files1608# pointed to by INCLUDE_PATH will be searched when a #include is found.16091610SEARCH_INCLUDES = YES16111612# The INCLUDE_PATH tag can be used to specify one or more directories that1613# contain include files that are not input files but should be processed by1614# the preprocessor.16151616INCLUDE_PATH = ../oti \1617../include \1618../omr/gc/include16191620# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard1621# patterns (like *.h and *.hpp) to filter out the header-files in the1622# directories. If left blank, the patterns specified with FILE_PATTERNS will1623# be used.16241625INCLUDE_FILE_PATTERNS =16261627# The PREDEFINED tag can be used to specify one or more macro names that1628# are defined before the preprocessor is started (similar to the -D option of1629# gcc). The argument of the tag is a list of macros of the form: name1630# or name=definition (no spaces). If the definition and the = are1631# omitted =1 is assumed. To prevent a macro definition from being1632# undefined via #undef or recursively expanded use the := operator1633# instead of the = operator.16341635PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS16361637# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then1638# this tag can be used to specify a list of macro names that should be expanded.1639# The macro definition that is found in the sources will be used.1640# Use the PREDEFINED tag if you want to use a different macro definition that1641# overrules the definition found in the source code.16421643EXPAND_AS_DEFINED =16441645# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then1646# doxygen's preprocessor will remove all references to function-like macros1647# that are alone on a line, have an all uppercase name, and do not end with a1648# semicolon, because these will confuse the parser if not removed.16491650SKIP_FUNCTION_MACROS = YES16511652#---------------------------------------------------------------------------1653# Configuration::additions related to external references1654#---------------------------------------------------------------------------16551656# The TAGFILES option can be used to specify one or more tagfiles. For each1657# tag file the location of the external documentation should be added. The1658# format of a tag file without this location is as follows:1659# TAGFILES = file1 file2 ...1660# Adding location for the tag files is done as follows:1661# TAGFILES = file1=loc1 "file2 = loc2" ...1662# where "loc1" and "loc2" can be relative or absolute paths1663# or URLs. Note that each tag file must have a unique name (where the name does1664# NOT include the path). If a tag file is not located in the directory in which1665# doxygen is run, you must also specify the path to the tagfile here.16661667TAGFILES =16681669# When a file name is specified after GENERATE_TAGFILE, doxygen will create1670# a tag file that is based on the input files it reads.16711672GENERATE_TAGFILE = doxy_tag16731674# If the ALLEXTERNALS tag is set to YES all external classes will be listed1675# in the class index. If set to NO only the inherited external classes1676# will be listed.16771678ALLEXTERNALS = NO16791680# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed1681# in the modules index. If set to NO, only the current project's groups will1682# be listed.16831684EXTERNAL_GROUPS = YES16851686# The PERL_PATH should be the absolute path and name of the perl script1687# interpreter (i.e. the result of `which perl').16881689PERL_PATH = /usr/bin/perl16901691#---------------------------------------------------------------------------1692# Configuration options related to the dot tool1693#---------------------------------------------------------------------------16941695# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will1696# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base1697# or super classes. Setting the tag to NO turns the diagrams off. Note that1698# this option also works with HAVE_DOT disabled, but it is recommended to1699# install and use dot, since it yields more powerful graphs.17001701CLASS_DIAGRAMS = YES17021703# You can define message sequence charts within doxygen comments using the \msc1704# command. Doxygen will then run the mscgen tool (see1705# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the1706# documentation. The MSCGEN_PATH tag allows you to specify the directory where1707# the mscgen tool resides. If left empty the tool is assumed to be found in the1708# default search path.17091710MSCGEN_PATH =17111712# If set to YES, the inheritance and collaboration graphs will hide1713# inheritance and usage relations if the target is undocumented1714# or is not a class.17151716HIDE_UNDOC_RELATIONS = YES17171718# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is1719# available from the path. This tool is part of Graphviz, a graph visualization1720# toolkit from AT&T and Lucent Bell Labs. The other options in this section1721# have no effect if this option is set to NO (the default)17221723HAVE_DOT = YES17241725# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is1726# allowed to run in parallel. When set to 0 (the default) doxygen will1727# base this on the number of processors available in the system. You can set it1728# explicitly to a value larger than 0 to get control over the balance1729# between CPU load and processing speed.17301731DOT_NUM_THREADS = 017321733# By default doxygen will use the Helvetica font for all dot files that1734# doxygen generates. When you want a differently looking font you can specify1735# the font name using DOT_FONTNAME. You need to make sure dot is able to find1736# the font, which can be done by putting it in a standard location or by setting1737# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the1738# directory containing the font.17391740DOT_FONTNAME = Helvetica17411742# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.1743# The default size is 10pt.17441745DOT_FONTSIZE = 1017461747# By default doxygen will tell dot to use the Helvetica font.1748# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to1749# set the path where dot can find it.17501751DOT_FONTPATH =17521753# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen1754# will generate a graph for each documented class showing the direct and1755# indirect inheritance relations. Setting this tag to YES will force the1756# CLASS_DIAGRAMS tag to NO.17571758CLASS_GRAPH = YES17591760# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen1761# will generate a graph for each documented class showing the direct and1762# indirect implementation dependencies (inheritance, containment, and1763# class references variables) of the class with other documented classes.17641765COLLABORATION_GRAPH = YES17661767# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen1768# will generate a graph for groups, showing the direct groups dependencies17691770GROUP_GRAPHS = YES17711772# If the UML_LOOK tag is set to YES doxygen will generate inheritance and1773# collaboration diagrams in a style similar to the OMG's Unified Modeling1774# Language.17751776UML_LOOK = NO17771778# If the UML_LOOK tag is enabled, the fields and methods are shown inside1779# the class node. If there are many fields or methods and many nodes the1780# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS1781# threshold limits the number of items for each type to make the size more1782# manageable. Set this to 0 for no limit. Note that the threshold may be1783# exceeded by 50% before the limit is enforced.17841785UML_LIMIT_NUM_FIELDS = 1017861787# If set to YES, the inheritance and collaboration graphs will show the1788# relations between templates and their instances.17891790TEMPLATE_RELATIONS = NO17911792# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT1793# tags are set to YES then doxygen will generate a graph for each documented1794# file showing the direct and indirect include dependencies of the file with1795# other documented files.17961797INCLUDE_GRAPH = YES17981799# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and1800# HAVE_DOT tags are set to YES then doxygen will generate a graph for each1801# documented header file showing the documented files that directly or1802# indirectly include this file.18031804INCLUDED_BY_GRAPH = YES18051806# If the CALL_GRAPH and HAVE_DOT options are set to YES then1807# doxygen will generate a call dependency graph for every global function1808# or class method. Note that enabling this option will significantly increase1809# the time of a run. So in most cases it will be better to enable call graphs1810# for selected functions only using the \callgraph command.18111812CALL_GRAPH = YES18131814# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then1815# doxygen will generate a caller dependency graph for every global function1816# or class method. Note that enabling this option will significantly increase1817# the time of a run. So in most cases it will be better to enable caller1818# graphs for selected functions only using the \callergraph command.18191820CALLER_GRAPH = YES18211822# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen1823# will generate a graphical hierarchy of all classes instead of a textual one.18241825GRAPHICAL_HIERARCHY = YES18261827# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES1828# then doxygen will show the dependencies a directory has on other directories1829# in a graphical way. The dependency relations are determined by the #include1830# relations between the files in the directories.18311832DIRECTORY_GRAPH = YES18331834# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images1835# generated by dot. Possible values are svg, png, jpg, or gif.1836# If left blank png will be used. If you choose svg you need to set1837# HTML_FILE_EXTENSION to xhtml in order to make the SVG files1838# visible in IE 9+ (other browsers do not have this requirement).18391840DOT_IMAGE_FORMAT = svg18411842# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to1843# enable generation of interactive SVG images that allow zooming and panning.1844# Note that this requires a modern browser other than Internet Explorer.1845# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you1846# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files1847# visible. Older versions of IE do not have SVG support.18481849INTERACTIVE_SVG = YES18501851# The tag DOT_PATH can be used to specify the path where the dot tool can be1852# found. If left blank, it is assumed the dot tool can be found in the path.18531854DOT_PATH =18551856# The DOTFILE_DIRS tag can be used to specify one or more directories that1857# contain dot files that are included in the documentation (see the1858# \dotfile command).18591860DOTFILE_DIRS =18611862# The MSCFILE_DIRS tag can be used to specify one or more directories that1863# contain msc files that are included in the documentation (see the1864# \mscfile command).18651866MSCFILE_DIRS =18671868# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of1869# nodes that will be shown in the graph. If the number of nodes in a graph1870# becomes larger than this value, doxygen will truncate the graph, which is1871# visualized by representing a node as a red box. Note that doxygen if the1872# number of direct children of the root node in a graph is already larger than1873# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note1874# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.18751876DOT_GRAPH_MAX_NODES = 5018771878# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the1879# graphs generated by dot. A depth value of 3 means that only nodes reachable1880# from the root by following a path via at most 3 edges will be shown. Nodes1881# that lay further from the root node will be omitted. Note that setting this1882# option to 1 or 2 may greatly reduce the computation time needed for large1883# code bases. Also note that the size of a graph can be further restricted by1884# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.18851886MAX_DOT_GRAPH_DEPTH = 018871888# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent1889# background. This is disabled by default, because dot on Windows does not1890# seem to support this out of the box. Warning: Depending on the platform used,1891# enabling this option may lead to badly anti-aliased labels on the edges of1892# a graph (i.e. they become hard to read).18931894DOT_TRANSPARENT = NO18951896# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output1897# files in one run (i.e. multiple -o and -T options on the command line). This1898# makes dot run faster, but since only newer versions of dot (>1.8.10)1899# support this, this feature is disabled by default.19001901DOT_MULTI_TARGETS = NO19021903# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will1904# generate a legend page explaining the meaning of the various boxes and1905# arrows in the dot generated graphs.19061907GENERATE_LEGEND = YES19081909# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will1910# remove the intermediate dot files that are used to generate1911# the various graphs.19121913DOT_CLEANUP = YES191419151916