106f32e7eSjoerg# Doxyfile 1.8.6 206f32e7eSjoerg 306f32e7eSjoerg# This file describes the settings to be used by the documentation system 406f32e7eSjoerg# doxygen (www.doxygen.org) for a project. 506f32e7eSjoerg# 606f32e7eSjoerg# All text after a double hash (##) is considered a comment and is placed in 706f32e7eSjoerg# front of the TAG it is preceding. 806f32e7eSjoerg# 906f32e7eSjoerg# All text after a single hash (#) is considered a comment and will be ignored. 1006f32e7eSjoerg# The format is: 1106f32e7eSjoerg# TAG = value [value, ...] 1206f32e7eSjoerg# For lists, items can also be appended using: 1306f32e7eSjoerg# TAG += value [value, ...] 1406f32e7eSjoerg# Values that contain spaces should be placed between quotes (\" \"). 1506f32e7eSjoerg 1606f32e7eSjoerg#--------------------------------------------------------------------------- 1706f32e7eSjoerg# Project related configuration options 1806f32e7eSjoerg#--------------------------------------------------------------------------- 1906f32e7eSjoerg 2006f32e7eSjoerg# This tag specifies the encoding used for all characters in the config file 2106f32e7eSjoerg# that follow. The default is UTF-8 which is also the encoding used for all text 2206f32e7eSjoerg# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 2306f32e7eSjoerg# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 2406f32e7eSjoerg# for the list of possible encodings. 2506f32e7eSjoerg# The default value is: UTF-8. 2606f32e7eSjoerg 2706f32e7eSjoergDOXYFILE_ENCODING = UTF-8 2806f32e7eSjoerg 2906f32e7eSjoerg# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 3006f32e7eSjoerg# double-quotes, unless you are using Doxywizard) that should identify the 3106f32e7eSjoerg# project for which the documentation is generated. This name is used in the 3206f32e7eSjoerg# title of most generated pages and in a few other places. 3306f32e7eSjoerg# The default value is: My Project. 3406f32e7eSjoerg 3506f32e7eSjoergPROJECT_NAME = LLVM 3606f32e7eSjoerg 3706f32e7eSjoerg# The PROJECT_NUMBER tag can be used to enter a project or revision number. This 3806f32e7eSjoerg# could be handy for archiving the generated documentation or if some version 3906f32e7eSjoerg# control system is used. 4006f32e7eSjoerg 4106f32e7eSjoergPROJECT_NUMBER = @PACKAGE_VERSION@ 4206f32e7eSjoerg 4306f32e7eSjoerg# Using the PROJECT_BRIEF tag one can provide an optional one line description 4406f32e7eSjoerg# for a project that appears at the top of each page and should give viewer a 4506f32e7eSjoerg# quick idea about the purpose of the project. Keep the description short. 4606f32e7eSjoerg 4706f32e7eSjoergPROJECT_BRIEF = 4806f32e7eSjoerg 4906f32e7eSjoerg# With the PROJECT_LOGO tag one can specify an logo or icon that is included in 5006f32e7eSjoerg# the documentation. The maximum height of the logo should not exceed 55 pixels 5106f32e7eSjoerg# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo 5206f32e7eSjoerg# to the output directory. 5306f32e7eSjoerg 5406f32e7eSjoergPROJECT_LOGO = 5506f32e7eSjoerg 5606f32e7eSjoerg# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 5706f32e7eSjoerg# into which the generated documentation will be written. If a relative path is 5806f32e7eSjoerg# entered, it will be relative to the location where doxygen was started. If 5906f32e7eSjoerg# left blank the current directory will be used. 6006f32e7eSjoerg 6106f32e7eSjoergOUTPUT_DIRECTORY = @abs_top_builddir@/doxygen 6206f32e7eSjoerg 6306f32e7eSjoerg# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- 6406f32e7eSjoerg# directories (in 2 levels) under the output directory of each output format and 6506f32e7eSjoerg# will distribute the generated files over these directories. Enabling this 6606f32e7eSjoerg# option can be useful when feeding doxygen a huge amount of source files, where 6706f32e7eSjoerg# putting all generated files in the same directory would otherwise causes 6806f32e7eSjoerg# performance problems for the file system. 6906f32e7eSjoerg# The default value is: NO. 7006f32e7eSjoerg 7106f32e7eSjoergCREATE_SUBDIRS = NO 7206f32e7eSjoerg 7306f32e7eSjoerg# The OUTPUT_LANGUAGE tag is used to specify the language in which all 7406f32e7eSjoerg# documentation generated by doxygen is written. Doxygen will use this 7506f32e7eSjoerg# information to generate all constant output in the proper language. 7606f32e7eSjoerg# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 7706f32e7eSjoerg# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 7806f32e7eSjoerg# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 7906f32e7eSjoerg# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 8006f32e7eSjoerg# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 8106f32e7eSjoerg# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 8206f32e7eSjoerg# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 8306f32e7eSjoerg# Ukrainian and Vietnamese. 8406f32e7eSjoerg# The default value is: English. 8506f32e7eSjoerg 8606f32e7eSjoergOUTPUT_LANGUAGE = English 8706f32e7eSjoerg 8806f32e7eSjoerg# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member 8906f32e7eSjoerg# descriptions after the members that are listed in the file and class 9006f32e7eSjoerg# documentation (similar to Javadoc). Set to NO to disable this. 9106f32e7eSjoerg# The default value is: YES. 9206f32e7eSjoerg 9306f32e7eSjoergBRIEF_MEMBER_DESC = YES 9406f32e7eSjoerg 9506f32e7eSjoerg# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief 9606f32e7eSjoerg# description of a member or function before the detailed description 9706f32e7eSjoerg# 9806f32e7eSjoerg# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 9906f32e7eSjoerg# brief descriptions will be completely suppressed. 10006f32e7eSjoerg# The default value is: YES. 10106f32e7eSjoerg 10206f32e7eSjoergREPEAT_BRIEF = YES 10306f32e7eSjoerg 10406f32e7eSjoerg# This tag implements a quasi-intelligent brief description abbreviator that is 10506f32e7eSjoerg# used to form the text in various listings. Each string in this list, if found 10606f32e7eSjoerg# as the leading text of the brief description, will be stripped from the text 10706f32e7eSjoerg# and the result, after processing the whole list, is used as the annotated 10806f32e7eSjoerg# text. Otherwise, the brief description is used as-is. If left blank, the 10906f32e7eSjoerg# following values are used ($name is automatically replaced with the name of 11006f32e7eSjoerg# the entity):The $name class, The $name widget, The $name file, is, provides, 11106f32e7eSjoerg# specifies, contains, represents, a, an and the. 11206f32e7eSjoerg 11306f32e7eSjoergABBREVIATE_BRIEF = 11406f32e7eSjoerg 11506f32e7eSjoerg# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 11606f32e7eSjoerg# doxygen will generate a detailed section even if there is only a brief 11706f32e7eSjoerg# description. 11806f32e7eSjoerg# The default value is: NO. 11906f32e7eSjoerg 12006f32e7eSjoergALWAYS_DETAILED_SEC = NO 12106f32e7eSjoerg 12206f32e7eSjoerg# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 12306f32e7eSjoerg# inherited members of a class in the documentation of that class as if those 12406f32e7eSjoerg# members were ordinary class members. Constructors, destructors and assignment 12506f32e7eSjoerg# operators of the base classes will not be shown. 12606f32e7eSjoerg# The default value is: NO. 12706f32e7eSjoerg 12806f32e7eSjoergINLINE_INHERITED_MEMB = NO 12906f32e7eSjoerg 13006f32e7eSjoerg# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path 13106f32e7eSjoerg# before files name in the file list and in the header files. If set to NO the 13206f32e7eSjoerg# shortest path that makes the file name unique will be used 13306f32e7eSjoerg# The default value is: YES. 13406f32e7eSjoerg 13506f32e7eSjoergFULL_PATH_NAMES = YES 13606f32e7eSjoerg 13706f32e7eSjoerg# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 13806f32e7eSjoerg# Stripping is only done if one of the specified strings matches the left-hand 13906f32e7eSjoerg# part of the path. The tag can be used to show relative paths in the file list. 14006f32e7eSjoerg# If left blank the directory from which doxygen is run is used as the path to 14106f32e7eSjoerg# strip. 14206f32e7eSjoerg# 14306f32e7eSjoerg# Note that you can specify absolute paths here, but also relative paths, which 14406f32e7eSjoerg# will be relative from the directory where doxygen is started. 14506f32e7eSjoerg# This tag requires that the tag FULL_PATH_NAMES is set to YES. 14606f32e7eSjoerg 14706f32e7eSjoergSTRIP_FROM_PATH = @abs_top_srcdir@/.. 14806f32e7eSjoerg 14906f32e7eSjoerg# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 15006f32e7eSjoerg# path mentioned in the documentation of a class, which tells the reader which 15106f32e7eSjoerg# header file to include in order to use a class. If left blank only the name of 15206f32e7eSjoerg# the header file containing the class definition is used. Otherwise one should 15306f32e7eSjoerg# specify the list of include paths that are normally passed to the compiler 15406f32e7eSjoerg# using the -I flag. 15506f32e7eSjoerg 15606f32e7eSjoergSTRIP_FROM_INC_PATH = @abs_top_srcdir@/../include 15706f32e7eSjoergSTRIP_FROM_INC_PATH += @abs_top_srcdir@/../lib 15806f32e7eSjoerg 15906f32e7eSjoerg# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 16006f32e7eSjoerg# less readable) file names. This can be useful is your file systems doesn't 16106f32e7eSjoerg# support long names like on DOS, Mac, or CD-ROM. 16206f32e7eSjoerg# The default value is: NO. 16306f32e7eSjoerg 16406f32e7eSjoergSHORT_NAMES = NO 16506f32e7eSjoerg 16606f32e7eSjoerg# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 16706f32e7eSjoerg# first line (until the first dot) of a Javadoc-style comment as the brief 16806f32e7eSjoerg# description. If set to NO, the Javadoc-style will behave just like regular Qt- 16906f32e7eSjoerg# style comments (thus requiring an explicit @brief command for a brief 17006f32e7eSjoerg# description.) 17106f32e7eSjoerg# The default value is: NO. 17206f32e7eSjoerg 17306f32e7eSjoergJAVADOC_AUTOBRIEF = YES 17406f32e7eSjoerg 17506f32e7eSjoerg# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 17606f32e7eSjoerg# line (until the first dot) of a Qt-style comment as the brief description. If 17706f32e7eSjoerg# set to NO, the Qt-style will behave just like regular Qt-style comments (thus 17806f32e7eSjoerg# requiring an explicit \brief command for a brief description.) 17906f32e7eSjoerg# The default value is: NO. 18006f32e7eSjoerg 18106f32e7eSjoergQT_AUTOBRIEF = YES 18206f32e7eSjoerg 18306f32e7eSjoerg# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 18406f32e7eSjoerg# multi-line C++ special comment block (i.e. a block of //! or /// comments) as 18506f32e7eSjoerg# a brief description. This used to be the default behavior. The new default is 18606f32e7eSjoerg# to treat a multi-line C++ comment block as a detailed description. Set this 18706f32e7eSjoerg# tag to YES if you prefer the old behavior instead. 18806f32e7eSjoerg# 18906f32e7eSjoerg# Note that setting this tag to YES also means that rational rose comments are 19006f32e7eSjoerg# not recognized any more. 19106f32e7eSjoerg# The default value is: NO. 19206f32e7eSjoerg 19306f32e7eSjoergMULTILINE_CPP_IS_BRIEF = NO 19406f32e7eSjoerg 19506f32e7eSjoerg# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 19606f32e7eSjoerg# documentation from any documented member that it re-implements. 19706f32e7eSjoerg# The default value is: YES. 19806f32e7eSjoerg 19906f32e7eSjoergINHERIT_DOCS = YES 20006f32e7eSjoerg 20106f32e7eSjoerg# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a 20206f32e7eSjoerg# new page for each member. If set to NO, the documentation of a member will be 20306f32e7eSjoerg# part of the file/class/namespace that contains it. 20406f32e7eSjoerg# The default value is: NO. 20506f32e7eSjoerg 20606f32e7eSjoergSEPARATE_MEMBER_PAGES = NO 20706f32e7eSjoerg 20806f32e7eSjoerg# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 20906f32e7eSjoerg# uses this value to replace tabs by spaces in code fragments. 21006f32e7eSjoerg# Minimum value: 1, maximum value: 16, default value: 4. 21106f32e7eSjoerg 21206f32e7eSjoergTAB_SIZE = 2 21306f32e7eSjoerg 21406f32e7eSjoerg# This tag can be used to specify a number of aliases that act as commands in 21506f32e7eSjoerg# the documentation. An alias has the form: 21606f32e7eSjoerg# name=value 21706f32e7eSjoerg# For example adding 21806f32e7eSjoerg# "sideeffect=@par Side Effects:\n" 21906f32e7eSjoerg# will allow you to put the command \sideeffect (or @sideeffect) in the 22006f32e7eSjoerg# documentation, which will result in a user-defined paragraph with heading 22106f32e7eSjoerg# "Side Effects:". You can put \n's in the value part of an alias to insert 22206f32e7eSjoerg# newlines. 22306f32e7eSjoerg 22406f32e7eSjoergALIASES = 22506f32e7eSjoerg 22606f32e7eSjoerg# This tag can be used to specify a number of word-keyword mappings (TCL only). 22706f32e7eSjoerg# A mapping has the form "name=value". For example adding "class=itcl::class" 22806f32e7eSjoerg# will allow you to use the command class in the itcl::class meaning. 22906f32e7eSjoerg 23006f32e7eSjoergTCL_SUBST = 23106f32e7eSjoerg 23206f32e7eSjoerg# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 23306f32e7eSjoerg# only. Doxygen will then generate output that is more tailored for C. For 23406f32e7eSjoerg# instance, some of the names that are used will be different. The list of all 23506f32e7eSjoerg# members will be omitted, etc. 23606f32e7eSjoerg# The default value is: NO. 23706f32e7eSjoerg 23806f32e7eSjoergOPTIMIZE_OUTPUT_FOR_C = NO 23906f32e7eSjoerg 24006f32e7eSjoerg# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 24106f32e7eSjoerg# Python sources only. Doxygen will then generate output that is more tailored 24206f32e7eSjoerg# for that language. For instance, namespaces will be presented as packages, 24306f32e7eSjoerg# qualified scopes will look different, etc. 24406f32e7eSjoerg# The default value is: NO. 24506f32e7eSjoerg 24606f32e7eSjoergOPTIMIZE_OUTPUT_JAVA = NO 24706f32e7eSjoerg 24806f32e7eSjoerg# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 24906f32e7eSjoerg# sources. Doxygen will then generate output that is tailored for Fortran. 25006f32e7eSjoerg# The default value is: NO. 25106f32e7eSjoerg 25206f32e7eSjoergOPTIMIZE_FOR_FORTRAN = NO 25306f32e7eSjoerg 25406f32e7eSjoerg# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 25506f32e7eSjoerg# sources. Doxygen will then generate output that is tailored for VHDL. 25606f32e7eSjoerg# The default value is: NO. 25706f32e7eSjoerg 25806f32e7eSjoergOPTIMIZE_OUTPUT_VHDL = NO 25906f32e7eSjoerg 26006f32e7eSjoerg# Doxygen selects the parser to use depending on the extension of the files it 26106f32e7eSjoerg# parses. With this tag you can assign which parser to use for a given 26206f32e7eSjoerg# extension. Doxygen has a built-in mapping, but you can override or extend it 26306f32e7eSjoerg# using this tag. The format is ext=language, where ext is a file extension, and 26406f32e7eSjoerg# language is one of the parsers supported by doxygen: IDL, Java, Javascript, 26506f32e7eSjoerg# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make 26606f32e7eSjoerg# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C 26706f32e7eSjoerg# (default is Fortran), use: inc=Fortran f=C. 26806f32e7eSjoerg# 26906f32e7eSjoerg# Note For files without extension you can use no_extension as a placeholder. 27006f32e7eSjoerg# 27106f32e7eSjoerg# Note that for custom extensions you also need to set FILE_PATTERNS otherwise 27206f32e7eSjoerg# the files are not read by doxygen. 27306f32e7eSjoerg 27406f32e7eSjoergEXTENSION_MAPPING = 27506f32e7eSjoerg 27606f32e7eSjoerg# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 27706f32e7eSjoerg# according to the Markdown format, which allows for more readable 27806f32e7eSjoerg# documentation. See http://daringfireball.net/projects/markdown/ for details. 27906f32e7eSjoerg# The output of markdown processing is further processed by doxygen, so you can 28006f32e7eSjoerg# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 28106f32e7eSjoerg# case of backward compatibilities issues. 28206f32e7eSjoerg# The default value is: YES. 28306f32e7eSjoerg 28406f32e7eSjoergMARKDOWN_SUPPORT = YES 28506f32e7eSjoerg 28606f32e7eSjoerg# When enabled doxygen tries to link words that correspond to documented 28706f32e7eSjoerg# classes, or namespaces to their corresponding documentation. Such a link can 28806f32e7eSjoerg# be prevented in individual cases by putting a % sign in front of the word 28906f32e7eSjoerg# or globally by setting AUTOLINK_SUPPORT to NO. 29006f32e7eSjoerg# The default value is: YES. 29106f32e7eSjoerg 29206f32e7eSjoergAUTOLINK_SUPPORT = YES 29306f32e7eSjoerg 29406f32e7eSjoerg# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 29506f32e7eSjoerg# to include (a tag file for) the STL sources as input, then you should set this 29606f32e7eSjoerg# tag to YES in order to let doxygen match functions declarations and 29706f32e7eSjoerg# definitions whose arguments contain STL classes (e.g. func(std::string); 29806f32e7eSjoerg# versus func(std::string) {}). This also make the inheritance and collaboration 29906f32e7eSjoerg# diagrams that involve STL classes more complete and accurate. 30006f32e7eSjoerg# The default value is: NO. 30106f32e7eSjoerg 30206f32e7eSjoergBUILTIN_STL_SUPPORT = NO 30306f32e7eSjoerg 30406f32e7eSjoerg# If you use Microsoft's C++/CLI language, you should set this option to YES to 30506f32e7eSjoerg# enable parsing support. 30606f32e7eSjoerg# The default value is: NO. 30706f32e7eSjoerg 30806f32e7eSjoergCPP_CLI_SUPPORT = NO 30906f32e7eSjoerg 31006f32e7eSjoerg# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 31106f32e7eSjoerg# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 31206f32e7eSjoerg# will parse them like normal C++ but will assume all classes use public instead 31306f32e7eSjoerg# of private inheritance when no explicit protection keyword is present. 31406f32e7eSjoerg# The default value is: NO. 31506f32e7eSjoerg 31606f32e7eSjoergSIP_SUPPORT = NO 31706f32e7eSjoerg 31806f32e7eSjoerg# For Microsoft's IDL there are propget and propput attributes to indicate 31906f32e7eSjoerg# getter and setter methods for a property. Setting this option to YES will make 32006f32e7eSjoerg# doxygen to replace the get and set methods by a property in the documentation. 32106f32e7eSjoerg# This will only work if the methods are indeed getting or setting a simple 32206f32e7eSjoerg# type. If this is not the case, or you want to show the methods anyway, you 32306f32e7eSjoerg# should set this option to NO. 32406f32e7eSjoerg# The default value is: YES. 32506f32e7eSjoerg 32606f32e7eSjoergIDL_PROPERTY_SUPPORT = YES 32706f32e7eSjoerg 32806f32e7eSjoerg# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 32906f32e7eSjoerg# tag is set to YES, then doxygen will reuse the documentation of the first 33006f32e7eSjoerg# member in the group (if any) for the other members of the group. By default 33106f32e7eSjoerg# all members of a group must be documented explicitly. 33206f32e7eSjoerg# The default value is: NO. 33306f32e7eSjoerg 33406f32e7eSjoergDISTRIBUTE_GROUP_DOC = NO 33506f32e7eSjoerg 33606f32e7eSjoerg# Set the SUBGROUPING tag to YES to allow class member groups of the same type 33706f32e7eSjoerg# (for instance a group of public functions) to be put as a subgroup of that 33806f32e7eSjoerg# type (e.g. under the Public Functions section). Set it to NO to prevent 33906f32e7eSjoerg# subgrouping. Alternatively, this can be done per class using the 34006f32e7eSjoerg# \nosubgrouping command. 34106f32e7eSjoerg# The default value is: YES. 34206f32e7eSjoerg 34306f32e7eSjoergSUBGROUPING = YES 34406f32e7eSjoerg 34506f32e7eSjoerg# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 34606f32e7eSjoerg# are shown inside the group in which they are included (e.g. using \ingroup) 34706f32e7eSjoerg# instead of on a separate page (for HTML and Man pages) or section (for LaTeX 34806f32e7eSjoerg# and RTF). 34906f32e7eSjoerg# 35006f32e7eSjoerg# Note that this feature does not work in combination with 35106f32e7eSjoerg# SEPARATE_MEMBER_PAGES. 35206f32e7eSjoerg# The default value is: NO. 35306f32e7eSjoerg 35406f32e7eSjoergINLINE_GROUPED_CLASSES = NO 35506f32e7eSjoerg 35606f32e7eSjoerg# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 35706f32e7eSjoerg# with only public data fields or simple typedef fields will be shown inline in 35806f32e7eSjoerg# the documentation of the scope in which they are defined (i.e. file, 35906f32e7eSjoerg# namespace, or group documentation), provided this scope is documented. If set 36006f32e7eSjoerg# to NO, structs, classes, and unions are shown on a separate page (for HTML and 36106f32e7eSjoerg# Man pages) or section (for LaTeX and RTF). 36206f32e7eSjoerg# The default value is: NO. 36306f32e7eSjoerg 36406f32e7eSjoergINLINE_SIMPLE_STRUCTS = NO 36506f32e7eSjoerg 36606f32e7eSjoerg# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 36706f32e7eSjoerg# enum is documented as struct, union, or enum with the name of the typedef. So 36806f32e7eSjoerg# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 36906f32e7eSjoerg# with name TypeT. When disabled the typedef will appear as a member of a file, 37006f32e7eSjoerg# namespace, or class. And the struct will be named TypeS. This can typically be 37106f32e7eSjoerg# useful for C code in case the coding convention dictates that all compound 37206f32e7eSjoerg# types are typedef'ed and only the typedef is referenced, never the tag name. 37306f32e7eSjoerg# The default value is: NO. 37406f32e7eSjoerg 37506f32e7eSjoergTYPEDEF_HIDES_STRUCT = NO 37606f32e7eSjoerg 37706f32e7eSjoerg# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 37806f32e7eSjoerg# cache is used to resolve symbols given their name and scope. Since this can be 37906f32e7eSjoerg# an expensive process and often the same symbol appears multiple times in the 38006f32e7eSjoerg# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 38106f32e7eSjoerg# doxygen will become slower. If the cache is too large, memory is wasted. The 38206f32e7eSjoerg# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 38306f32e7eSjoerg# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 38406f32e7eSjoerg# symbols. At the end of a run doxygen will report the cache usage and suggest 38506f32e7eSjoerg# the optimal cache size from a speed point of view. 38606f32e7eSjoerg# Minimum value: 0, maximum value: 9, default value: 0. 38706f32e7eSjoerg 38806f32e7eSjoergLOOKUP_CACHE_SIZE = 4 38906f32e7eSjoerg 39006f32e7eSjoerg#--------------------------------------------------------------------------- 39106f32e7eSjoerg# Build related configuration options 39206f32e7eSjoerg#--------------------------------------------------------------------------- 39306f32e7eSjoerg 39406f32e7eSjoerg# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 39506f32e7eSjoerg# documentation are documented, even if no documentation was available. Private 39606f32e7eSjoerg# class members and static file members will be hidden unless the 39706f32e7eSjoerg# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 39806f32e7eSjoerg# Note: This will also disable the warnings about undocumented members that are 39906f32e7eSjoerg# normally produced when WARNINGS is set to YES. 40006f32e7eSjoerg# The default value is: NO. 40106f32e7eSjoerg 40206f32e7eSjoergEXTRACT_ALL = YES 40306f32e7eSjoerg 40406f32e7eSjoerg# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will 40506f32e7eSjoerg# be included in the documentation. 40606f32e7eSjoerg# The default value is: NO. 40706f32e7eSjoerg 40806f32e7eSjoergEXTRACT_PRIVATE = NO 40906f32e7eSjoerg 41006f32e7eSjoerg# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal 41106f32e7eSjoerg# scope will be included in the documentation. 41206f32e7eSjoerg# The default value is: NO. 41306f32e7eSjoerg 41406f32e7eSjoergEXTRACT_PACKAGE = NO 41506f32e7eSjoerg 41606f32e7eSjoerg# If the EXTRACT_STATIC tag is set to YES all static members of a file will be 41706f32e7eSjoerg# included in the documentation. 41806f32e7eSjoerg# The default value is: NO. 41906f32e7eSjoerg 42006f32e7eSjoergEXTRACT_STATIC = YES 42106f32e7eSjoerg 42206f32e7eSjoerg# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined 42306f32e7eSjoerg# locally in source files will be included in the documentation. If set to NO 42406f32e7eSjoerg# only classes defined in header files are included. Does not have any effect 42506f32e7eSjoerg# for Java sources. 42606f32e7eSjoerg# The default value is: YES. 42706f32e7eSjoerg 42806f32e7eSjoergEXTRACT_LOCAL_CLASSES = YES 42906f32e7eSjoerg 43006f32e7eSjoerg# This flag is only useful for Objective-C code. When set to YES local methods, 43106f32e7eSjoerg# which are defined in the implementation section but not in the interface are 43206f32e7eSjoerg# included in the documentation. If set to NO only methods in the interface are 43306f32e7eSjoerg# included. 43406f32e7eSjoerg# The default value is: NO. 43506f32e7eSjoerg 43606f32e7eSjoergEXTRACT_LOCAL_METHODS = NO 43706f32e7eSjoerg 43806f32e7eSjoerg# If this flag is set to YES, the members of anonymous namespaces will be 43906f32e7eSjoerg# extracted and appear in the documentation as a namespace called 44006f32e7eSjoerg# 'anonymous_namespace{file}', where file will be replaced with the base name of 44106f32e7eSjoerg# the file that contains the anonymous namespace. By default anonymous namespace 44206f32e7eSjoerg# are hidden. 44306f32e7eSjoerg# The default value is: NO. 44406f32e7eSjoerg 44506f32e7eSjoergEXTRACT_ANON_NSPACES = NO 44606f32e7eSjoerg 44706f32e7eSjoerg# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 44806f32e7eSjoerg# undocumented members inside documented classes or files. If set to NO these 44906f32e7eSjoerg# members will be included in the various overviews, but no documentation 45006f32e7eSjoerg# section is generated. This option has no effect if EXTRACT_ALL is enabled. 45106f32e7eSjoerg# The default value is: NO. 45206f32e7eSjoerg 45306f32e7eSjoergHIDE_UNDOC_MEMBERS = NO 45406f32e7eSjoerg 45506f32e7eSjoerg# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 45606f32e7eSjoerg# undocumented classes that are normally visible in the class hierarchy. If set 45706f32e7eSjoerg# to NO these classes will be included in the various overviews. This option has 45806f32e7eSjoerg# no effect if EXTRACT_ALL is enabled. 45906f32e7eSjoerg# The default value is: NO. 46006f32e7eSjoerg 46106f32e7eSjoergHIDE_UNDOC_CLASSES = NO 46206f32e7eSjoerg 46306f32e7eSjoerg# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 46406f32e7eSjoerg# (class|struct|union) declarations. If set to NO these declarations will be 46506f32e7eSjoerg# included in the documentation. 46606f32e7eSjoerg# The default value is: NO. 46706f32e7eSjoerg 46806f32e7eSjoergHIDE_FRIEND_COMPOUNDS = NO 46906f32e7eSjoerg 47006f32e7eSjoerg# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 47106f32e7eSjoerg# documentation blocks found inside the body of a function. If set to NO these 47206f32e7eSjoerg# blocks will be appended to the function's detailed documentation block. 47306f32e7eSjoerg# The default value is: NO. 47406f32e7eSjoerg 47506f32e7eSjoergHIDE_IN_BODY_DOCS = NO 47606f32e7eSjoerg 47706f32e7eSjoerg# The INTERNAL_DOCS tag determines if documentation that is typed after a 47806f32e7eSjoerg# \internal command is included. If the tag is set to NO then the documentation 47906f32e7eSjoerg# will be excluded. Set it to YES to include the internal documentation. 48006f32e7eSjoerg# The default value is: NO. 48106f32e7eSjoerg 48206f32e7eSjoergINTERNAL_DOCS = NO 48306f32e7eSjoerg 48406f32e7eSjoerg# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 48506f32e7eSjoerg# names in lower-case letters. If set to YES upper-case letters are also 48606f32e7eSjoerg# allowed. This is useful if you have classes or files whose names only differ 48706f32e7eSjoerg# in case and if your file system supports case sensitive file names. Windows 48806f32e7eSjoerg# and Mac users are advised to set this option to NO. 48906f32e7eSjoerg# The default value is: system dependent. 49006f32e7eSjoerg 49106f32e7eSjoergCASE_SENSE_NAMES = YES 49206f32e7eSjoerg 49306f32e7eSjoerg# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 49406f32e7eSjoerg# their full class and namespace scopes in the documentation. If set to YES the 49506f32e7eSjoerg# scope will be hidden. 49606f32e7eSjoerg# The default value is: NO. 49706f32e7eSjoerg 49806f32e7eSjoergHIDE_SCOPE_NAMES = NO 49906f32e7eSjoerg 50006f32e7eSjoerg# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 50106f32e7eSjoerg# the files that are included by a file in the documentation of that file. 50206f32e7eSjoerg# The default value is: YES. 50306f32e7eSjoerg 50406f32e7eSjoergSHOW_INCLUDE_FILES = YES 50506f32e7eSjoerg 50606f32e7eSjoerg# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 50706f32e7eSjoerg# grouped member an include statement to the documentation, telling the reader 50806f32e7eSjoerg# which file to include in order to use the member. 50906f32e7eSjoerg# The default value is: NO. 51006f32e7eSjoerg 51106f32e7eSjoergSHOW_GROUPED_MEMB_INC = NO 51206f32e7eSjoerg 51306f32e7eSjoerg# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 51406f32e7eSjoerg# files with double quotes in the documentation rather than with sharp brackets. 51506f32e7eSjoerg# The default value is: NO. 51606f32e7eSjoerg 51706f32e7eSjoergFORCE_LOCAL_INCLUDES = YES 51806f32e7eSjoerg 51906f32e7eSjoerg# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 52006f32e7eSjoerg# documentation for inline members. 52106f32e7eSjoerg# The default value is: YES. 52206f32e7eSjoerg 52306f32e7eSjoergINLINE_INFO = YES 52406f32e7eSjoerg 52506f32e7eSjoerg# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 52606f32e7eSjoerg# (detailed) documentation of file and class members alphabetically by member 52706f32e7eSjoerg# name. If set to NO the members will appear in declaration order. 52806f32e7eSjoerg# The default value is: YES. 52906f32e7eSjoerg 53006f32e7eSjoergSORT_MEMBER_DOCS = YES 53106f32e7eSjoerg 53206f32e7eSjoerg# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 53306f32e7eSjoerg# descriptions of file, namespace and class members alphabetically by member 53406f32e7eSjoerg# name. If set to NO the members will appear in declaration order. Note that 53506f32e7eSjoerg# this will also influence the order of the classes in the class list. 53606f32e7eSjoerg# The default value is: NO. 53706f32e7eSjoerg 53806f32e7eSjoergSORT_BRIEF_DOCS = NO 53906f32e7eSjoerg 54006f32e7eSjoerg# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 54106f32e7eSjoerg# (brief and detailed) documentation of class members so that constructors and 54206f32e7eSjoerg# destructors are listed first. If set to NO the constructors will appear in the 54306f32e7eSjoerg# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 54406f32e7eSjoerg# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 54506f32e7eSjoerg# member documentation. 54606f32e7eSjoerg# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 54706f32e7eSjoerg# detailed member documentation. 54806f32e7eSjoerg# The default value is: NO. 54906f32e7eSjoerg 55006f32e7eSjoergSORT_MEMBERS_CTORS_1ST = NO 55106f32e7eSjoerg 55206f32e7eSjoerg# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 55306f32e7eSjoerg# of group names into alphabetical order. If set to NO the group names will 55406f32e7eSjoerg# appear in their defined order. 55506f32e7eSjoerg# The default value is: NO. 55606f32e7eSjoerg 55706f32e7eSjoergSORT_GROUP_NAMES = NO 55806f32e7eSjoerg 55906f32e7eSjoerg# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 56006f32e7eSjoerg# fully-qualified names, including namespaces. If set to NO, the class list will 56106f32e7eSjoerg# be sorted only by class name, not including the namespace part. 56206f32e7eSjoerg# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 56306f32e7eSjoerg# Note: This option applies only to the class list, not to the alphabetical 56406f32e7eSjoerg# list. 56506f32e7eSjoerg# The default value is: NO. 56606f32e7eSjoerg 56706f32e7eSjoergSORT_BY_SCOPE_NAME = NO 56806f32e7eSjoerg 56906f32e7eSjoerg# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 57006f32e7eSjoerg# type resolution of all parameters of a function it will reject a match between 57106f32e7eSjoerg# the prototype and the implementation of a member function even if there is 57206f32e7eSjoerg# only one candidate or it is obvious which candidate to choose by doing a 57306f32e7eSjoerg# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 57406f32e7eSjoerg# accept a match between prototype and implementation in such cases. 57506f32e7eSjoerg# The default value is: NO. 57606f32e7eSjoerg 57706f32e7eSjoergSTRICT_PROTO_MATCHING = NO 57806f32e7eSjoerg 57906f32e7eSjoerg# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the 58006f32e7eSjoerg# todo list. This list is created by putting \todo commands in the 58106f32e7eSjoerg# documentation. 58206f32e7eSjoerg# The default value is: YES. 58306f32e7eSjoerg 58406f32e7eSjoergGENERATE_TODOLIST = YES 58506f32e7eSjoerg 58606f32e7eSjoerg# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the 58706f32e7eSjoerg# test list. This list is created by putting \test commands in the 58806f32e7eSjoerg# documentation. 58906f32e7eSjoerg# The default value is: YES. 59006f32e7eSjoerg 59106f32e7eSjoergGENERATE_TESTLIST = YES 59206f32e7eSjoerg 59306f32e7eSjoerg# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug 59406f32e7eSjoerg# list. This list is created by putting \bug commands in the documentation. 59506f32e7eSjoerg# The default value is: YES. 59606f32e7eSjoerg 59706f32e7eSjoergGENERATE_BUGLIST = YES 59806f32e7eSjoerg 59906f32e7eSjoerg# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) 60006f32e7eSjoerg# the deprecated list. This list is created by putting \deprecated commands in 60106f32e7eSjoerg# the documentation. 60206f32e7eSjoerg# The default value is: YES. 60306f32e7eSjoerg 60406f32e7eSjoergGENERATE_DEPRECATEDLIST= YES 60506f32e7eSjoerg 60606f32e7eSjoerg# The ENABLED_SECTIONS tag can be used to enable conditional documentation 60706f32e7eSjoerg# sections, marked by \if <section_label> ... \endif and \cond <section_label> 60806f32e7eSjoerg# ... \endcond blocks. 60906f32e7eSjoerg 61006f32e7eSjoergENABLED_SECTIONS = 61106f32e7eSjoerg 61206f32e7eSjoerg# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 61306f32e7eSjoerg# initial value of a variable or macro / define can have for it to appear in the 61406f32e7eSjoerg# documentation. If the initializer consists of more lines than specified here 61506f32e7eSjoerg# it will be hidden. Use a value of 0 to hide initializers completely. The 61606f32e7eSjoerg# appearance of the value of individual variables and macros / defines can be 61706f32e7eSjoerg# controlled using \showinitializer or \hideinitializer command in the 61806f32e7eSjoerg# documentation regardless of this setting. 61906f32e7eSjoerg# Minimum value: 0, maximum value: 10000, default value: 30. 62006f32e7eSjoerg 62106f32e7eSjoergMAX_INITIALIZER_LINES = 30 62206f32e7eSjoerg 62306f32e7eSjoerg# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 62406f32e7eSjoerg# the bottom of the documentation of classes and structs. If set to YES the list 62506f32e7eSjoerg# will mention the files that were used to generate the documentation. 62606f32e7eSjoerg# The default value is: YES. 62706f32e7eSjoerg 62806f32e7eSjoergSHOW_USED_FILES = YES 62906f32e7eSjoerg 63006f32e7eSjoerg# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 63106f32e7eSjoerg# will remove the Files entry from the Quick Index and from the Folder Tree View 63206f32e7eSjoerg# (if specified). 63306f32e7eSjoerg# The default value is: YES. 63406f32e7eSjoerg 63506f32e7eSjoergSHOW_FILES = YES 63606f32e7eSjoerg 63706f32e7eSjoerg# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 63806f32e7eSjoerg# page. This will remove the Namespaces entry from the Quick Index and from the 63906f32e7eSjoerg# Folder Tree View (if specified). 64006f32e7eSjoerg# The default value is: YES. 64106f32e7eSjoerg 64206f32e7eSjoergSHOW_NAMESPACES = YES 64306f32e7eSjoerg 64406f32e7eSjoerg# The FILE_VERSION_FILTER tag can be used to specify a program or script that 64506f32e7eSjoerg# doxygen should invoke to get the current version for each file (typically from 64606f32e7eSjoerg# the version control system). Doxygen will invoke the program by executing (via 64706f32e7eSjoerg# popen()) the command command input-file, where command is the value of the 64806f32e7eSjoerg# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 64906f32e7eSjoerg# by doxygen. Whatever the program writes to standard output is used as the file 65006f32e7eSjoerg# version. For an example see the documentation. 65106f32e7eSjoerg 65206f32e7eSjoergFILE_VERSION_FILTER = 65306f32e7eSjoerg 65406f32e7eSjoerg# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 65506f32e7eSjoerg# by doxygen. The layout file controls the global structure of the generated 65606f32e7eSjoerg# output files in an output format independent way. To create the layout file 65706f32e7eSjoerg# that represents doxygen's defaults, run doxygen with the -l option. You can 65806f32e7eSjoerg# optionally specify a file name after the option, if omitted DoxygenLayout.xml 65906f32e7eSjoerg# will be used as the name of the layout file. 66006f32e7eSjoerg# 66106f32e7eSjoerg# Note that if you run doxygen from a directory containing a file called 66206f32e7eSjoerg# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 66306f32e7eSjoerg# tag is left empty. 66406f32e7eSjoerg 66506f32e7eSjoergLAYOUT_FILE = 66606f32e7eSjoerg 66706f32e7eSjoerg# The CITE_BIB_FILES tag can be used to specify one or more bib files containing 66806f32e7eSjoerg# the reference definitions. This must be a list of .bib files. The .bib 66906f32e7eSjoerg# extension is automatically appended if omitted. This requires the bibtex tool 67006f32e7eSjoerg# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 67106f32e7eSjoerg# For LaTeX the style of the bibliography can be controlled using 67206f32e7eSjoerg# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 67306f32e7eSjoerg# search path. Do not use file names with spaces, bibtex cannot handle them. See 67406f32e7eSjoerg# also \cite for info how to create references. 67506f32e7eSjoerg 67606f32e7eSjoergCITE_BIB_FILES = 67706f32e7eSjoerg 67806f32e7eSjoerg#--------------------------------------------------------------------------- 67906f32e7eSjoerg# Configuration options related to warning and progress messages 68006f32e7eSjoerg#--------------------------------------------------------------------------- 68106f32e7eSjoerg 68206f32e7eSjoerg# The QUIET tag can be used to turn on/off the messages that are generated to 68306f32e7eSjoerg# standard output by doxygen. If QUIET is set to YES this implies that the 68406f32e7eSjoerg# messages are off. 68506f32e7eSjoerg# The default value is: NO. 68606f32e7eSjoerg 68706f32e7eSjoergQUIET = NO 68806f32e7eSjoerg 68906f32e7eSjoerg# The WARNINGS tag can be used to turn on/off the warning messages that are 69006f32e7eSjoerg# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES 69106f32e7eSjoerg# this implies that the warnings are on. 69206f32e7eSjoerg# 69306f32e7eSjoerg# Tip: Turn warnings on while writing the documentation. 69406f32e7eSjoerg# The default value is: YES. 69506f32e7eSjoerg 69606f32e7eSjoergWARNINGS = NO 69706f32e7eSjoerg 69806f32e7eSjoerg# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate 69906f32e7eSjoerg# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 70006f32e7eSjoerg# will automatically be disabled. 70106f32e7eSjoerg# The default value is: YES. 70206f32e7eSjoerg 70306f32e7eSjoergWARN_IF_UNDOCUMENTED = NO 70406f32e7eSjoerg 70506f32e7eSjoerg# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 70606f32e7eSjoerg# potential errors in the documentation, such as not documenting some parameters 70706f32e7eSjoerg# in a documented function, or documenting parameters that don't exist or using 70806f32e7eSjoerg# markup commands wrongly. 70906f32e7eSjoerg# The default value is: YES. 71006f32e7eSjoerg 71106f32e7eSjoergWARN_IF_DOC_ERROR = YES 71206f32e7eSjoerg 71306f32e7eSjoerg# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 71406f32e7eSjoerg# are documented, but have no documentation for their parameters or return 71506f32e7eSjoerg# value. If set to NO doxygen will only warn about wrong or incomplete parameter 71606f32e7eSjoerg# documentation, but not about the absence of documentation. 71706f32e7eSjoerg# The default value is: NO. 71806f32e7eSjoerg 71906f32e7eSjoergWARN_NO_PARAMDOC = NO 72006f32e7eSjoerg 72106f32e7eSjoerg# The WARN_FORMAT tag determines the format of the warning messages that doxygen 72206f32e7eSjoerg# can produce. The string should contain the $file, $line, and $text tags, which 72306f32e7eSjoerg# will be replaced by the file and line number from which the warning originated 72406f32e7eSjoerg# and the warning text. Optionally the format may contain $version, which will 72506f32e7eSjoerg# be replaced by the version of the file (if it could be obtained via 72606f32e7eSjoerg# FILE_VERSION_FILTER) 72706f32e7eSjoerg# The default value is: $file:$line: $text. 72806f32e7eSjoerg 72906f32e7eSjoergWARN_FORMAT = "$file:$line: $text" 73006f32e7eSjoerg 73106f32e7eSjoerg# The WARN_LOGFILE tag can be used to specify a file to which warning and error 73206f32e7eSjoerg# messages should be written. If left blank the output is written to standard 73306f32e7eSjoerg# error (stderr). 73406f32e7eSjoerg 73506f32e7eSjoergWARN_LOGFILE = 73606f32e7eSjoerg 73706f32e7eSjoerg#--------------------------------------------------------------------------- 73806f32e7eSjoerg# Configuration options related to the input files 73906f32e7eSjoerg#--------------------------------------------------------------------------- 74006f32e7eSjoerg 74106f32e7eSjoerg# The INPUT tag is used to specify the files and/or directories that contain 74206f32e7eSjoerg# documented source files. You may enter file names like myfile.cpp or 74306f32e7eSjoerg# directories like /usr/src/myproject. Separate the files or directories with 74406f32e7eSjoerg# spaces. 74506f32e7eSjoerg# Note: If this tag is empty the current directory is searched. 74606f32e7eSjoerg 74706f32e7eSjoergINPUT = @abs_top_srcdir@/../include \ 74806f32e7eSjoerg @abs_top_srcdir@/../lib \ 74906f32e7eSjoerg @abs_top_srcdir@/doxygen-mainpage.dox 75006f32e7eSjoerg 75106f32e7eSjoerg# This tag can be used to specify the character encoding of the source files 75206f32e7eSjoerg# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 75306f32e7eSjoerg# libiconv (or the iconv built into libc) for the transcoding. See the libiconv 75406f32e7eSjoerg# documentation (see: http://www.gnu.org/software/libiconv) for the list of 75506f32e7eSjoerg# possible encodings. 75606f32e7eSjoerg# The default value is: UTF-8. 75706f32e7eSjoerg 75806f32e7eSjoergINPUT_ENCODING = UTF-8 75906f32e7eSjoerg 76006f32e7eSjoerg# If the value of the INPUT tag contains directories, you can use the 76106f32e7eSjoerg# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 76206f32e7eSjoerg# *.h) to filter out the source-files in the directories. If left blank the 76306f32e7eSjoerg# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, 76406f32e7eSjoerg# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, 76506f32e7eSjoerg# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, 76606f32e7eSjoerg# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, 76706f32e7eSjoerg# *.qsf, *.as and *.js. 76806f32e7eSjoerg 76906f32e7eSjoergFILE_PATTERNS = 77006f32e7eSjoerg 77106f32e7eSjoerg# The RECURSIVE tag can be used to specify whether or not subdirectories should 77206f32e7eSjoerg# be searched for input files as well. 77306f32e7eSjoerg# The default value is: NO. 77406f32e7eSjoerg 77506f32e7eSjoergRECURSIVE = YES 77606f32e7eSjoerg 77706f32e7eSjoerg# The EXCLUDE tag can be used to specify files and/or directories that should be 77806f32e7eSjoerg# excluded from the INPUT source files. This way you can easily exclude a 77906f32e7eSjoerg# subdirectory from a directory tree whose root is specified with the INPUT tag. 78006f32e7eSjoerg# 78106f32e7eSjoerg# Note that relative paths are relative to the directory from which doxygen is 78206f32e7eSjoerg# run. 78306f32e7eSjoerg 78406f32e7eSjoergEXCLUDE = 78506f32e7eSjoerg 78606f32e7eSjoerg# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 78706f32e7eSjoerg# directories that are symbolic links (a Unix file system feature) are excluded 78806f32e7eSjoerg# from the input. 78906f32e7eSjoerg# The default value is: NO. 79006f32e7eSjoerg 79106f32e7eSjoergEXCLUDE_SYMLINKS = NO 79206f32e7eSjoerg 79306f32e7eSjoerg# If the value of the INPUT tag contains directories, you can use the 79406f32e7eSjoerg# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 79506f32e7eSjoerg# certain files from those directories. 79606f32e7eSjoerg# 79706f32e7eSjoerg# Note that the wildcards are matched against the file with absolute path, so to 79806f32e7eSjoerg# exclude all test directories for example use the pattern */test/* 79906f32e7eSjoerg 80006f32e7eSjoergEXCLUDE_PATTERNS = 80106f32e7eSjoerg 80206f32e7eSjoerg# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 80306f32e7eSjoerg# (namespaces, classes, functions, etc.) that should be excluded from the 80406f32e7eSjoerg# output. The symbol name can be a fully qualified name, a word, or if the 80506f32e7eSjoerg# wildcard * is used, a substring. Examples: ANamespace, AClass, 80606f32e7eSjoerg# AClass::ANamespace, ANamespace::*Test 80706f32e7eSjoerg# 80806f32e7eSjoerg# Note that the wildcards are matched against the file with absolute path, so to 80906f32e7eSjoerg# exclude all test directories use the pattern */test/* 81006f32e7eSjoerg 81106f32e7eSjoergEXCLUDE_SYMBOLS = 81206f32e7eSjoerg 81306f32e7eSjoerg# The EXAMPLE_PATH tag can be used to specify one or more files or directories 81406f32e7eSjoerg# that contain example code fragments that are included (see the \include 81506f32e7eSjoerg# command). 81606f32e7eSjoerg 81706f32e7eSjoergEXAMPLE_PATH = @abs_top_srcdir@/../examples 81806f32e7eSjoerg 81906f32e7eSjoerg# If the value of the EXAMPLE_PATH tag contains directories, you can use the 82006f32e7eSjoerg# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 82106f32e7eSjoerg# *.h) to filter out the source-files in the directories. If left blank all 82206f32e7eSjoerg# files are included. 82306f32e7eSjoerg 82406f32e7eSjoergEXAMPLE_PATTERNS = 82506f32e7eSjoerg 82606f32e7eSjoerg# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 82706f32e7eSjoerg# searched for input files to be used with the \include or \dontinclude commands 82806f32e7eSjoerg# irrespective of the value of the RECURSIVE tag. 82906f32e7eSjoerg# The default value is: NO. 83006f32e7eSjoerg 83106f32e7eSjoergEXAMPLE_RECURSIVE = YES 83206f32e7eSjoerg 83306f32e7eSjoerg# The IMAGE_PATH tag can be used to specify one or more files or directories 83406f32e7eSjoerg# that contain images that are to be included in the documentation (see the 83506f32e7eSjoerg# \image command). 83606f32e7eSjoerg 83706f32e7eSjoergIMAGE_PATH = @abs_top_srcdir@/img 83806f32e7eSjoerg 83906f32e7eSjoerg# The INPUT_FILTER tag can be used to specify a program that doxygen should 84006f32e7eSjoerg# invoke to filter for each input file. Doxygen will invoke the filter program 84106f32e7eSjoerg# by executing (via popen()) the command: 84206f32e7eSjoerg# 84306f32e7eSjoerg# <filter> <input-file> 84406f32e7eSjoerg# 84506f32e7eSjoerg# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the 84606f32e7eSjoerg# name of an input file. Doxygen will then use the output that the filter 84706f32e7eSjoerg# program writes to standard output. If FILTER_PATTERNS is specified, this tag 84806f32e7eSjoerg# will be ignored. 84906f32e7eSjoerg# 85006f32e7eSjoerg# Note that the filter must not add or remove lines; it is applied before the 85106f32e7eSjoerg# code is scanned, but not when the output code is generated. If lines are added 85206f32e7eSjoerg# or removed, the anchors will not be placed correctly. 85306f32e7eSjoerg 85406f32e7eSjoergINPUT_FILTER = 85506f32e7eSjoerg 85606f32e7eSjoerg# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 85706f32e7eSjoerg# basis. Doxygen will compare the file name with each pattern and apply the 85806f32e7eSjoerg# filter if there is a match. The filters are a list of the form: pattern=filter 85906f32e7eSjoerg# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 86006f32e7eSjoerg# filters are used. If the FILTER_PATTERNS tag is empty or if none of the 86106f32e7eSjoerg# patterns match the file name, INPUT_FILTER is applied. 86206f32e7eSjoerg 86306f32e7eSjoergFILTER_PATTERNS = 86406f32e7eSjoerg 86506f32e7eSjoerg# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 86606f32e7eSjoerg# INPUT_FILTER ) will also be used to filter the input files that are used for 86706f32e7eSjoerg# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 86806f32e7eSjoerg# The default value is: NO. 86906f32e7eSjoerg 87006f32e7eSjoergFILTER_SOURCE_FILES = NO 87106f32e7eSjoerg 87206f32e7eSjoerg# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 87306f32e7eSjoerg# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 87406f32e7eSjoerg# it is also possible to disable source filtering for a specific pattern using 87506f32e7eSjoerg# *.ext= (so without naming a filter). 87606f32e7eSjoerg# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 87706f32e7eSjoerg 87806f32e7eSjoergFILTER_SOURCE_PATTERNS = 87906f32e7eSjoerg 88006f32e7eSjoerg# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 88106f32e7eSjoerg# is part of the input, its contents will be placed on the main page 88206f32e7eSjoerg# (index.html). This can be useful if you have a project on for instance GitHub 88306f32e7eSjoerg# and want to reuse the introduction page also for the doxygen output. 88406f32e7eSjoerg 88506f32e7eSjoergUSE_MDFILE_AS_MAINPAGE = 88606f32e7eSjoerg 88706f32e7eSjoerg#--------------------------------------------------------------------------- 88806f32e7eSjoerg# Configuration options related to source browsing 88906f32e7eSjoerg#--------------------------------------------------------------------------- 89006f32e7eSjoerg 89106f32e7eSjoerg# If the SOURCE_BROWSER tag is set to YES then a list of source files will be 89206f32e7eSjoerg# generated. Documented entities will be cross-referenced with these sources. 89306f32e7eSjoerg# 89406f32e7eSjoerg# Note: To get rid of all source code in the generated output, make sure that 89506f32e7eSjoerg# also VERBATIM_HEADERS is set to NO. 89606f32e7eSjoerg# The default value is: NO. 89706f32e7eSjoerg 89806f32e7eSjoergSOURCE_BROWSER = YES 89906f32e7eSjoerg 90006f32e7eSjoerg# Setting the INLINE_SOURCES tag to YES will include the body of functions, 90106f32e7eSjoerg# classes and enums directly into the documentation. 90206f32e7eSjoerg# The default value is: NO. 90306f32e7eSjoerg 90406f32e7eSjoergINLINE_SOURCES = NO 90506f32e7eSjoerg 90606f32e7eSjoerg# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 90706f32e7eSjoerg# special comment blocks from generated source code fragments. Normal C, C++ and 90806f32e7eSjoerg# Fortran comments will always remain visible. 90906f32e7eSjoerg# The default value is: YES. 91006f32e7eSjoerg 91106f32e7eSjoergSTRIP_CODE_COMMENTS = NO 91206f32e7eSjoerg 91306f32e7eSjoerg# If the REFERENCED_BY_RELATION tag is set to YES then for each documented 91406f32e7eSjoerg# function all documented functions referencing it will be listed. 91506f32e7eSjoerg# The default value is: NO. 91606f32e7eSjoerg 91706f32e7eSjoergREFERENCED_BY_RELATION = YES 91806f32e7eSjoerg 91906f32e7eSjoerg# If the REFERENCES_RELATION tag is set to YES then for each documented function 92006f32e7eSjoerg# all documented entities called/used by that function will be listed. 92106f32e7eSjoerg# The default value is: NO. 92206f32e7eSjoerg 92306f32e7eSjoergREFERENCES_RELATION = YES 92406f32e7eSjoerg 92506f32e7eSjoerg# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 92606f32e7eSjoerg# to YES, then the hyperlinks from functions in REFERENCES_RELATION and 92706f32e7eSjoerg# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 92806f32e7eSjoerg# link to the documentation. 92906f32e7eSjoerg# The default value is: YES. 93006f32e7eSjoerg 93106f32e7eSjoergREFERENCES_LINK_SOURCE = YES 93206f32e7eSjoerg 93306f32e7eSjoerg# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 93406f32e7eSjoerg# source code will show a tooltip with additional information such as prototype, 93506f32e7eSjoerg# brief description and links to the definition and documentation. Since this 93606f32e7eSjoerg# will make the HTML file larger and loading of large files a bit slower, you 93706f32e7eSjoerg# can opt to disable this feature. 93806f32e7eSjoerg# The default value is: YES. 93906f32e7eSjoerg# This tag requires that the tag SOURCE_BROWSER is set to YES. 94006f32e7eSjoerg 94106f32e7eSjoergSOURCE_TOOLTIPS = YES 94206f32e7eSjoerg 94306f32e7eSjoerg# If the USE_HTAGS tag is set to YES then the references to source code will 94406f32e7eSjoerg# point to the HTML generated by the htags(1) tool instead of doxygen built-in 94506f32e7eSjoerg# source browser. The htags tool is part of GNU's global source tagging system 94606f32e7eSjoerg# (see http://www.gnu.org/software/global/global.html). You will need version 94706f32e7eSjoerg# 4.8.6 or higher. 94806f32e7eSjoerg# 94906f32e7eSjoerg# To use it do the following: 95006f32e7eSjoerg# - Install the latest version of global 95106f32e7eSjoerg# - Enable SOURCE_BROWSER and USE_HTAGS in the config file 95206f32e7eSjoerg# - Make sure the INPUT points to the root of the source tree 95306f32e7eSjoerg# - Run doxygen as normal 95406f32e7eSjoerg# 95506f32e7eSjoerg# Doxygen will invoke htags (and that will in turn invoke gtags), so these 95606f32e7eSjoerg# tools must be available from the command line (i.e. in the search path). 95706f32e7eSjoerg# 95806f32e7eSjoerg# The result: instead of the source browser generated by doxygen, the links to 95906f32e7eSjoerg# source code will now point to the output of htags. 96006f32e7eSjoerg# The default value is: NO. 96106f32e7eSjoerg# This tag requires that the tag SOURCE_BROWSER is set to YES. 96206f32e7eSjoerg 96306f32e7eSjoergUSE_HTAGS = NO 96406f32e7eSjoerg 96506f32e7eSjoerg# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 96606f32e7eSjoerg# verbatim copy of the header file for each class for which an include is 96706f32e7eSjoerg# specified. Set to NO to disable this. 96806f32e7eSjoerg# See also: Section \class. 96906f32e7eSjoerg# The default value is: YES. 97006f32e7eSjoerg 97106f32e7eSjoergVERBATIM_HEADERS = YES 97206f32e7eSjoerg 97306f32e7eSjoerg#--------------------------------------------------------------------------- 97406f32e7eSjoerg# Configuration options related to the alphabetical class index 97506f32e7eSjoerg#--------------------------------------------------------------------------- 97606f32e7eSjoerg 97706f32e7eSjoerg# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 97806f32e7eSjoerg# compounds will be generated. Enable this if the project contains a lot of 97906f32e7eSjoerg# classes, structs, unions or interfaces. 98006f32e7eSjoerg# The default value is: YES. 98106f32e7eSjoerg 98206f32e7eSjoergALPHABETICAL_INDEX = YES 98306f32e7eSjoerg 98406f32e7eSjoerg# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 98506f32e7eSjoerg# which the alphabetical index list will be split. 98606f32e7eSjoerg# Minimum value: 1, maximum value: 20, default value: 5. 98706f32e7eSjoerg# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 98806f32e7eSjoerg 98906f32e7eSjoergCOLS_IN_ALPHA_INDEX = 4 99006f32e7eSjoerg 99106f32e7eSjoerg# In case all classes in a project start with a common prefix, all classes will 99206f32e7eSjoerg# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 99306f32e7eSjoerg# can be used to specify a prefix (or a list of prefixes) that should be ignored 99406f32e7eSjoerg# while generating the index headers. 99506f32e7eSjoerg# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 99606f32e7eSjoerg 99706f32e7eSjoergIGNORE_PREFIX = llvm:: 99806f32e7eSjoerg 99906f32e7eSjoerg#--------------------------------------------------------------------------- 100006f32e7eSjoerg# Configuration options related to the HTML output 100106f32e7eSjoerg#--------------------------------------------------------------------------- 100206f32e7eSjoerg 100306f32e7eSjoerg# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output 100406f32e7eSjoerg# The default value is: YES. 100506f32e7eSjoerg 100606f32e7eSjoergGENERATE_HTML = YES 100706f32e7eSjoerg 100806f32e7eSjoerg# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 100906f32e7eSjoerg# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 101006f32e7eSjoerg# it. 101106f32e7eSjoerg# The default directory is: html. 101206f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 101306f32e7eSjoerg 101406f32e7eSjoergHTML_OUTPUT = html 101506f32e7eSjoerg 101606f32e7eSjoerg# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 101706f32e7eSjoerg# generated HTML page (for example: .htm, .php, .asp). 101806f32e7eSjoerg# The default value is: .html. 101906f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 102006f32e7eSjoerg 102106f32e7eSjoergHTML_FILE_EXTENSION = .html 102206f32e7eSjoerg 102306f32e7eSjoerg# The HTML_HEADER tag can be used to specify a user-defined HTML header file for 102406f32e7eSjoerg# each generated HTML page. If the tag is left blank doxygen will generate a 102506f32e7eSjoerg# standard header. 102606f32e7eSjoerg# 102706f32e7eSjoerg# To get valid HTML the header file that includes any scripts and style sheets 102806f32e7eSjoerg# that doxygen needs, which is dependent on the configuration options used (e.g. 102906f32e7eSjoerg# the setting GENERATE_TREEVIEW). It is highly recommended to start with a 103006f32e7eSjoerg# default header using 103106f32e7eSjoerg# doxygen -w html new_header.html new_footer.html new_stylesheet.css 103206f32e7eSjoerg# YourConfigFile 103306f32e7eSjoerg# and then modify the file new_header.html. See also section "Doxygen usage" 103406f32e7eSjoerg# for information on how to generate the default header that doxygen normally 103506f32e7eSjoerg# uses. 103606f32e7eSjoerg# Note: The header is subject to change so you typically have to regenerate the 103706f32e7eSjoerg# default header when upgrading to a newer version of doxygen. For a description 103806f32e7eSjoerg# of the possible markers and block names see the documentation. 103906f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 104006f32e7eSjoerg 104106f32e7eSjoergHTML_HEADER = 104206f32e7eSjoerg 104306f32e7eSjoerg# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 104406f32e7eSjoerg# generated HTML page. If the tag is left blank doxygen will generate a standard 104506f32e7eSjoerg# footer. See HTML_HEADER for more information on how to generate a default 104606f32e7eSjoerg# footer and what special commands can be used inside the footer. See also 104706f32e7eSjoerg# section "Doxygen usage" for information on how to generate the default footer 104806f32e7eSjoerg# that doxygen normally uses. 104906f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 105006f32e7eSjoerg 105106f32e7eSjoergHTML_FOOTER = 105206f32e7eSjoerg 105306f32e7eSjoerg# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 105406f32e7eSjoerg# sheet that is used by each HTML page. It can be used to fine-tune the look of 105506f32e7eSjoerg# the HTML output. If left blank doxygen will generate a default style sheet. 105606f32e7eSjoerg# See also section "Doxygen usage" for information on how to generate the style 105706f32e7eSjoerg# sheet that doxygen normally uses. 105806f32e7eSjoerg# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 105906f32e7eSjoerg# it is more robust and this tag (HTML_STYLESHEET) will in the future become 106006f32e7eSjoerg# obsolete. 106106f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 106206f32e7eSjoerg 106306f32e7eSjoergHTML_STYLESHEET = 106406f32e7eSjoerg 106506f32e7eSjoerg# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- 106606f32e7eSjoerg# defined cascading style sheet that is included after the standard style sheets 106706f32e7eSjoerg# created by doxygen. Using this option one can overrule certain style aspects. 106806f32e7eSjoerg# This is preferred over using HTML_STYLESHEET since it does not replace the 106906f32e7eSjoerg# standard style sheet and is therefor more robust against future updates. 107006f32e7eSjoerg# Doxygen will copy the style sheet file to the output directory. For an example 107106f32e7eSjoerg# see the documentation. 107206f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 107306f32e7eSjoerg 107406f32e7eSjoergHTML_EXTRA_STYLESHEET = 107506f32e7eSjoerg 107606f32e7eSjoerg# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 107706f32e7eSjoerg# other source files which should be copied to the HTML output directory. Note 107806f32e7eSjoerg# that these files will be copied to the base HTML output directory. Use the 107906f32e7eSjoerg# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 108006f32e7eSjoerg# files. In the HTML_STYLESHEET file, use the file name only. Also note that the 108106f32e7eSjoerg# files will be copied as-is; there are no commands or markers available. 108206f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 108306f32e7eSjoerg 108406f32e7eSjoergHTML_EXTRA_FILES = 108506f32e7eSjoerg 108606f32e7eSjoerg# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 108706f32e7eSjoerg# will adjust the colors in the stylesheet and background images according to 108806f32e7eSjoerg# this color. Hue is specified as an angle on a colorwheel, see 108906f32e7eSjoerg# http://en.wikipedia.org/wiki/Hue for more information. For instance the value 109006f32e7eSjoerg# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 109106f32e7eSjoerg# purple, and 360 is red again. 109206f32e7eSjoerg# Minimum value: 0, maximum value: 359, default value: 220. 109306f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 109406f32e7eSjoerg 109506f32e7eSjoergHTML_COLORSTYLE_HUE = 220 109606f32e7eSjoerg 109706f32e7eSjoerg# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 109806f32e7eSjoerg# in the HTML output. For a value of 0 the output will use grayscales only. A 109906f32e7eSjoerg# value of 255 will produce the most vivid colors. 110006f32e7eSjoerg# Minimum value: 0, maximum value: 255, default value: 100. 110106f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 110206f32e7eSjoerg 110306f32e7eSjoergHTML_COLORSTYLE_SAT = 100 110406f32e7eSjoerg 110506f32e7eSjoerg# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 110606f32e7eSjoerg# luminance component of the colors in the HTML output. Values below 100 110706f32e7eSjoerg# gradually make the output lighter, whereas values above 100 make the output 110806f32e7eSjoerg# darker. The value divided by 100 is the actual gamma applied, so 80 represents 110906f32e7eSjoerg# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 111006f32e7eSjoerg# change the gamma. 111106f32e7eSjoerg# Minimum value: 40, maximum value: 240, default value: 80. 111206f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 111306f32e7eSjoerg 111406f32e7eSjoergHTML_COLORSTYLE_GAMMA = 80 111506f32e7eSjoerg 111606f32e7eSjoerg# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 111706f32e7eSjoerg# page will contain the date and time when the page was generated. Setting this 111806f32e7eSjoerg# to NO can help when comparing the output of multiple runs. 111906f32e7eSjoerg# The default value is: YES. 112006f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 112106f32e7eSjoerg 112206f32e7eSjoergHTML_TIMESTAMP = YES 112306f32e7eSjoerg 112406f32e7eSjoerg# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 112506f32e7eSjoerg# documentation will contain sections that can be hidden and shown after the 112606f32e7eSjoerg# page has loaded. 112706f32e7eSjoerg# The default value is: NO. 112806f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 112906f32e7eSjoerg 113006f32e7eSjoergHTML_DYNAMIC_SECTIONS = NO 113106f32e7eSjoerg 113206f32e7eSjoerg# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 113306f32e7eSjoerg# shown in the various tree structured indices initially; the user can expand 113406f32e7eSjoerg# and collapse entries dynamically later on. Doxygen will expand the tree to 113506f32e7eSjoerg# such a level that at most the specified number of entries are visible (unless 113606f32e7eSjoerg# a fully collapsed tree already exceeds this amount). So setting the number of 113706f32e7eSjoerg# entries 1 will produce a full collapsed tree by default. 0 is a special value 113806f32e7eSjoerg# representing an infinite number of entries and will result in a full expanded 113906f32e7eSjoerg# tree by default. 114006f32e7eSjoerg# Minimum value: 0, maximum value: 9999, default value: 100. 114106f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 114206f32e7eSjoerg 114306f32e7eSjoergHTML_INDEX_NUM_ENTRIES = 100 114406f32e7eSjoerg 114506f32e7eSjoerg# If the GENERATE_DOCSET tag is set to YES, additional index files will be 114606f32e7eSjoerg# generated that can be used as input for Apple's Xcode 3 integrated development 114706f32e7eSjoerg# environment (see: http://developer.apple.com/tools/xcode/), introduced with 114806f32e7eSjoerg# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 114906f32e7eSjoerg# Makefile in the HTML output directory. Running make will produce the docset in 115006f32e7eSjoerg# that directory and running make install will install the docset in 115106f32e7eSjoerg# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 115206f32e7eSjoerg# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 115306f32e7eSjoerg# for more information. 115406f32e7eSjoerg# The default value is: NO. 115506f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 115606f32e7eSjoerg 115706f32e7eSjoergGENERATE_DOCSET = NO 115806f32e7eSjoerg 115906f32e7eSjoerg# This tag determines the name of the docset feed. A documentation feed provides 116006f32e7eSjoerg# an umbrella under which multiple documentation sets from a single provider 116106f32e7eSjoerg# (such as a company or product suite) can be grouped. 116206f32e7eSjoerg# The default value is: Doxygen generated docs. 116306f32e7eSjoerg# This tag requires that the tag GENERATE_DOCSET is set to YES. 116406f32e7eSjoerg 116506f32e7eSjoergDOCSET_FEEDNAME = "Doxygen generated docs" 116606f32e7eSjoerg 116706f32e7eSjoerg# This tag specifies a string that should uniquely identify the documentation 116806f32e7eSjoerg# set bundle. This should be a reverse domain-name style string, e.g. 116906f32e7eSjoerg# com.mycompany.MyDocSet. Doxygen will append .docset to the name. 117006f32e7eSjoerg# The default value is: org.doxygen.Project. 117106f32e7eSjoerg# This tag requires that the tag GENERATE_DOCSET is set to YES. 117206f32e7eSjoerg 117306f32e7eSjoergDOCSET_BUNDLE_ID = org.doxygen.Project 117406f32e7eSjoerg 117506f32e7eSjoerg# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 117606f32e7eSjoerg# the documentation publisher. This should be a reverse domain-name style 117706f32e7eSjoerg# string, e.g. com.mycompany.MyDocSet.documentation. 117806f32e7eSjoerg# The default value is: org.doxygen.Publisher. 117906f32e7eSjoerg# This tag requires that the tag GENERATE_DOCSET is set to YES. 118006f32e7eSjoerg 118106f32e7eSjoergDOCSET_PUBLISHER_ID = org.doxygen.Publisher 118206f32e7eSjoerg 118306f32e7eSjoerg# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 118406f32e7eSjoerg# The default value is: Publisher. 118506f32e7eSjoerg# This tag requires that the tag GENERATE_DOCSET is set to YES. 118606f32e7eSjoerg 118706f32e7eSjoergDOCSET_PUBLISHER_NAME = Publisher 118806f32e7eSjoerg 118906f32e7eSjoerg# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 119006f32e7eSjoerg# additional HTML index files: index.hhp, index.hhc, and index.hhk. The 119106f32e7eSjoerg# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 119206f32e7eSjoerg# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 119306f32e7eSjoerg# Windows. 119406f32e7eSjoerg# 119506f32e7eSjoerg# The HTML Help Workshop contains a compiler that can convert all HTML output 119606f32e7eSjoerg# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 119706f32e7eSjoerg# files are now used as the Windows 98 help format, and will replace the old 119806f32e7eSjoerg# Windows help format (.hlp) on all Windows platforms in the future. Compressed 119906f32e7eSjoerg# HTML files also contain an index, a table of contents, and you can search for 120006f32e7eSjoerg# words in the documentation. The HTML workshop also contains a viewer for 120106f32e7eSjoerg# compressed HTML files. 120206f32e7eSjoerg# The default value is: NO. 120306f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 120406f32e7eSjoerg 120506f32e7eSjoergGENERATE_HTMLHELP = NO 120606f32e7eSjoerg 120706f32e7eSjoerg# The CHM_FILE tag can be used to specify the file name of the resulting .chm 120806f32e7eSjoerg# file. You can add a path in front of the file if the result should not be 120906f32e7eSjoerg# written to the html output directory. 121006f32e7eSjoerg# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 121106f32e7eSjoerg 121206f32e7eSjoergCHM_FILE = 121306f32e7eSjoerg 121406f32e7eSjoerg# The HHC_LOCATION tag can be used to specify the location (absolute path 121506f32e7eSjoerg# including file name) of the HTML help compiler ( hhc.exe). If non-empty 121606f32e7eSjoerg# doxygen will try to run the HTML help compiler on the generated index.hhp. 121706f32e7eSjoerg# The file has to be specified with full path. 121806f32e7eSjoerg# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 121906f32e7eSjoerg 122006f32e7eSjoergHHC_LOCATION = 122106f32e7eSjoerg 122206f32e7eSjoerg# The GENERATE_CHI flag controls if a separate .chi index file is generated ( 122306f32e7eSjoerg# YES) or that it should be included in the master .chm file ( NO). 122406f32e7eSjoerg# The default value is: NO. 122506f32e7eSjoerg# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 122606f32e7eSjoerg 122706f32e7eSjoergGENERATE_CHI = NO 122806f32e7eSjoerg 122906f32e7eSjoerg# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) 123006f32e7eSjoerg# and project file content. 123106f32e7eSjoerg# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 123206f32e7eSjoerg 123306f32e7eSjoergCHM_INDEX_ENCODING = 123406f32e7eSjoerg 123506f32e7eSjoerg# The BINARY_TOC flag controls whether a binary table of contents is generated ( 123606f32e7eSjoerg# YES) or a normal table of contents ( NO) in the .chm file. 123706f32e7eSjoerg# The default value is: NO. 123806f32e7eSjoerg# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 123906f32e7eSjoerg 124006f32e7eSjoergBINARY_TOC = NO 124106f32e7eSjoerg 124206f32e7eSjoerg# The TOC_EXPAND flag can be set to YES to add extra items for group members to 124306f32e7eSjoerg# the table of contents of the HTML help documentation and to the tree view. 124406f32e7eSjoerg# The default value is: NO. 124506f32e7eSjoerg# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 124606f32e7eSjoerg 124706f32e7eSjoergTOC_EXPAND = NO 124806f32e7eSjoerg 124906f32e7eSjoerg# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 125006f32e7eSjoerg# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 125106f32e7eSjoerg# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 125206f32e7eSjoerg# (.qch) of the generated HTML documentation. 125306f32e7eSjoerg# The default value is: NO. 125406f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 125506f32e7eSjoerg 125606f32e7eSjoergGENERATE_QHP = @llvm_doxygen_generate_qhp@ 125706f32e7eSjoerg 125806f32e7eSjoerg# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 125906f32e7eSjoerg# the file name of the resulting .qch file. The path specified is relative to 126006f32e7eSjoerg# the HTML output folder. 126106f32e7eSjoerg# This tag requires that the tag GENERATE_QHP is set to YES. 126206f32e7eSjoerg 126306f32e7eSjoergQCH_FILE = @llvm_doxygen_qch_filename@ 126406f32e7eSjoerg 126506f32e7eSjoerg# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 126606f32e7eSjoerg# Project output. For more information please see Qt Help Project / Namespace 126706f32e7eSjoerg# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 126806f32e7eSjoerg# The default value is: org.doxygen.Project. 126906f32e7eSjoerg# This tag requires that the tag GENERATE_QHP is set to YES. 127006f32e7eSjoerg 127106f32e7eSjoergQHP_NAMESPACE = @llvm_doxygen_qhp_namespace@ 127206f32e7eSjoerg 127306f32e7eSjoerg# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 127406f32e7eSjoerg# Help Project output. For more information please see Qt Help Project / Virtual 127506f32e7eSjoerg# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 127606f32e7eSjoerg# folders). 127706f32e7eSjoerg# The default value is: doc. 127806f32e7eSjoerg# This tag requires that the tag GENERATE_QHP is set to YES. 127906f32e7eSjoerg 128006f32e7eSjoergQHP_VIRTUAL_FOLDER = doc 128106f32e7eSjoerg 128206f32e7eSjoerg# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 128306f32e7eSjoerg# filter to add. For more information please see Qt Help Project / Custom 128406f32e7eSjoerg# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 128506f32e7eSjoerg# filters). 128606f32e7eSjoerg# This tag requires that the tag GENERATE_QHP is set to YES. 128706f32e7eSjoerg 128806f32e7eSjoergQHP_CUST_FILTER_NAME = @llvm_doxygen_qhp_cust_filter_name@ 128906f32e7eSjoerg 129006f32e7eSjoerg# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 129106f32e7eSjoerg# custom filter to add. For more information please see Qt Help Project / Custom 129206f32e7eSjoerg# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 129306f32e7eSjoerg# filters). 129406f32e7eSjoerg# This tag requires that the tag GENERATE_QHP is set to YES. 129506f32e7eSjoerg 129606f32e7eSjoergQHP_CUST_FILTER_ATTRS = @llvm_doxygen_qhp_cust_filter_attrs@ 129706f32e7eSjoerg 129806f32e7eSjoerg# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 129906f32e7eSjoerg# project's filter section matches. Qt Help Project / Filter Attributes (see: 130006f32e7eSjoerg# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 130106f32e7eSjoerg# This tag requires that the tag GENERATE_QHP is set to YES. 130206f32e7eSjoerg 130306f32e7eSjoergQHP_SECT_FILTER_ATTRS = 130406f32e7eSjoerg 130506f32e7eSjoerg# The QHG_LOCATION tag can be used to specify the location of Qt's 130606f32e7eSjoerg# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 130706f32e7eSjoerg# generated .qhp file. 130806f32e7eSjoerg# This tag requires that the tag GENERATE_QHP is set to YES. 130906f32e7eSjoerg 131006f32e7eSjoergQHG_LOCATION = @llvm_doxygen_qhelpgenerator_path@ 131106f32e7eSjoerg 131206f32e7eSjoerg# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 131306f32e7eSjoerg# generated, together with the HTML files, they form an Eclipse help plugin. To 131406f32e7eSjoerg# install this plugin and make it available under the help contents menu in 131506f32e7eSjoerg# Eclipse, the contents of the directory containing the HTML and XML files needs 131606f32e7eSjoerg# to be copied into the plugins directory of eclipse. The name of the directory 131706f32e7eSjoerg# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 131806f32e7eSjoerg# After copying Eclipse needs to be restarted before the help appears. 131906f32e7eSjoerg# The default value is: NO. 132006f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 132106f32e7eSjoerg 132206f32e7eSjoergGENERATE_ECLIPSEHELP = NO 132306f32e7eSjoerg 132406f32e7eSjoerg# A unique identifier for the Eclipse help plugin. When installing the plugin 132506f32e7eSjoerg# the directory name containing the HTML and XML files should also have this 132606f32e7eSjoerg# name. Each documentation set should have its own identifier. 132706f32e7eSjoerg# The default value is: org.doxygen.Project. 132806f32e7eSjoerg# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 132906f32e7eSjoerg 133006f32e7eSjoergECLIPSE_DOC_ID = org.doxygen.Project 133106f32e7eSjoerg 133206f32e7eSjoerg# If you want full control over the layout of the generated HTML pages it might 133306f32e7eSjoerg# be necessary to disable the index and replace it with your own. The 133406f32e7eSjoerg# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 133506f32e7eSjoerg# of each HTML page. A value of NO enables the index and the value YES disables 133606f32e7eSjoerg# it. Since the tabs in the index contain the same information as the navigation 133706f32e7eSjoerg# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 133806f32e7eSjoerg# The default value is: NO. 133906f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 134006f32e7eSjoerg 134106f32e7eSjoergDISABLE_INDEX = NO 134206f32e7eSjoerg 134306f32e7eSjoerg# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 134406f32e7eSjoerg# structure should be generated to display hierarchical information. If the tag 134506f32e7eSjoerg# value is set to YES, a side panel will be generated containing a tree-like 134606f32e7eSjoerg# index structure (just like the one that is generated for HTML Help). For this 134706f32e7eSjoerg# to work a browser that supports JavaScript, DHTML, CSS and frames is required 134806f32e7eSjoerg# (i.e. any modern browser). Windows users are probably better off using the 134906f32e7eSjoerg# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can 135006f32e7eSjoerg# further fine-tune the look of the index. As an example, the default style 135106f32e7eSjoerg# sheet generated by doxygen has an example that shows how to put an image at 135206f32e7eSjoerg# the root of the tree instead of the PROJECT_NAME. Since the tree basically has 135306f32e7eSjoerg# the same information as the tab index, you could consider setting 135406f32e7eSjoerg# DISABLE_INDEX to YES when enabling this option. 135506f32e7eSjoerg# The default value is: NO. 135606f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 135706f32e7eSjoerg 135806f32e7eSjoergGENERATE_TREEVIEW = NO 135906f32e7eSjoerg 136006f32e7eSjoerg# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 136106f32e7eSjoerg# doxygen will group on one line in the generated HTML documentation. 136206f32e7eSjoerg# 136306f32e7eSjoerg# Note that a value of 0 will completely suppress the enum values from appearing 136406f32e7eSjoerg# in the overview section. 136506f32e7eSjoerg# Minimum value: 0, maximum value: 20, default value: 4. 136606f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 136706f32e7eSjoerg 136806f32e7eSjoergENUM_VALUES_PER_LINE = 4 136906f32e7eSjoerg 137006f32e7eSjoerg# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 137106f32e7eSjoerg# to set the initial width (in pixels) of the frame in which the tree is shown. 137206f32e7eSjoerg# Minimum value: 0, maximum value: 1500, default value: 250. 137306f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 137406f32e7eSjoerg 137506f32e7eSjoergTREEVIEW_WIDTH = 250 137606f32e7eSjoerg 137706f32e7eSjoerg# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to 137806f32e7eSjoerg# external symbols imported via tag files in a separate window. 137906f32e7eSjoerg# The default value is: NO. 138006f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 138106f32e7eSjoerg 138206f32e7eSjoergEXT_LINKS_IN_WINDOW = NO 138306f32e7eSjoerg 138406f32e7eSjoerg# Use this tag to change the font size of LaTeX formulas included as images in 138506f32e7eSjoerg# the HTML documentation. When you change the font size after a successful 138606f32e7eSjoerg# doxygen run you need to manually remove any form_*.png images from the HTML 138706f32e7eSjoerg# output directory to force them to be regenerated. 138806f32e7eSjoerg# Minimum value: 8, maximum value: 50, default value: 10. 138906f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 139006f32e7eSjoerg 139106f32e7eSjoergFORMULA_FONTSIZE = 10 139206f32e7eSjoerg 139306f32e7eSjoerg# Use the FORMULA_TRANPARENT tag to determine whether or not the images 139406f32e7eSjoerg# generated for formulas are transparent PNGs. Transparent PNGs are not 139506f32e7eSjoerg# supported properly for IE 6.0, but are supported on all modern browsers. 139606f32e7eSjoerg# 139706f32e7eSjoerg# Note that when changing this option you need to delete any form_*.png files in 139806f32e7eSjoerg# the HTML output directory before the changes have effect. 139906f32e7eSjoerg# The default value is: YES. 140006f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 140106f32e7eSjoerg 140206f32e7eSjoergFORMULA_TRANSPARENT = YES 140306f32e7eSjoerg 140406f32e7eSjoerg# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 140506f32e7eSjoerg# http://www.mathjax.org) which uses client side Javascript for the rendering 140606f32e7eSjoerg# instead of using prerendered bitmaps. Use this if you do not have LaTeX 140706f32e7eSjoerg# installed or if you want to formulas look prettier in the HTML output. When 140806f32e7eSjoerg# enabled you may also need to install MathJax separately and configure the path 140906f32e7eSjoerg# to it using the MATHJAX_RELPATH option. 141006f32e7eSjoerg# The default value is: NO. 141106f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 141206f32e7eSjoerg 141306f32e7eSjoergUSE_MATHJAX = YES 141406f32e7eSjoerg 141506f32e7eSjoerg# When MathJax is enabled you can set the default output format to be used for 141606f32e7eSjoerg# the MathJax output. See the MathJax site (see: 141706f32e7eSjoerg# http://docs.mathjax.org/en/latest/output.html) for more details. 141806f32e7eSjoerg# Possible values are: HTML-CSS (which is slower, but has the best 141906f32e7eSjoerg# compatibility), NativeMML (i.e. MathML) and SVG. 142006f32e7eSjoerg# The default value is: HTML-CSS. 142106f32e7eSjoerg# This tag requires that the tag USE_MATHJAX is set to YES. 142206f32e7eSjoerg 142306f32e7eSjoergMATHJAX_FORMAT = HTML-CSS 142406f32e7eSjoerg 142506f32e7eSjoerg# When MathJax is enabled you need to specify the location relative to the HTML 142606f32e7eSjoerg# output directory using the MATHJAX_RELPATH option. The destination directory 142706f32e7eSjoerg# should contain the MathJax.js script. For instance, if the mathjax directory 142806f32e7eSjoerg# is located at the same level as the HTML output directory, then 142906f32e7eSjoerg# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 143006f32e7eSjoerg# Content Delivery Network so you can quickly see the result without installing 143106f32e7eSjoerg# MathJax. However, it is strongly recommended to install a local copy of 143206f32e7eSjoerg# MathJax from http://www.mathjax.org before deployment. 143306f32e7eSjoerg# The default value is: http://cdn.mathjax.org/mathjax/latest. 143406f32e7eSjoerg# This tag requires that the tag USE_MATHJAX is set to YES. 143506f32e7eSjoerg 1436*da58b97aSjoergMATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js 143706f32e7eSjoerg 143806f32e7eSjoerg# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 143906f32e7eSjoerg# extension names that should be enabled during MathJax rendering. For example 144006f32e7eSjoerg# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 144106f32e7eSjoerg# This tag requires that the tag USE_MATHJAX is set to YES. 144206f32e7eSjoerg 144306f32e7eSjoergMATHJAX_EXTENSIONS = 144406f32e7eSjoerg 144506f32e7eSjoerg# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 144606f32e7eSjoerg# of code that will be used on startup of the MathJax code. See the MathJax site 144706f32e7eSjoerg# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 144806f32e7eSjoerg# example see the documentation. 144906f32e7eSjoerg# This tag requires that the tag USE_MATHJAX is set to YES. 145006f32e7eSjoerg 145106f32e7eSjoergMATHJAX_CODEFILE = 145206f32e7eSjoerg 145306f32e7eSjoerg# When the SEARCHENGINE tag is enabled doxygen will generate a search box for 145406f32e7eSjoerg# the HTML output. The underlying search engine uses javascript and DHTML and 145506f32e7eSjoerg# should work on any modern browser. Note that when using HTML help 145606f32e7eSjoerg# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 145706f32e7eSjoerg# there is already a search function so this one should typically be disabled. 145806f32e7eSjoerg# For large projects the javascript based search engine can be slow, then 145906f32e7eSjoerg# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 146006f32e7eSjoerg# search using the keyboard; to jump to the search box use <access key> + S 146106f32e7eSjoerg# (what the <access key> is depends on the OS and browser, but it is typically 146206f32e7eSjoerg# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down 146306f32e7eSjoerg# key> to jump into the search results window, the results can be navigated 146406f32e7eSjoerg# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel 146506f32e7eSjoerg# the search. The filter options can be selected when the cursor is inside the 146606f32e7eSjoerg# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> 146706f32e7eSjoerg# to select a filter and <Enter> or <escape> to activate or cancel the filter 146806f32e7eSjoerg# option. 146906f32e7eSjoerg# The default value is: YES. 147006f32e7eSjoerg# This tag requires that the tag GENERATE_HTML is set to YES. 147106f32e7eSjoerg 147206f32e7eSjoergSEARCHENGINE = @enable_searchengine@ 147306f32e7eSjoerg 147406f32e7eSjoerg# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 147506f32e7eSjoerg# implemented using a web server instead of a web client using Javascript. There 147606f32e7eSjoerg# are two flavours of web server based searching depending on the 147706f32e7eSjoerg# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for 147806f32e7eSjoerg# searching and an index file used by the script. When EXTERNAL_SEARCH is 147906f32e7eSjoerg# enabled the indexing and searching needs to be provided by external tools. See 148006f32e7eSjoerg# the section "External Indexing and Searching" for details. 148106f32e7eSjoerg# The default value is: NO. 148206f32e7eSjoerg# This tag requires that the tag SEARCHENGINE is set to YES. 148306f32e7eSjoerg 148406f32e7eSjoergSERVER_BASED_SEARCH = @enable_server_based_search@ 148506f32e7eSjoerg 148606f32e7eSjoerg# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP 148706f32e7eSjoerg# script for searching. Instead the search results are written to an XML file 148806f32e7eSjoerg# which needs to be processed by an external indexer. Doxygen will invoke an 148906f32e7eSjoerg# external search engine pointed to by the SEARCHENGINE_URL option to obtain the 149006f32e7eSjoerg# search results. 149106f32e7eSjoerg# 149206f32e7eSjoerg# Doxygen ships with an example indexer ( doxyindexer) and search engine 149306f32e7eSjoerg# (doxysearch.cgi) which are based on the open source search engine library 149406f32e7eSjoerg# Xapian (see: http://xapian.org/). 149506f32e7eSjoerg# 149606f32e7eSjoerg# See the section "External Indexing and Searching" for details. 149706f32e7eSjoerg# The default value is: NO. 149806f32e7eSjoerg# This tag requires that the tag SEARCHENGINE is set to YES. 149906f32e7eSjoerg 150006f32e7eSjoergEXTERNAL_SEARCH = @enable_external_search@ 150106f32e7eSjoerg 150206f32e7eSjoerg# The SEARCHENGINE_URL should point to a search engine hosted by a web server 150306f32e7eSjoerg# which will return the search results when EXTERNAL_SEARCH is enabled. 150406f32e7eSjoerg# 150506f32e7eSjoerg# Doxygen ships with an example indexer ( doxyindexer) and search engine 150606f32e7eSjoerg# (doxysearch.cgi) which are based on the open source search engine library 150706f32e7eSjoerg# Xapian (see: http://xapian.org/). See the section "External Indexing and 150806f32e7eSjoerg# Searching" for details. 150906f32e7eSjoerg# This tag requires that the tag SEARCHENGINE is set to YES. 151006f32e7eSjoerg 151106f32e7eSjoergSEARCHENGINE_URL = @searchengine_url@ 151206f32e7eSjoerg 151306f32e7eSjoerg# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed 151406f32e7eSjoerg# search data is written to a file for indexing by an external tool. With the 151506f32e7eSjoerg# SEARCHDATA_FILE tag the name of this file can be specified. 151606f32e7eSjoerg# The default file is: searchdata.xml. 151706f32e7eSjoerg# This tag requires that the tag SEARCHENGINE is set to YES. 151806f32e7eSjoerg 151906f32e7eSjoergSEARCHDATA_FILE = searchdata.xml 152006f32e7eSjoerg 152106f32e7eSjoerg# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the 152206f32e7eSjoerg# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is 152306f32e7eSjoerg# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple 152406f32e7eSjoerg# projects and redirect the results back to the right project. 152506f32e7eSjoerg# This tag requires that the tag SEARCHENGINE is set to YES. 152606f32e7eSjoerg 152706f32e7eSjoergEXTERNAL_SEARCH_ID = llvm 152806f32e7eSjoerg 152906f32e7eSjoerg# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen 153006f32e7eSjoerg# projects other than the one defined by this configuration file, but that are 153106f32e7eSjoerg# all added to the same external search index. Each project needs to have a 153206f32e7eSjoerg# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of 153306f32e7eSjoerg# to a relative location where the documentation can be found. The format is: 153406f32e7eSjoerg# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... 153506f32e7eSjoerg# This tag requires that the tag SEARCHENGINE is set to YES. 153606f32e7eSjoerg 153706f32e7eSjoergEXTRA_SEARCH_MAPPINGS = @extra_search_mappings@ 153806f32e7eSjoerg 153906f32e7eSjoerg#--------------------------------------------------------------------------- 154006f32e7eSjoerg# Configuration options related to the LaTeX output 154106f32e7eSjoerg#--------------------------------------------------------------------------- 154206f32e7eSjoerg 154306f32e7eSjoerg# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output. 154406f32e7eSjoerg# The default value is: YES. 154506f32e7eSjoerg 154606f32e7eSjoergGENERATE_LATEX = NO 154706f32e7eSjoerg 154806f32e7eSjoerg# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a 154906f32e7eSjoerg# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 155006f32e7eSjoerg# it. 155106f32e7eSjoerg# The default directory is: latex. 155206f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 155306f32e7eSjoerg 155406f32e7eSjoergLATEX_OUTPUT = latex 155506f32e7eSjoerg 155606f32e7eSjoerg# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 155706f32e7eSjoerg# invoked. 155806f32e7eSjoerg# 155906f32e7eSjoerg# Note that when enabling USE_PDFLATEX this option is only used for generating 156006f32e7eSjoerg# bitmaps for formulas in the HTML output, but not in the Makefile that is 156106f32e7eSjoerg# written to the output directory. 156206f32e7eSjoerg# The default file is: latex. 156306f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 156406f32e7eSjoerg 156506f32e7eSjoergLATEX_CMD_NAME = latex 156606f32e7eSjoerg 156706f32e7eSjoerg# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate 156806f32e7eSjoerg# index for LaTeX. 156906f32e7eSjoerg# The default file is: makeindex. 157006f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 157106f32e7eSjoerg 157206f32e7eSjoergMAKEINDEX_CMD_NAME = makeindex 157306f32e7eSjoerg 157406f32e7eSjoerg# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX 157506f32e7eSjoerg# documents. This may be useful for small projects and may help to save some 157606f32e7eSjoerg# trees in general. 157706f32e7eSjoerg# The default value is: NO. 157806f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 157906f32e7eSjoerg 158006f32e7eSjoergCOMPACT_LATEX = NO 158106f32e7eSjoerg 158206f32e7eSjoerg# The PAPER_TYPE tag can be used to set the paper type that is used by the 158306f32e7eSjoerg# printer. 158406f32e7eSjoerg# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x 158506f32e7eSjoerg# 14 inches) and executive (7.25 x 10.5 inches). 158606f32e7eSjoerg# The default value is: a4. 158706f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 158806f32e7eSjoerg 158906f32e7eSjoergPAPER_TYPE = a4 159006f32e7eSjoerg 159106f32e7eSjoerg# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names 159206f32e7eSjoerg# that should be included in the LaTeX output. To get the times font for 159306f32e7eSjoerg# instance you can specify 159406f32e7eSjoerg# EXTRA_PACKAGES=times 159506f32e7eSjoerg# If left blank no extra packages will be included. 159606f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 159706f32e7eSjoerg 159806f32e7eSjoergEXTRA_PACKAGES = 159906f32e7eSjoerg 160006f32e7eSjoerg# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the 160106f32e7eSjoerg# generated LaTeX document. The header should contain everything until the first 160206f32e7eSjoerg# chapter. If it is left blank doxygen will generate a standard header. See 160306f32e7eSjoerg# section "Doxygen usage" for information on how to let doxygen write the 160406f32e7eSjoerg# default header to a separate file. 160506f32e7eSjoerg# 160606f32e7eSjoerg# Note: Only use a user-defined header if you know what you are doing! The 160706f32e7eSjoerg# following commands have a special meaning inside the header: $title, 160806f32e7eSjoerg# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will 160906f32e7eSjoerg# replace them by respectively the title of the page, the current date and time, 161006f32e7eSjoerg# only the current date, the version number of doxygen, the project name (see 161106f32e7eSjoerg# PROJECT_NAME), or the project number (see PROJECT_NUMBER). 161206f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 161306f32e7eSjoerg 161406f32e7eSjoergLATEX_HEADER = 161506f32e7eSjoerg 161606f32e7eSjoerg# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the 161706f32e7eSjoerg# generated LaTeX document. The footer should contain everything after the last 161806f32e7eSjoerg# chapter. If it is left blank doxygen will generate a standard footer. 161906f32e7eSjoerg# 162006f32e7eSjoerg# Note: Only use a user-defined footer if you know what you are doing! 162106f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 162206f32e7eSjoerg 162306f32e7eSjoergLATEX_FOOTER = 162406f32e7eSjoerg 162506f32e7eSjoerg# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or 162606f32e7eSjoerg# other source files which should be copied to the LATEX_OUTPUT output 162706f32e7eSjoerg# directory. Note that the files will be copied as-is; there are no commands or 162806f32e7eSjoerg# markers available. 162906f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 163006f32e7eSjoerg 163106f32e7eSjoergLATEX_EXTRA_FILES = 163206f32e7eSjoerg 163306f32e7eSjoerg# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is 163406f32e7eSjoerg# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will 163506f32e7eSjoerg# contain links (just like the HTML output) instead of page references. This 163606f32e7eSjoerg# makes the output suitable for online browsing using a PDF viewer. 163706f32e7eSjoerg# The default value is: YES. 163806f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 163906f32e7eSjoerg 164006f32e7eSjoergPDF_HYPERLINKS = YES 164106f32e7eSjoerg 164206f32e7eSjoerg# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate 164306f32e7eSjoerg# the PDF file directly from the LaTeX files. Set this option to YES to get a 164406f32e7eSjoerg# higher quality PDF documentation. 164506f32e7eSjoerg# The default value is: YES. 164606f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 164706f32e7eSjoerg 164806f32e7eSjoergUSE_PDFLATEX = YES 164906f32e7eSjoerg 165006f32e7eSjoerg# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode 165106f32e7eSjoerg# command to the generated LaTeX files. This will instruct LaTeX to keep running 165206f32e7eSjoerg# if errors occur, instead of asking the user for help. This option is also used 165306f32e7eSjoerg# when generating formulas in HTML. 165406f32e7eSjoerg# The default value is: NO. 165506f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 165606f32e7eSjoerg 165706f32e7eSjoergLATEX_BATCHMODE = NO 165806f32e7eSjoerg 165906f32e7eSjoerg# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the 166006f32e7eSjoerg# index chapters (such as File Index, Compound Index, etc.) in the output. 166106f32e7eSjoerg# The default value is: NO. 166206f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 166306f32e7eSjoerg 166406f32e7eSjoergLATEX_HIDE_INDICES = NO 166506f32e7eSjoerg 166606f32e7eSjoerg# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source 166706f32e7eSjoerg# code with syntax highlighting in the LaTeX output. 166806f32e7eSjoerg# 166906f32e7eSjoerg# Note that which sources are shown also depends on other settings such as 167006f32e7eSjoerg# SOURCE_BROWSER. 167106f32e7eSjoerg# The default value is: NO. 167206f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 167306f32e7eSjoerg 167406f32e7eSjoergLATEX_SOURCE_CODE = NO 167506f32e7eSjoerg 167606f32e7eSjoerg# The LATEX_BIB_STYLE tag can be used to specify the style to use for the 167706f32e7eSjoerg# bibliography, e.g. plainnat, or ieeetr. See 167806f32e7eSjoerg# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. 167906f32e7eSjoerg# The default value is: plain. 168006f32e7eSjoerg# This tag requires that the tag GENERATE_LATEX is set to YES. 168106f32e7eSjoerg 168206f32e7eSjoergLATEX_BIB_STYLE = plain 168306f32e7eSjoerg 168406f32e7eSjoerg#--------------------------------------------------------------------------- 168506f32e7eSjoerg# Configuration options related to the RTF output 168606f32e7eSjoerg#--------------------------------------------------------------------------- 168706f32e7eSjoerg 168806f32e7eSjoerg# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The 168906f32e7eSjoerg# RTF output is optimized for Word 97 and may not look too pretty with other RTF 169006f32e7eSjoerg# readers/editors. 169106f32e7eSjoerg# The default value is: NO. 169206f32e7eSjoerg 169306f32e7eSjoergGENERATE_RTF = NO 169406f32e7eSjoerg 169506f32e7eSjoerg# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a 169606f32e7eSjoerg# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 169706f32e7eSjoerg# it. 169806f32e7eSjoerg# The default directory is: rtf. 169906f32e7eSjoerg# This tag requires that the tag GENERATE_RTF is set to YES. 170006f32e7eSjoerg 170106f32e7eSjoergRTF_OUTPUT = rtf 170206f32e7eSjoerg 170306f32e7eSjoerg# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF 170406f32e7eSjoerg# documents. This may be useful for small projects and may help to save some 170506f32e7eSjoerg# trees in general. 170606f32e7eSjoerg# The default value is: NO. 170706f32e7eSjoerg# This tag requires that the tag GENERATE_RTF is set to YES. 170806f32e7eSjoerg 170906f32e7eSjoergCOMPACT_RTF = NO 171006f32e7eSjoerg 171106f32e7eSjoerg# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will 171206f32e7eSjoerg# contain hyperlink fields. The RTF file will contain links (just like the HTML 171306f32e7eSjoerg# output) instead of page references. This makes the output suitable for online 171406f32e7eSjoerg# browsing using Word or some other Word compatible readers that support those 171506f32e7eSjoerg# fields. 171606f32e7eSjoerg# 171706f32e7eSjoerg# Note: WordPad (write) and others do not support links. 171806f32e7eSjoerg# The default value is: NO. 171906f32e7eSjoerg# This tag requires that the tag GENERATE_RTF is set to YES. 172006f32e7eSjoerg 172106f32e7eSjoergRTF_HYPERLINKS = NO 172206f32e7eSjoerg 172306f32e7eSjoerg# Load stylesheet definitions from file. Syntax is similar to doxygen's config 172406f32e7eSjoerg# file, i.e. a series of assignments. You only have to provide replacements, 172506f32e7eSjoerg# missing definitions are set to their default value. 172606f32e7eSjoerg# 172706f32e7eSjoerg# See also section "Doxygen usage" for information on how to generate the 172806f32e7eSjoerg# default style sheet that doxygen normally uses. 172906f32e7eSjoerg# This tag requires that the tag GENERATE_RTF is set to YES. 173006f32e7eSjoerg 173106f32e7eSjoergRTF_STYLESHEET_FILE = 173206f32e7eSjoerg 173306f32e7eSjoerg# Set optional variables used in the generation of an RTF document. Syntax is 173406f32e7eSjoerg# similar to doxygen's config file. A template extensions file can be generated 173506f32e7eSjoerg# using doxygen -e rtf extensionFile. 173606f32e7eSjoerg# This tag requires that the tag GENERATE_RTF is set to YES. 173706f32e7eSjoerg 173806f32e7eSjoergRTF_EXTENSIONS_FILE = 173906f32e7eSjoerg 174006f32e7eSjoerg#--------------------------------------------------------------------------- 174106f32e7eSjoerg# Configuration options related to the man page output 174206f32e7eSjoerg#--------------------------------------------------------------------------- 174306f32e7eSjoerg 174406f32e7eSjoerg# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for 174506f32e7eSjoerg# classes and files. 174606f32e7eSjoerg# The default value is: NO. 174706f32e7eSjoerg 174806f32e7eSjoergGENERATE_MAN = NO 174906f32e7eSjoerg 175006f32e7eSjoerg# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a 175106f32e7eSjoerg# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 175206f32e7eSjoerg# it. A directory man3 will be created inside the directory specified by 175306f32e7eSjoerg# MAN_OUTPUT. 175406f32e7eSjoerg# The default directory is: man. 175506f32e7eSjoerg# This tag requires that the tag GENERATE_MAN is set to YES. 175606f32e7eSjoerg 175706f32e7eSjoergMAN_OUTPUT = man 175806f32e7eSjoerg 175906f32e7eSjoerg# The MAN_EXTENSION tag determines the extension that is added to the generated 176006f32e7eSjoerg# man pages. In case the manual section does not start with a number, the number 176106f32e7eSjoerg# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is 176206f32e7eSjoerg# optional. 176306f32e7eSjoerg# The default value is: .3. 176406f32e7eSjoerg# This tag requires that the tag GENERATE_MAN is set to YES. 176506f32e7eSjoerg 176606f32e7eSjoergMAN_EXTENSION = .3 176706f32e7eSjoerg 176806f32e7eSjoerg# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it 176906f32e7eSjoerg# will generate one additional man file for each entity documented in the real 177006f32e7eSjoerg# man page(s). These additional files only source the real man page, but without 177106f32e7eSjoerg# them the man command would be unable to find the correct page. 177206f32e7eSjoerg# The default value is: NO. 177306f32e7eSjoerg# This tag requires that the tag GENERATE_MAN is set to YES. 177406f32e7eSjoerg 177506f32e7eSjoergMAN_LINKS = NO 177606f32e7eSjoerg 177706f32e7eSjoerg#--------------------------------------------------------------------------- 177806f32e7eSjoerg# Configuration options related to the XML output 177906f32e7eSjoerg#--------------------------------------------------------------------------- 178006f32e7eSjoerg 178106f32e7eSjoerg# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that 178206f32e7eSjoerg# captures the structure of the code including all documentation. 178306f32e7eSjoerg# The default value is: NO. 178406f32e7eSjoerg 178506f32e7eSjoergGENERATE_XML = NO 178606f32e7eSjoerg 178706f32e7eSjoerg# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a 178806f32e7eSjoerg# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 178906f32e7eSjoerg# it. 179006f32e7eSjoerg# The default directory is: xml. 179106f32e7eSjoerg# This tag requires that the tag GENERATE_XML is set to YES. 179206f32e7eSjoerg 179306f32e7eSjoergXML_OUTPUT = xml 179406f32e7eSjoerg 179506f32e7eSjoerg# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program 179606f32e7eSjoerg# listings (including syntax highlighting and cross-referencing information) to 179706f32e7eSjoerg# the XML output. Note that enabling this will significantly increase the size 179806f32e7eSjoerg# of the XML output. 179906f32e7eSjoerg# The default value is: YES. 180006f32e7eSjoerg# This tag requires that the tag GENERATE_XML is set to YES. 180106f32e7eSjoerg 180206f32e7eSjoergXML_PROGRAMLISTING = YES 180306f32e7eSjoerg 180406f32e7eSjoerg#--------------------------------------------------------------------------- 180506f32e7eSjoerg# Configuration options related to the DOCBOOK output 180606f32e7eSjoerg#--------------------------------------------------------------------------- 180706f32e7eSjoerg 180806f32e7eSjoerg# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files 180906f32e7eSjoerg# that can be used to generate PDF. 181006f32e7eSjoerg# The default value is: NO. 181106f32e7eSjoerg 181206f32e7eSjoergGENERATE_DOCBOOK = NO 181306f32e7eSjoerg 181406f32e7eSjoerg# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. 181506f32e7eSjoerg# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in 181606f32e7eSjoerg# front of it. 181706f32e7eSjoerg# The default directory is: docbook. 181806f32e7eSjoerg# This tag requires that the tag GENERATE_DOCBOOK is set to YES. 181906f32e7eSjoerg 182006f32e7eSjoergDOCBOOK_OUTPUT = docbook 182106f32e7eSjoerg 182206f32e7eSjoerg#--------------------------------------------------------------------------- 182306f32e7eSjoerg# Configuration options for the AutoGen Definitions output 182406f32e7eSjoerg#--------------------------------------------------------------------------- 182506f32e7eSjoerg 182606f32e7eSjoerg# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen 182706f32e7eSjoerg# Definitions (see http://autogen.sf.net) file that captures the structure of 182806f32e7eSjoerg# the code including all documentation. Note that this feature is still 182906f32e7eSjoerg# experimental and incomplete at the moment. 183006f32e7eSjoerg# The default value is: NO. 183106f32e7eSjoerg 183206f32e7eSjoergGENERATE_AUTOGEN_DEF = NO 183306f32e7eSjoerg 183406f32e7eSjoerg#--------------------------------------------------------------------------- 183506f32e7eSjoerg# Configuration options related to the Perl module output 183606f32e7eSjoerg#--------------------------------------------------------------------------- 183706f32e7eSjoerg 183806f32e7eSjoerg# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module 183906f32e7eSjoerg# file that captures the structure of the code including all documentation. 184006f32e7eSjoerg# 184106f32e7eSjoerg# Note that this feature is still experimental and incomplete at the moment. 184206f32e7eSjoerg# The default value is: NO. 184306f32e7eSjoerg 184406f32e7eSjoergGENERATE_PERLMOD = NO 184506f32e7eSjoerg 184606f32e7eSjoerg# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary 184706f32e7eSjoerg# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI 184806f32e7eSjoerg# output from the Perl module output. 184906f32e7eSjoerg# The default value is: NO. 185006f32e7eSjoerg# This tag requires that the tag GENERATE_PERLMOD is set to YES. 185106f32e7eSjoerg 185206f32e7eSjoergPERLMOD_LATEX = NO 185306f32e7eSjoerg 185406f32e7eSjoerg# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely 185506f32e7eSjoerg# formatted so it can be parsed by a human reader. This is useful if you want to 185606f32e7eSjoerg# understand what is going on. On the other hand, if this tag is set to NO the 185706f32e7eSjoerg# size of the Perl module output will be much smaller and Perl will parse it 185806f32e7eSjoerg# just the same. 185906f32e7eSjoerg# The default value is: YES. 186006f32e7eSjoerg# This tag requires that the tag GENERATE_PERLMOD is set to YES. 186106f32e7eSjoerg 186206f32e7eSjoergPERLMOD_PRETTY = YES 186306f32e7eSjoerg 186406f32e7eSjoerg# The names of the make variables in the generated doxyrules.make file are 186506f32e7eSjoerg# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful 186606f32e7eSjoerg# so different doxyrules.make files included by the same Makefile don't 186706f32e7eSjoerg# overwrite each other's variables. 186806f32e7eSjoerg# This tag requires that the tag GENERATE_PERLMOD is set to YES. 186906f32e7eSjoerg 187006f32e7eSjoergPERLMOD_MAKEVAR_PREFIX = 187106f32e7eSjoerg 187206f32e7eSjoerg#--------------------------------------------------------------------------- 187306f32e7eSjoerg# Configuration options related to the preprocessor 187406f32e7eSjoerg#--------------------------------------------------------------------------- 187506f32e7eSjoerg 187606f32e7eSjoerg# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all 187706f32e7eSjoerg# C-preprocessor directives found in the sources and include files. 187806f32e7eSjoerg# The default value is: YES. 187906f32e7eSjoerg 188006f32e7eSjoergENABLE_PREPROCESSING = YES 188106f32e7eSjoerg 188206f32e7eSjoerg# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names 188306f32e7eSjoerg# in the source code. If set to NO only conditional compilation will be 188406f32e7eSjoerg# performed. Macro expansion can be done in a controlled way by setting 188506f32e7eSjoerg# EXPAND_ONLY_PREDEF to YES. 188606f32e7eSjoerg# The default value is: NO. 188706f32e7eSjoerg# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 188806f32e7eSjoerg 188906f32e7eSjoergMACRO_EXPANSION = YES 189006f32e7eSjoerg 189106f32e7eSjoerg# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then 189206f32e7eSjoerg# the macro expansion is limited to the macros specified with the PREDEFINED and 189306f32e7eSjoerg# EXPAND_AS_DEFINED tags. 189406f32e7eSjoerg# The default value is: NO. 189506f32e7eSjoerg# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 189606f32e7eSjoerg 189706f32e7eSjoergEXPAND_ONLY_PREDEF = YES 189806f32e7eSjoerg 189906f32e7eSjoerg# If the SEARCH_INCLUDES tag is set to YES the includes files in the 190006f32e7eSjoerg# INCLUDE_PATH will be searched if a #include is found. 190106f32e7eSjoerg# The default value is: YES. 190206f32e7eSjoerg# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 190306f32e7eSjoerg 190406f32e7eSjoergSEARCH_INCLUDES = YES 190506f32e7eSjoerg 190606f32e7eSjoerg# The INCLUDE_PATH tag can be used to specify one or more directories that 190706f32e7eSjoerg# contain include files that are not input files but should be processed by the 190806f32e7eSjoerg# preprocessor. 190906f32e7eSjoerg# This tag requires that the tag SEARCH_INCLUDES is set to YES. 191006f32e7eSjoerg 191106f32e7eSjoergINCLUDE_PATH = ../include 191206f32e7eSjoerg 191306f32e7eSjoerg# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 191406f32e7eSjoerg# patterns (like *.h and *.hpp) to filter out the header-files in the 191506f32e7eSjoerg# directories. If left blank, the patterns specified with FILE_PATTERNS will be 191606f32e7eSjoerg# used. 191706f32e7eSjoerg# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 191806f32e7eSjoerg 191906f32e7eSjoergINCLUDE_FILE_PATTERNS = 192006f32e7eSjoerg 192106f32e7eSjoerg# The PREDEFINED tag can be used to specify one or more macro names that are 192206f32e7eSjoerg# defined before the preprocessor is started (similar to the -D option of e.g. 192306f32e7eSjoerg# gcc). The argument of the tag is a list of macros of the form: name or 192406f32e7eSjoerg# name=definition (no spaces). If the definition and the "=" are omitted, "=1" 192506f32e7eSjoerg# is assumed. To prevent a macro definition from being undefined via #undef or 192606f32e7eSjoerg# recursively expanded use the := operator instead of the = operator. 192706f32e7eSjoerg# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 192806f32e7eSjoerg 192906f32e7eSjoergPREDEFINED = 193006f32e7eSjoerg 193106f32e7eSjoerg# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this 193206f32e7eSjoerg# tag can be used to specify a list of macro names that should be expanded. The 193306f32e7eSjoerg# macro definition that is found in the sources will be used. Use the PREDEFINED 193406f32e7eSjoerg# tag if you want to use a different macro definition that overrules the 193506f32e7eSjoerg# definition found in the source code. 193606f32e7eSjoerg# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 193706f32e7eSjoerg 193806f32e7eSjoergEXPAND_AS_DEFINED = 193906f32e7eSjoerg 194006f32e7eSjoerg# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will 194106f32e7eSjoerg# remove all references to function-like macros that are alone on a line, have an 194206f32e7eSjoerg# all uppercase name, and do not end with a semicolon. Such function macros are 194306f32e7eSjoerg# typically used for boiler-plate code, and will confuse the parser if not 194406f32e7eSjoerg# removed. 194506f32e7eSjoerg# The default value is: YES. 194606f32e7eSjoerg# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 194706f32e7eSjoerg 194806f32e7eSjoergSKIP_FUNCTION_MACROS = YES 194906f32e7eSjoerg 195006f32e7eSjoerg#--------------------------------------------------------------------------- 195106f32e7eSjoerg# Configuration options related to external references 195206f32e7eSjoerg#--------------------------------------------------------------------------- 195306f32e7eSjoerg 195406f32e7eSjoerg# The TAGFILES tag can be used to specify one or more tag files. For each tag 195506f32e7eSjoerg# file the location of the external documentation should be added. The format of 195606f32e7eSjoerg# a tag file without this location is as follows: 195706f32e7eSjoerg# TAGFILES = file1 file2 ... 195806f32e7eSjoerg# Adding location for the tag files is done as follows: 195906f32e7eSjoerg# TAGFILES = file1=loc1 "file2 = loc2" ... 196006f32e7eSjoerg# where loc1 and loc2 can be relative or absolute paths or URLs. See the 196106f32e7eSjoerg# section "Linking to external documentation" for more information about the use 196206f32e7eSjoerg# of tag files. 196306f32e7eSjoerg# Note: Each tag file must have an unique name (where the name does NOT include 196406f32e7eSjoerg# the path). If a tag file is not located in the directory in which doxygen is 196506f32e7eSjoerg# run, you must also specify the path to the tagfile here. 196606f32e7eSjoerg 196706f32e7eSjoergTAGFILES = 196806f32e7eSjoerg 196906f32e7eSjoerg# When a file name is specified after GENERATE_TAGFILE, doxygen will create a 197006f32e7eSjoerg# tag file that is based on the input files it reads. See section "Linking to 197106f32e7eSjoerg# external documentation" for more information about the usage of tag files. 197206f32e7eSjoerg 197306f32e7eSjoergGENERATE_TAGFILE = 197406f32e7eSjoerg 197506f32e7eSjoerg# If the ALLEXTERNALS tag is set to YES all external class will be listed in the 197606f32e7eSjoerg# class index. If set to NO only the inherited external classes will be listed. 197706f32e7eSjoerg# The default value is: NO. 197806f32e7eSjoerg 197906f32e7eSjoergALLEXTERNALS = YES 198006f32e7eSjoerg 198106f32e7eSjoerg# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in 198206f32e7eSjoerg# the modules index. If set to NO, only the current project's groups will be 198306f32e7eSjoerg# listed. 198406f32e7eSjoerg# The default value is: YES. 198506f32e7eSjoerg 198606f32e7eSjoergEXTERNAL_GROUPS = YES 198706f32e7eSjoerg 198806f32e7eSjoerg# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in 198906f32e7eSjoerg# the related pages index. If set to NO, only the current project's pages will 199006f32e7eSjoerg# be listed. 199106f32e7eSjoerg# The default value is: YES. 199206f32e7eSjoerg 199306f32e7eSjoergEXTERNAL_PAGES = YES 199406f32e7eSjoerg 199506f32e7eSjoerg# The PERL_PATH should be the absolute path and name of the perl script 199606f32e7eSjoerg# interpreter (i.e. the result of 'which perl'). 199706f32e7eSjoerg# The default file (with absolute path) is: /usr/bin/perl. 199806f32e7eSjoerg 199906f32e7eSjoergPERL_PATH = /usr/bin/perl 200006f32e7eSjoerg 200106f32e7eSjoerg#--------------------------------------------------------------------------- 200206f32e7eSjoerg# Configuration options related to the dot tool 200306f32e7eSjoerg#--------------------------------------------------------------------------- 200406f32e7eSjoerg 200506f32e7eSjoerg# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram 200606f32e7eSjoerg# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to 200706f32e7eSjoerg# NO turns the diagrams off. Note that this option also works with HAVE_DOT 200806f32e7eSjoerg# disabled, but it is recommended to install and use dot, since it yields more 200906f32e7eSjoerg# powerful graphs. 201006f32e7eSjoerg# The default value is: YES. 201106f32e7eSjoerg 201206f32e7eSjoergCLASS_DIAGRAMS = YES 201306f32e7eSjoerg 201406f32e7eSjoerg# You can define message sequence charts within doxygen comments using the \msc 201506f32e7eSjoerg# command. Doxygen will then run the mscgen tool (see: 201606f32e7eSjoerg# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the 201706f32e7eSjoerg# documentation. The MSCGEN_PATH tag allows you to specify the directory where 201806f32e7eSjoerg# the mscgen tool resides. If left empty the tool is assumed to be found in the 201906f32e7eSjoerg# default search path. 202006f32e7eSjoerg 202106f32e7eSjoergMSCGEN_PATH = 202206f32e7eSjoerg 202306f32e7eSjoerg# You can include diagrams made with dia in doxygen documentation. Doxygen will 202406f32e7eSjoerg# then run dia to produce the diagram and insert it in the documentation. The 202506f32e7eSjoerg# DIA_PATH tag allows you to specify the directory where the dia binary resides. 202606f32e7eSjoerg# If left empty dia is assumed to be found in the default search path. 202706f32e7eSjoerg 202806f32e7eSjoergDIA_PATH = 202906f32e7eSjoerg 203006f32e7eSjoerg# If set to YES, the inheritance and collaboration graphs will hide inheritance 203106f32e7eSjoerg# and usage relations if the target is undocumented or is not a class. 203206f32e7eSjoerg# The default value is: YES. 203306f32e7eSjoerg 203406f32e7eSjoergHIDE_UNDOC_RELATIONS = NO 203506f32e7eSjoerg 203606f32e7eSjoerg# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 203706f32e7eSjoerg# available from the path. This tool is part of Graphviz (see: 203806f32e7eSjoerg# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent 203906f32e7eSjoerg# Bell Labs. The other options in this section have no effect if this option is 204006f32e7eSjoerg# set to NO 204106f32e7eSjoerg# The default value is: NO. 204206f32e7eSjoerg 204306f32e7eSjoergHAVE_DOT = YES 204406f32e7eSjoerg 204506f32e7eSjoerg# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed 204606f32e7eSjoerg# to run in parallel. When set to 0 doxygen will base this on the number of 204706f32e7eSjoerg# processors available in the system. You can set it explicitly to a value 204806f32e7eSjoerg# larger than 0 to get control over the balance between CPU load and processing 204906f32e7eSjoerg# speed. 205006f32e7eSjoerg# Minimum value: 0, maximum value: 32, default value: 0. 205106f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 205206f32e7eSjoerg 205306f32e7eSjoergDOT_NUM_THREADS = 0 205406f32e7eSjoerg 205506f32e7eSjoerg# When you want a differently looking font n the dot files that doxygen 205606f32e7eSjoerg# generates you can specify the font name using DOT_FONTNAME. You need to make 205706f32e7eSjoerg# sure dot is able to find the font, which can be done by putting it in a 205806f32e7eSjoerg# standard location or by setting the DOTFONTPATH environment variable or by 205906f32e7eSjoerg# setting DOT_FONTPATH to the directory containing the font. 206006f32e7eSjoerg# The default value is: Helvetica. 206106f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 206206f32e7eSjoerg 206306f32e7eSjoergDOT_FONTNAME = Helvetica 206406f32e7eSjoerg 206506f32e7eSjoerg# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of 206606f32e7eSjoerg# dot graphs. 206706f32e7eSjoerg# Minimum value: 4, maximum value: 24, default value: 10. 206806f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 206906f32e7eSjoerg 207006f32e7eSjoergDOT_FONTSIZE = 10 207106f32e7eSjoerg 207206f32e7eSjoerg# By default doxygen will tell dot to use the default font as specified with 207306f32e7eSjoerg# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set 207406f32e7eSjoerg# the path where dot can find it using this tag. 207506f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 207606f32e7eSjoerg 207706f32e7eSjoergDOT_FONTPATH = 207806f32e7eSjoerg 207906f32e7eSjoerg# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for 208006f32e7eSjoerg# each documented class showing the direct and indirect inheritance relations. 208106f32e7eSjoerg# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. 208206f32e7eSjoerg# The default value is: YES. 208306f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 208406f32e7eSjoerg 208506f32e7eSjoergCLASS_GRAPH = YES 208606f32e7eSjoerg 208706f32e7eSjoerg# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a 208806f32e7eSjoerg# graph for each documented class showing the direct and indirect implementation 208906f32e7eSjoerg# dependencies (inheritance, containment, and class references variables) of the 209006f32e7eSjoerg# class with other documented classes. 209106f32e7eSjoerg# The default value is: YES. 209206f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 209306f32e7eSjoerg 209406f32e7eSjoergCOLLABORATION_GRAPH = YES 209506f32e7eSjoerg 209606f32e7eSjoerg# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for 209706f32e7eSjoerg# groups, showing the direct groups dependencies. 209806f32e7eSjoerg# The default value is: YES. 209906f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 210006f32e7eSjoerg 210106f32e7eSjoergGROUP_GRAPHS = YES 210206f32e7eSjoerg 210306f32e7eSjoerg# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 210406f32e7eSjoerg# collaboration diagrams in a style similar to the OMG's Unified Modeling 210506f32e7eSjoerg# Language. 210606f32e7eSjoerg# The default value is: NO. 210706f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 210806f32e7eSjoerg 210906f32e7eSjoergUML_LOOK = NO 211006f32e7eSjoerg 211106f32e7eSjoerg# If the UML_LOOK tag is enabled, the fields and methods are shown inside the 211206f32e7eSjoerg# class node. If there are many fields or methods and many nodes the graph may 211306f32e7eSjoerg# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the 211406f32e7eSjoerg# number of items for each type to make the size more manageable. Set this to 0 211506f32e7eSjoerg# for no limit. Note that the threshold may be exceeded by 50% before the limit 211606f32e7eSjoerg# is enforced. So when you set the threshold to 10, up to 15 fields may appear, 211706f32e7eSjoerg# but if the number exceeds 15, the total amount of fields shown is limited to 211806f32e7eSjoerg# 10. 211906f32e7eSjoerg# Minimum value: 0, maximum value: 100, default value: 10. 212006f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 212106f32e7eSjoerg 212206f32e7eSjoergUML_LIMIT_NUM_FIELDS = 10 212306f32e7eSjoerg 212406f32e7eSjoerg# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and 212506f32e7eSjoerg# collaboration graphs will show the relations between templates and their 212606f32e7eSjoerg# instances. 212706f32e7eSjoerg# The default value is: NO. 212806f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 212906f32e7eSjoerg 213006f32e7eSjoergTEMPLATE_RELATIONS = YES 213106f32e7eSjoerg 213206f32e7eSjoerg# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to 213306f32e7eSjoerg# YES then doxygen will generate a graph for each documented file showing the 213406f32e7eSjoerg# direct and indirect include dependencies of the file with other documented 213506f32e7eSjoerg# files. 213606f32e7eSjoerg# The default value is: YES. 213706f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 213806f32e7eSjoerg 213906f32e7eSjoergINCLUDE_GRAPH = YES 214006f32e7eSjoerg 214106f32e7eSjoerg# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are 214206f32e7eSjoerg# set to YES then doxygen will generate a graph for each documented file showing 214306f32e7eSjoerg# the direct and indirect include dependencies of the file with other documented 214406f32e7eSjoerg# files. 214506f32e7eSjoerg# The default value is: YES. 214606f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 214706f32e7eSjoerg 214806f32e7eSjoergINCLUDED_BY_GRAPH = YES 214906f32e7eSjoerg 215006f32e7eSjoerg# If the CALL_GRAPH tag is set to YES then doxygen will generate a call 215106f32e7eSjoerg# dependency graph for every global function or class method. 215206f32e7eSjoerg# 215306f32e7eSjoerg# Note that enabling this option will significantly increase the time of a run. 215406f32e7eSjoerg# So in most cases it will be better to enable call graphs for selected 215506f32e7eSjoerg# functions only using the \callgraph command. 215606f32e7eSjoerg# The default value is: NO. 215706f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 215806f32e7eSjoerg 215906f32e7eSjoergCALL_GRAPH = NO 216006f32e7eSjoerg 216106f32e7eSjoerg# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller 216206f32e7eSjoerg# dependency graph for every global function or class method. 216306f32e7eSjoerg# 216406f32e7eSjoerg# Note that enabling this option will significantly increase the time of a run. 216506f32e7eSjoerg# So in most cases it will be better to enable caller graphs for selected 216606f32e7eSjoerg# functions only using the \callergraph command. 216706f32e7eSjoerg# The default value is: NO. 216806f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 216906f32e7eSjoerg 217006f32e7eSjoergCALLER_GRAPH = NO 217106f32e7eSjoerg 217206f32e7eSjoerg# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical 217306f32e7eSjoerg# hierarchy of all classes instead of a textual one. 217406f32e7eSjoerg# The default value is: YES. 217506f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 217606f32e7eSjoerg 217706f32e7eSjoergGRAPHICAL_HIERARCHY = YES 217806f32e7eSjoerg 217906f32e7eSjoerg# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the 218006f32e7eSjoerg# dependencies a directory has on other directories in a graphical way. The 218106f32e7eSjoerg# dependency relations are determined by the #include relations between the 218206f32e7eSjoerg# files in the directories. 218306f32e7eSjoerg# The default value is: YES. 218406f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 218506f32e7eSjoerg 218606f32e7eSjoergDIRECTORY_GRAPH = YES 218706f32e7eSjoerg 218806f32e7eSjoerg# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 218906f32e7eSjoerg# generated by dot. 219006f32e7eSjoerg# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order 219106f32e7eSjoerg# to make the SVG files visible in IE 9+ (other browsers do not have this 219206f32e7eSjoerg# requirement). 219306f32e7eSjoerg# Possible values are: png, jpg, gif and svg. 219406f32e7eSjoerg# The default value is: png. 219506f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 219606f32e7eSjoerg 219706f32e7eSjoergDOT_IMAGE_FORMAT = @DOT_IMAGE_FORMAT@ 219806f32e7eSjoerg 219906f32e7eSjoerg# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 220006f32e7eSjoerg# enable generation of interactive SVG images that allow zooming and panning. 220106f32e7eSjoerg# 220206f32e7eSjoerg# Note that this requires a modern browser other than Internet Explorer. Tested 220306f32e7eSjoerg# and working are Firefox, Chrome, Safari, and Opera. 220406f32e7eSjoerg# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make 220506f32e7eSjoerg# the SVG files visible. Older versions of IE do not have SVG support. 220606f32e7eSjoerg# The default value is: NO. 220706f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 220806f32e7eSjoerg 220906f32e7eSjoergINTERACTIVE_SVG = NO 221006f32e7eSjoerg 221106f32e7eSjoerg# The DOT_PATH tag can be used to specify the path where the dot tool can be 221206f32e7eSjoerg# found. If left blank, it is assumed the dot tool can be found in the path. 221306f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 221406f32e7eSjoerg 221506f32e7eSjoergDOT_PATH = @DOT@ 221606f32e7eSjoerg 221706f32e7eSjoerg# The DOTFILE_DIRS tag can be used to specify one or more directories that 221806f32e7eSjoerg# contain dot files that are included in the documentation (see the \dotfile 221906f32e7eSjoerg# command). 222006f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 222106f32e7eSjoerg 222206f32e7eSjoergDOTFILE_DIRS = 222306f32e7eSjoerg 222406f32e7eSjoerg# The MSCFILE_DIRS tag can be used to specify one or more directories that 222506f32e7eSjoerg# contain msc files that are included in the documentation (see the \mscfile 222606f32e7eSjoerg# command). 222706f32e7eSjoerg 222806f32e7eSjoergMSCFILE_DIRS = 222906f32e7eSjoerg 223006f32e7eSjoerg# The DIAFILE_DIRS tag can be used to specify one or more directories that 223106f32e7eSjoerg# contain dia files that are included in the documentation (see the \diafile 223206f32e7eSjoerg# command). 223306f32e7eSjoerg 223406f32e7eSjoergDIAFILE_DIRS = 223506f32e7eSjoerg 223606f32e7eSjoerg# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes 223706f32e7eSjoerg# that will be shown in the graph. If the number of nodes in a graph becomes 223806f32e7eSjoerg# larger than this value, doxygen will truncate the graph, which is visualized 223906f32e7eSjoerg# by representing a node as a red box. Note that doxygen if the number of direct 224006f32e7eSjoerg# children of the root node in a graph is already larger than 224106f32e7eSjoerg# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that 224206f32e7eSjoerg# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 224306f32e7eSjoerg# Minimum value: 0, maximum value: 10000, default value: 50. 224406f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 224506f32e7eSjoerg 224606f32e7eSjoergDOT_GRAPH_MAX_NODES = 50 224706f32e7eSjoerg 224806f32e7eSjoerg# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs 224906f32e7eSjoerg# generated by dot. A depth value of 3 means that only nodes reachable from the 225006f32e7eSjoerg# root by following a path via at most 3 edges will be shown. Nodes that lay 225106f32e7eSjoerg# further from the root node will be omitted. Note that setting this option to 1 225206f32e7eSjoerg# or 2 may greatly reduce the computation time needed for large code bases. Also 225306f32e7eSjoerg# note that the size of a graph can be further restricted by 225406f32e7eSjoerg# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 225506f32e7eSjoerg# Minimum value: 0, maximum value: 1000, default value: 0. 225606f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 225706f32e7eSjoerg 225806f32e7eSjoergMAX_DOT_GRAPH_DEPTH = 0 225906f32e7eSjoerg 226006f32e7eSjoerg# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 226106f32e7eSjoerg# background. This is disabled by default, because dot on Windows does not seem 226206f32e7eSjoerg# to support this out of the box. 226306f32e7eSjoerg# 226406f32e7eSjoerg# Warning: Depending on the platform used, enabling this option may lead to 226506f32e7eSjoerg# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 226606f32e7eSjoerg# read). 226706f32e7eSjoerg# The default value is: NO. 226806f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 226906f32e7eSjoerg 227006f32e7eSjoergDOT_TRANSPARENT = YES 227106f32e7eSjoerg 227206f32e7eSjoerg# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 227306f32e7eSjoerg# files in one run (i.e. multiple -o and -T options on the command line). This 227406f32e7eSjoerg# makes dot run faster, but since only newer versions of dot (>1.8.10) support 227506f32e7eSjoerg# this, this feature is disabled by default. 227606f32e7eSjoerg# The default value is: NO. 227706f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 227806f32e7eSjoerg 227906f32e7eSjoergDOT_MULTI_TARGETS = YES 228006f32e7eSjoerg 228106f32e7eSjoerg# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page 228206f32e7eSjoerg# explaining the meaning of the various boxes and arrows in the dot generated 228306f32e7eSjoerg# graphs. 228406f32e7eSjoerg# The default value is: YES. 228506f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 228606f32e7eSjoerg 228706f32e7eSjoergGENERATE_LEGEND = YES 228806f32e7eSjoerg 228906f32e7eSjoerg# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot 229006f32e7eSjoerg# files that are used to generate the various graphs. 229106f32e7eSjoerg# The default value is: YES. 229206f32e7eSjoerg# This tag requires that the tag HAVE_DOT is set to YES. 229306f32e7eSjoerg 229406f32e7eSjoergDOT_CLEANUP = YES 2295