1*c917796cSXin LI# Doxyfile 1.9.6 2*c917796cSXin LI 3*c917796cSXin LI# This file describes the settings to be used by the documentation system 4*c917796cSXin LI# doxygen (www.doxygen.org) for a project. 5*c917796cSXin LI# 6*c917796cSXin LI# All text after a double hash (##) is considered a comment and is placed in 7*c917796cSXin LI# front of the TAG it is preceding. 8*c917796cSXin LI# 9*c917796cSXin LI# All text after a single hash (#) is considered a comment and will be ignored. 10*c917796cSXin LI# The format is: 11*c917796cSXin LI# TAG = value [value, ...] 12*c917796cSXin LI# For lists, items can also be appended using: 13*c917796cSXin LI# TAG += value [value, ...] 14*c917796cSXin LI# Values that contain spaces should be placed between quotes (\" \"). 15*c917796cSXin LI# 16*c917796cSXin LI# Note: 17*c917796cSXin LI# 18*c917796cSXin LI# Use doxygen to compare the used configuration file with the template 19*c917796cSXin LI# configuration file: 20*c917796cSXin LI# doxygen -x [configFile] 21*c917796cSXin LI# Use doxygen to compare the used configuration file with the template 22*c917796cSXin LI# configuration file without replacing the environment variables or CMake type 23*c917796cSXin LI# replacement variables: 24*c917796cSXin LI# doxygen -x_noenv [configFile] 25*c917796cSXin LI 26*c917796cSXin LI#--------------------------------------------------------------------------- 27*c917796cSXin LI# Project related configuration options 28*c917796cSXin LI#--------------------------------------------------------------------------- 29*c917796cSXin LI 30*c917796cSXin LI# This tag specifies the encoding used for all characters in the configuration 31*c917796cSXin LI# file that follow. The default is UTF-8 which is also the encoding used for all 32*c917796cSXin LI# text before the first occurrence of this tag. Doxygen uses libiconv (or the 33*c917796cSXin LI# iconv built into libc) for the transcoding. See 34*c917796cSXin LI# https://www.gnu.org/software/libiconv/ for the list of possible encodings. 35*c917796cSXin LI# The default value is: UTF-8. 36*c917796cSXin LI 37*c917796cSXin LIDOXYFILE_ENCODING = UTF-8 38*c917796cSXin LI 39*c917796cSXin LI# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 40*c917796cSXin LI# double-quotes, unless you are using Doxywizard) that should identify the 41*c917796cSXin LI# project for which the documentation is generated. This name is used in the 42*c917796cSXin LI# title of most generated pages and in a few other places. 43*c917796cSXin LI# The default value is: My Project. 44*c917796cSXin LI 45*c917796cSXin LIPROJECT_NAME = "liblzma (XZ Utils)" 46*c917796cSXin LI 47*c917796cSXin LI# The PROJECT_NUMBER tag can be used to enter a project or revision number. This 48*c917796cSXin LI# could be handy for archiving the generated documentation or if some version 49*c917796cSXin LI# control system is used. 50*c917796cSXin LI 51*c917796cSXin LIPROJECT_NUMBER = 52*c917796cSXin LI 53*c917796cSXin LI# Using the PROJECT_BRIEF tag one can provide an optional one line description 54*c917796cSXin LI# for a project that appears at the top of each page and should give viewer a 55*c917796cSXin LI# quick idea about the purpose of the project. Keep the description short. 56*c917796cSXin LI 57*c917796cSXin LIPROJECT_BRIEF = 58*c917796cSXin LI 59*c917796cSXin LI# With the PROJECT_LOGO tag one can specify a logo or an icon that is included 60*c917796cSXin LI# in the documentation. The maximum height of the logo should not exceed 55 61*c917796cSXin LI# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 62*c917796cSXin LI# the logo to the output directory. 63*c917796cSXin LI 64*c917796cSXin LIPROJECT_LOGO = 65*c917796cSXin LI 66*c917796cSXin LI# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 67*c917796cSXin LI# into which the generated documentation will be written. If a relative path is 68*c917796cSXin LI# entered, it will be relative to the location where doxygen was started. If 69*c917796cSXin LI# left blank the current directory will be used. 70*c917796cSXin LI 71*c917796cSXin LIOUTPUT_DIRECTORY = ../doc 72*c917796cSXin LI 73*c917796cSXin LI# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 74*c917796cSXin LI# sub-directories (in 2 levels) under the output directory of each output format 75*c917796cSXin LI# and will distribute the generated files over these directories. Enabling this 76*c917796cSXin LI# option can be useful when feeding doxygen a huge amount of source files, where 77*c917796cSXin LI# putting all generated files in the same directory would otherwise causes 78*c917796cSXin LI# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to 79*c917796cSXin LI# control the number of sub-directories. 80*c917796cSXin LI# The default value is: NO. 81*c917796cSXin LI 82*c917796cSXin LICREATE_SUBDIRS = NO 83*c917796cSXin LI 84*c917796cSXin LI# Controls the number of sub-directories that will be created when 85*c917796cSXin LI# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every 86*c917796cSXin LI# level increment doubles the number of directories, resulting in 4096 87*c917796cSXin LI# directories at level 8 which is the default and also the maximum value. The 88*c917796cSXin LI# sub-directories are organized in 2 levels, the first level always has a fixed 89*c917796cSXin LI# number of 16 directories. 90*c917796cSXin LI# Minimum value: 0, maximum value: 8, default value: 8. 91*c917796cSXin LI# This tag requires that the tag CREATE_SUBDIRS is set to YES. 92*c917796cSXin LI 93*c917796cSXin LICREATE_SUBDIRS_LEVEL = 8 94*c917796cSXin LI 95*c917796cSXin LI# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 96*c917796cSXin LI# characters to appear in the names of generated files. If set to NO, non-ASCII 97*c917796cSXin LI# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 98*c917796cSXin LI# U+3044. 99*c917796cSXin LI# The default value is: NO. 100*c917796cSXin LI 101*c917796cSXin LIALLOW_UNICODE_NAMES = NO 102*c917796cSXin LI 103*c917796cSXin LI# The OUTPUT_LANGUAGE tag is used to specify the language in which all 104*c917796cSXin LI# documentation generated by doxygen is written. Doxygen will use this 105*c917796cSXin LI# information to generate all constant output in the proper language. 106*c917796cSXin LI# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, 107*c917796cSXin LI# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English 108*c917796cSXin LI# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, 109*c917796cSXin LI# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with 110*c917796cSXin LI# English messages), Korean, Korean-en (Korean with English messages), Latvian, 111*c917796cSXin LI# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, 112*c917796cSXin LI# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, 113*c917796cSXin LI# Swedish, Turkish, Ukrainian and Vietnamese. 114*c917796cSXin LI# The default value is: English. 115*c917796cSXin LI 116*c917796cSXin LIOUTPUT_LANGUAGE = English 117*c917796cSXin LI 118*c917796cSXin LI# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 119*c917796cSXin LI# descriptions after the members that are listed in the file and class 120*c917796cSXin LI# documentation (similar to Javadoc). Set to NO to disable this. 121*c917796cSXin LI# The default value is: YES. 122*c917796cSXin LI 123*c917796cSXin LIBRIEF_MEMBER_DESC = YES 124*c917796cSXin LI 125*c917796cSXin LI# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 126*c917796cSXin LI# description of a member or function before the detailed description 127*c917796cSXin LI# 128*c917796cSXin LI# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 129*c917796cSXin LI# brief descriptions will be completely suppressed. 130*c917796cSXin LI# The default value is: YES. 131*c917796cSXin LI 132*c917796cSXin LIREPEAT_BRIEF = YES 133*c917796cSXin LI 134*c917796cSXin LI# This tag implements a quasi-intelligent brief description abbreviator that is 135*c917796cSXin LI# used to form the text in various listings. Each string in this list, if found 136*c917796cSXin LI# as the leading text of the brief description, will be stripped from the text 137*c917796cSXin LI# and the result, after processing the whole list, is used as the annotated 138*c917796cSXin LI# text. Otherwise, the brief description is used as-is. If left blank, the 139*c917796cSXin LI# following values are used ($name is automatically replaced with the name of 140*c917796cSXin LI# the entity):The $name class, The $name widget, The $name file, is, provides, 141*c917796cSXin LI# specifies, contains, represents, a, an and the. 142*c917796cSXin LI 143*c917796cSXin LIABBREVIATE_BRIEF = 144*c917796cSXin LI 145*c917796cSXin LI# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 146*c917796cSXin LI# doxygen will generate a detailed section even if there is only a brief 147*c917796cSXin LI# description. 148*c917796cSXin LI# The default value is: NO. 149*c917796cSXin LI 150*c917796cSXin LIALWAYS_DETAILED_SEC = NO 151*c917796cSXin LI 152*c917796cSXin LI# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 153*c917796cSXin LI# inherited members of a class in the documentation of that class as if those 154*c917796cSXin LI# members were ordinary class members. Constructors, destructors and assignment 155*c917796cSXin LI# operators of the base classes will not be shown. 156*c917796cSXin LI# The default value is: NO. 157*c917796cSXin LI 158*c917796cSXin LIINLINE_INHERITED_MEMB = NO 159*c917796cSXin LI 160*c917796cSXin LI# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 161*c917796cSXin LI# before files name in the file list and in the header files. If set to NO the 162*c917796cSXin LI# shortest path that makes the file name unique will be used 163*c917796cSXin LI# The default value is: YES. 164*c917796cSXin LI 165*c917796cSXin LIFULL_PATH_NAMES = YES 166*c917796cSXin LI 167*c917796cSXin LI# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 168*c917796cSXin LI# Stripping is only done if one of the specified strings matches the left-hand 169*c917796cSXin LI# part of the path. The tag can be used to show relative paths in the file list. 170*c917796cSXin LI# If left blank the directory from which doxygen is run is used as the path to 171*c917796cSXin LI# strip. 172*c917796cSXin LI# 173*c917796cSXin LI# Note that you can specify absolute paths here, but also relative paths, which 174*c917796cSXin LI# will be relative from the directory where doxygen is started. 175*c917796cSXin LI# This tag requires that the tag FULL_PATH_NAMES is set to YES. 176*c917796cSXin LI 177*c917796cSXin LISTRIP_FROM_PATH = ../src/liblzma/api 178*c917796cSXin LI 179*c917796cSXin LI# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 180*c917796cSXin LI# path mentioned in the documentation of a class, which tells the reader which 181*c917796cSXin LI# header file to include in order to use a class. If left blank only the name of 182*c917796cSXin LI# the header file containing the class definition is used. Otherwise one should 183*c917796cSXin LI# specify the list of include paths that are normally passed to the compiler 184*c917796cSXin LI# using the -I flag. 185*c917796cSXin LI 186*c917796cSXin LISTRIP_FROM_INC_PATH = 187*c917796cSXin LI 188*c917796cSXin LI# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 189*c917796cSXin LI# less readable) file names. This can be useful is your file systems doesn't 190*c917796cSXin LI# support long names like on DOS, Mac, or CD-ROM. 191*c917796cSXin LI# The default value is: NO. 192*c917796cSXin LI 193*c917796cSXin LISHORT_NAMES = NO 194*c917796cSXin LI 195*c917796cSXin LI# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 196*c917796cSXin LI# first line (until the first dot) of a Javadoc-style comment as the brief 197*c917796cSXin LI# description. If set to NO, the Javadoc-style will behave just like regular Qt- 198*c917796cSXin LI# style comments (thus requiring an explicit @brief command for a brief 199*c917796cSXin LI# description.) 200*c917796cSXin LI# The default value is: NO. 201*c917796cSXin LI 202*c917796cSXin LIJAVADOC_AUTOBRIEF = NO 203*c917796cSXin LI 204*c917796cSXin LI# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line 205*c917796cSXin LI# such as 206*c917796cSXin LI# /*************** 207*c917796cSXin LI# as being the beginning of a Javadoc-style comment "banner". If set to NO, the 208*c917796cSXin LI# Javadoc-style will behave just like regular comments and it will not be 209*c917796cSXin LI# interpreted by doxygen. 210*c917796cSXin LI# The default value is: NO. 211*c917796cSXin LI 212*c917796cSXin LIJAVADOC_BANNER = NO 213*c917796cSXin LI 214*c917796cSXin LI# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 215*c917796cSXin LI# line (until the first dot) of a Qt-style comment as the brief description. If 216*c917796cSXin LI# set to NO, the Qt-style will behave just like regular Qt-style comments (thus 217*c917796cSXin LI# requiring an explicit \brief command for a brief description.) 218*c917796cSXin LI# The default value is: NO. 219*c917796cSXin LI 220*c917796cSXin LIQT_AUTOBRIEF = NO 221*c917796cSXin LI 222*c917796cSXin LI# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 223*c917796cSXin LI# multi-line C++ special comment block (i.e. a block of //! or /// comments) as 224*c917796cSXin LI# a brief description. This used to be the default behavior. The new default is 225*c917796cSXin LI# to treat a multi-line C++ comment block as a detailed description. Set this 226*c917796cSXin LI# tag to YES if you prefer the old behavior instead. 227*c917796cSXin LI# 228*c917796cSXin LI# Note that setting this tag to YES also means that rational rose comments are 229*c917796cSXin LI# not recognized any more. 230*c917796cSXin LI# The default value is: NO. 231*c917796cSXin LI 232*c917796cSXin LIMULTILINE_CPP_IS_BRIEF = NO 233*c917796cSXin LI 234*c917796cSXin LI# By default Python docstrings are displayed as preformatted text and doxygen's 235*c917796cSXin LI# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the 236*c917796cSXin LI# doxygen's special commands can be used and the contents of the docstring 237*c917796cSXin LI# documentation blocks is shown as doxygen documentation. 238*c917796cSXin LI# The default value is: YES. 239*c917796cSXin LI 240*c917796cSXin LIPYTHON_DOCSTRING = YES 241*c917796cSXin LI 242*c917796cSXin LI# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 243*c917796cSXin LI# documentation from any documented member that it re-implements. 244*c917796cSXin LI# The default value is: YES. 245*c917796cSXin LI 246*c917796cSXin LIINHERIT_DOCS = YES 247*c917796cSXin LI 248*c917796cSXin LI# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 249*c917796cSXin LI# page for each member. If set to NO, the documentation of a member will be part 250*c917796cSXin LI# of the file/class/namespace that contains it. 251*c917796cSXin LI# The default value is: NO. 252*c917796cSXin LI 253*c917796cSXin LISEPARATE_MEMBER_PAGES = NO 254*c917796cSXin LI 255*c917796cSXin LI# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 256*c917796cSXin LI# uses this value to replace tabs by spaces in code fragments. 257*c917796cSXin LI# Minimum value: 1, maximum value: 16, default value: 4. 258*c917796cSXin LI 259*c917796cSXin LITAB_SIZE = 8 260*c917796cSXin LI 261*c917796cSXin LI# This tag can be used to specify a number of aliases that act as commands in 262*c917796cSXin LI# the documentation. An alias has the form: 263*c917796cSXin LI# name=value 264*c917796cSXin LI# For example adding 265*c917796cSXin LI# "sideeffect=@par Side Effects:^^" 266*c917796cSXin LI# will allow you to put the command \sideeffect (or @sideeffect) in the 267*c917796cSXin LI# documentation, which will result in a user-defined paragraph with heading 268*c917796cSXin LI# "Side Effects:". Note that you cannot put \n's in the value part of an alias 269*c917796cSXin LI# to insert newlines (in the resulting output). You can put ^^ in the value part 270*c917796cSXin LI# of an alias to insert a newline as if a physical newline was in the original 271*c917796cSXin LI# file. When you need a literal { or } or , in the value part of an alias you 272*c917796cSXin LI# have to escape them by means of a backslash (\), this can lead to conflicts 273*c917796cSXin LI# with the commands \{ and \} for these it is advised to use the version @{ and 274*c917796cSXin LI# @} or use a double escape (\\{ and \\}) 275*c917796cSXin LI 276*c917796cSXin LIALIASES = 277*c917796cSXin LI 278*c917796cSXin LI# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 279*c917796cSXin LI# only. Doxygen will then generate output that is more tailored for C. For 280*c917796cSXin LI# instance, some of the names that are used will be different. The list of all 281*c917796cSXin LI# members will be omitted, etc. 282*c917796cSXin LI# The default value is: NO. 283*c917796cSXin LI 284*c917796cSXin LIOPTIMIZE_OUTPUT_FOR_C = YES 285*c917796cSXin LI 286*c917796cSXin LI# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 287*c917796cSXin LI# Python sources only. Doxygen will then generate output that is more tailored 288*c917796cSXin LI# for that language. For instance, namespaces will be presented as packages, 289*c917796cSXin LI# qualified scopes will look different, etc. 290*c917796cSXin LI# The default value is: NO. 291*c917796cSXin LI 292*c917796cSXin LIOPTIMIZE_OUTPUT_JAVA = NO 293*c917796cSXin LI 294*c917796cSXin LI# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 295*c917796cSXin LI# sources. Doxygen will then generate output that is tailored for Fortran. 296*c917796cSXin LI# The default value is: NO. 297*c917796cSXin LI 298*c917796cSXin LIOPTIMIZE_FOR_FORTRAN = NO 299*c917796cSXin LI 300*c917796cSXin LI# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 301*c917796cSXin LI# sources. Doxygen will then generate output that is tailored for VHDL. 302*c917796cSXin LI# The default value is: NO. 303*c917796cSXin LI 304*c917796cSXin LIOPTIMIZE_OUTPUT_VHDL = NO 305*c917796cSXin LI 306*c917796cSXin LI# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice 307*c917796cSXin LI# sources only. Doxygen will then generate output that is more tailored for that 308*c917796cSXin LI# language. For instance, namespaces will be presented as modules, types will be 309*c917796cSXin LI# separated into more groups, etc. 310*c917796cSXin LI# The default value is: NO. 311*c917796cSXin LI 312*c917796cSXin LIOPTIMIZE_OUTPUT_SLICE = NO 313*c917796cSXin LI 314*c917796cSXin LI# Doxygen selects the parser to use depending on the extension of the files it 315*c917796cSXin LI# parses. With this tag you can assign which parser to use for a given 316*c917796cSXin LI# extension. Doxygen has a built-in mapping, but you can override or extend it 317*c917796cSXin LI# using this tag. The format is ext=language, where ext is a file extension, and 318*c917796cSXin LI# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, 319*c917796cSXin LI# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, 320*c917796cSXin LI# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: 321*c917796cSXin LI# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser 322*c917796cSXin LI# tries to guess whether the code is fixed or free formatted code, this is the 323*c917796cSXin LI# default for Fortran type files). For instance to make doxygen treat .inc files 324*c917796cSXin LI# as Fortran files (default is PHP), and .f files as C (default is Fortran), 325*c917796cSXin LI# use: inc=Fortran f=C. 326*c917796cSXin LI# 327*c917796cSXin LI# Note: For files without extension you can use no_extension as a placeholder. 328*c917796cSXin LI# 329*c917796cSXin LI# Note that for custom extensions you also need to set FILE_PATTERNS otherwise 330*c917796cSXin LI# the files are not read by doxygen. When specifying no_extension you should add 331*c917796cSXin LI# * to the FILE_PATTERNS. 332*c917796cSXin LI# 333*c917796cSXin LI# Note see also the list of default file extension mappings. 334*c917796cSXin LI 335*c917796cSXin LIEXTENSION_MAPPING = 336*c917796cSXin LI 337*c917796cSXin LI# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 338*c917796cSXin LI# according to the Markdown format, which allows for more readable 339*c917796cSXin LI# documentation. See https://daringfireball.net/projects/markdown/ for details. 340*c917796cSXin LI# The output of markdown processing is further processed by doxygen, so you can 341*c917796cSXin LI# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 342*c917796cSXin LI# case of backward compatibilities issues. 343*c917796cSXin LI# The default value is: YES. 344*c917796cSXin LI 345*c917796cSXin LIMARKDOWN_SUPPORT = NO 346*c917796cSXin LI 347*c917796cSXin LI# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 348*c917796cSXin LI# to that level are automatically included in the table of contents, even if 349*c917796cSXin LI# they do not have an id attribute. 350*c917796cSXin LI# Note: This feature currently applies only to Markdown headings. 351*c917796cSXin LI# Minimum value: 0, maximum value: 99, default value: 5. 352*c917796cSXin LI# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 353*c917796cSXin LI 354*c917796cSXin LITOC_INCLUDE_HEADINGS = 5 355*c917796cSXin LI 356*c917796cSXin LI# When enabled doxygen tries to link words that correspond to documented 357*c917796cSXin LI# classes, or namespaces to their corresponding documentation. Such a link can 358*c917796cSXin LI# be prevented in individual cases by putting a % sign in front of the word or 359*c917796cSXin LI# globally by setting AUTOLINK_SUPPORT to NO. 360*c917796cSXin LI# The default value is: YES. 361*c917796cSXin LI 362*c917796cSXin LIAUTOLINK_SUPPORT = YES 363*c917796cSXin LI 364*c917796cSXin LI# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 365*c917796cSXin LI# to include (a tag file for) the STL sources as input, then you should set this 366*c917796cSXin LI# tag to YES in order to let doxygen match functions declarations and 367*c917796cSXin LI# definitions whose arguments contain STL classes (e.g. func(std::string); 368*c917796cSXin LI# versus func(std::string) {}). This also make the inheritance and collaboration 369*c917796cSXin LI# diagrams that involve STL classes more complete and accurate. 370*c917796cSXin LI# The default value is: NO. 371*c917796cSXin LI 372*c917796cSXin LIBUILTIN_STL_SUPPORT = NO 373*c917796cSXin LI 374*c917796cSXin LI# If you use Microsoft's C++/CLI language, you should set this option to YES to 375*c917796cSXin LI# enable parsing support. 376*c917796cSXin LI# The default value is: NO. 377*c917796cSXin LI 378*c917796cSXin LICPP_CLI_SUPPORT = NO 379*c917796cSXin LI 380*c917796cSXin LI# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 381*c917796cSXin LI# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen 382*c917796cSXin LI# will parse them like normal C++ but will assume all classes use public instead 383*c917796cSXin LI# of private inheritance when no explicit protection keyword is present. 384*c917796cSXin LI# The default value is: NO. 385*c917796cSXin LI 386*c917796cSXin LISIP_SUPPORT = NO 387*c917796cSXin LI 388*c917796cSXin LI# For Microsoft's IDL there are propget and propput attributes to indicate 389*c917796cSXin LI# getter and setter methods for a property. Setting this option to YES will make 390*c917796cSXin LI# doxygen to replace the get and set methods by a property in the documentation. 391*c917796cSXin LI# This will only work if the methods are indeed getting or setting a simple 392*c917796cSXin LI# type. If this is not the case, or you want to show the methods anyway, you 393*c917796cSXin LI# should set this option to NO. 394*c917796cSXin LI# The default value is: YES. 395*c917796cSXin LI 396*c917796cSXin LIIDL_PROPERTY_SUPPORT = NO 397*c917796cSXin LI 398*c917796cSXin LI# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 399*c917796cSXin LI# tag is set to YES then doxygen will reuse the documentation of the first 400*c917796cSXin LI# member in the group (if any) for the other members of the group. By default 401*c917796cSXin LI# all members of a group must be documented explicitly. 402*c917796cSXin LI# The default value is: NO. 403*c917796cSXin LI 404*c917796cSXin LIDISTRIBUTE_GROUP_DOC = NO 405*c917796cSXin LI 406*c917796cSXin LI# If one adds a struct or class to a group and this option is enabled, then also 407*c917796cSXin LI# any nested class or struct is added to the same group. By default this option 408*c917796cSXin LI# is disabled and one has to add nested compounds explicitly via \ingroup. 409*c917796cSXin LI# The default value is: NO. 410*c917796cSXin LI 411*c917796cSXin LIGROUP_NESTED_COMPOUNDS = NO 412*c917796cSXin LI 413*c917796cSXin LI# Set the SUBGROUPING tag to YES to allow class member groups of the same type 414*c917796cSXin LI# (for instance a group of public functions) to be put as a subgroup of that 415*c917796cSXin LI# type (e.g. under the Public Functions section). Set it to NO to prevent 416*c917796cSXin LI# subgrouping. Alternatively, this can be done per class using the 417*c917796cSXin LI# \nosubgrouping command. 418*c917796cSXin LI# The default value is: YES. 419*c917796cSXin LI 420*c917796cSXin LISUBGROUPING = YES 421*c917796cSXin LI 422*c917796cSXin LI# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 423*c917796cSXin LI# are shown inside the group in which they are included (e.g. using \ingroup) 424*c917796cSXin LI# instead of on a separate page (for HTML and Man pages) or section (for LaTeX 425*c917796cSXin LI# and RTF). 426*c917796cSXin LI# 427*c917796cSXin LI# Note that this feature does not work in combination with 428*c917796cSXin LI# SEPARATE_MEMBER_PAGES. 429*c917796cSXin LI# The default value is: NO. 430*c917796cSXin LI 431*c917796cSXin LIINLINE_GROUPED_CLASSES = NO 432*c917796cSXin LI 433*c917796cSXin LI# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 434*c917796cSXin LI# with only public data fields or simple typedef fields will be shown inline in 435*c917796cSXin LI# the documentation of the scope in which they are defined (i.e. file, 436*c917796cSXin LI# namespace, or group documentation), provided this scope is documented. If set 437*c917796cSXin LI# to NO, structs, classes, and unions are shown on a separate page (for HTML and 438*c917796cSXin LI# Man pages) or section (for LaTeX and RTF). 439*c917796cSXin LI# The default value is: NO. 440*c917796cSXin LI 441*c917796cSXin LIINLINE_SIMPLE_STRUCTS = NO 442*c917796cSXin LI 443*c917796cSXin LI# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 444*c917796cSXin LI# enum is documented as struct, union, or enum with the name of the typedef. So 445*c917796cSXin LI# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 446*c917796cSXin LI# with name TypeT. When disabled the typedef will appear as a member of a file, 447*c917796cSXin LI# namespace, or class. And the struct will be named TypeS. This can typically be 448*c917796cSXin LI# useful for C code in case the coding convention dictates that all compound 449*c917796cSXin LI# types are typedef'ed and only the typedef is referenced, never the tag name. 450*c917796cSXin LI# The default value is: NO. 451*c917796cSXin LI 452*c917796cSXin LITYPEDEF_HIDES_STRUCT = NO 453*c917796cSXin LI 454*c917796cSXin LI# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 455*c917796cSXin LI# cache is used to resolve symbols given their name and scope. Since this can be 456*c917796cSXin LI# an expensive process and often the same symbol appears multiple times in the 457*c917796cSXin LI# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 458*c917796cSXin LI# doxygen will become slower. If the cache is too large, memory is wasted. The 459*c917796cSXin LI# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 460*c917796cSXin LI# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 461*c917796cSXin LI# symbols. At the end of a run doxygen will report the cache usage and suggest 462*c917796cSXin LI# the optimal cache size from a speed point of view. 463*c917796cSXin LI# Minimum value: 0, maximum value: 9, default value: 0. 464*c917796cSXin LI 465*c917796cSXin LILOOKUP_CACHE_SIZE = 0 466*c917796cSXin LI 467*c917796cSXin LI# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use 468*c917796cSXin LI# during processing. When set to 0 doxygen will based this on the number of 469*c917796cSXin LI# cores available in the system. You can set it explicitly to a value larger 470*c917796cSXin LI# than 0 to get more control over the balance between CPU load and processing 471*c917796cSXin LI# speed. At this moment only the input processing can be done using multiple 472*c917796cSXin LI# threads. Since this is still an experimental feature the default is set to 1, 473*c917796cSXin LI# which effectively disables parallel processing. Please report any issues you 474*c917796cSXin LI# encounter. Generating dot graphs in parallel is controlled by the 475*c917796cSXin LI# DOT_NUM_THREADS setting. 476*c917796cSXin LI# Minimum value: 0, maximum value: 32, default value: 1. 477*c917796cSXin LI 478*c917796cSXin LINUM_PROC_THREADS = 1 479*c917796cSXin LI 480*c917796cSXin LI#--------------------------------------------------------------------------- 481*c917796cSXin LI# Build related configuration options 482*c917796cSXin LI#--------------------------------------------------------------------------- 483*c917796cSXin LI 484*c917796cSXin LI# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 485*c917796cSXin LI# documentation are documented, even if no documentation was available. Private 486*c917796cSXin LI# class members and static file members will be hidden unless the 487*c917796cSXin LI# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 488*c917796cSXin LI# Note: This will also disable the warnings about undocumented members that are 489*c917796cSXin LI# normally produced when WARNINGS is set to YES. 490*c917796cSXin LI# The default value is: NO. 491*c917796cSXin LI 492*c917796cSXin LIEXTRACT_ALL = NO 493*c917796cSXin LI 494*c917796cSXin LI# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 495*c917796cSXin LI# be included in the documentation. 496*c917796cSXin LI# The default value is: NO. 497*c917796cSXin LI 498*c917796cSXin LIEXTRACT_PRIVATE = NO 499*c917796cSXin LI 500*c917796cSXin LI# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual 501*c917796cSXin LI# methods of a class will be included in the documentation. 502*c917796cSXin LI# The default value is: NO. 503*c917796cSXin LI 504*c917796cSXin LIEXTRACT_PRIV_VIRTUAL = NO 505*c917796cSXin LI 506*c917796cSXin LI# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 507*c917796cSXin LI# scope will be included in the documentation. 508*c917796cSXin LI# The default value is: NO. 509*c917796cSXin LI 510*c917796cSXin LIEXTRACT_PACKAGE = NO 511*c917796cSXin LI 512*c917796cSXin LI# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 513*c917796cSXin LI# included in the documentation. 514*c917796cSXin LI# The default value is: NO. 515*c917796cSXin LI 516*c917796cSXin LIEXTRACT_STATIC = NO 517*c917796cSXin LI 518*c917796cSXin LI# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 519*c917796cSXin LI# locally in source files will be included in the documentation. If set to NO, 520*c917796cSXin LI# only classes defined in header files are included. Does not have any effect 521*c917796cSXin LI# for Java sources. 522*c917796cSXin LI# The default value is: YES. 523*c917796cSXin LI 524*c917796cSXin LIEXTRACT_LOCAL_CLASSES = NO 525*c917796cSXin LI 526*c917796cSXin LI# This flag is only useful for Objective-C code. If set to YES, local methods, 527*c917796cSXin LI# which are defined in the implementation section but not in the interface are 528*c917796cSXin LI# included in the documentation. If set to NO, only methods in the interface are 529*c917796cSXin LI# included. 530*c917796cSXin LI# The default value is: NO. 531*c917796cSXin LI 532*c917796cSXin LIEXTRACT_LOCAL_METHODS = NO 533*c917796cSXin LI 534*c917796cSXin LI# If this flag is set to YES, the members of anonymous namespaces will be 535*c917796cSXin LI# extracted and appear in the documentation as a namespace called 536*c917796cSXin LI# 'anonymous_namespace{file}', where file will be replaced with the base name of 537*c917796cSXin LI# the file that contains the anonymous namespace. By default anonymous namespace 538*c917796cSXin LI# are hidden. 539*c917796cSXin LI# The default value is: NO. 540*c917796cSXin LI 541*c917796cSXin LIEXTRACT_ANON_NSPACES = NO 542*c917796cSXin LI 543*c917796cSXin LI# If this flag is set to YES, the name of an unnamed parameter in a declaration 544*c917796cSXin LI# will be determined by the corresponding definition. By default unnamed 545*c917796cSXin LI# parameters remain unnamed in the output. 546*c917796cSXin LI# The default value is: YES. 547*c917796cSXin LI 548*c917796cSXin LIRESOLVE_UNNAMED_PARAMS = YES 549*c917796cSXin LI 550*c917796cSXin LI# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 551*c917796cSXin LI# undocumented members inside documented classes or files. If set to NO these 552*c917796cSXin LI# members will be included in the various overviews, but no documentation 553*c917796cSXin LI# section is generated. This option has no effect if EXTRACT_ALL is enabled. 554*c917796cSXin LI# The default value is: NO. 555*c917796cSXin LI 556*c917796cSXin LIHIDE_UNDOC_MEMBERS = NO 557*c917796cSXin LI 558*c917796cSXin LI# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 559*c917796cSXin LI# undocumented classes that are normally visible in the class hierarchy. If set 560*c917796cSXin LI# to NO, these classes will be included in the various overviews. This option 561*c917796cSXin LI# will also hide undocumented C++ concepts if enabled. This option has no effect 562*c917796cSXin LI# if EXTRACT_ALL is enabled. 563*c917796cSXin LI# The default value is: NO. 564*c917796cSXin LI 565*c917796cSXin LIHIDE_UNDOC_CLASSES = NO 566*c917796cSXin LI 567*c917796cSXin LI# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 568*c917796cSXin LI# declarations. If set to NO, these declarations will be included in the 569*c917796cSXin LI# documentation. 570*c917796cSXin LI# The default value is: NO. 571*c917796cSXin LI 572*c917796cSXin LIHIDE_FRIEND_COMPOUNDS = NO 573*c917796cSXin LI 574*c917796cSXin LI# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 575*c917796cSXin LI# documentation blocks found inside the body of a function. If set to NO, these 576*c917796cSXin LI# blocks will be appended to the function's detailed documentation block. 577*c917796cSXin LI# The default value is: NO. 578*c917796cSXin LI 579*c917796cSXin LIHIDE_IN_BODY_DOCS = NO 580*c917796cSXin LI 581*c917796cSXin LI# The INTERNAL_DOCS tag determines if documentation that is typed after a 582*c917796cSXin LI# \internal command is included. If the tag is set to NO then the documentation 583*c917796cSXin LI# will be excluded. Set it to YES to include the internal documentation. 584*c917796cSXin LI# The default value is: NO. 585*c917796cSXin LI 586*c917796cSXin LIINTERNAL_DOCS = NO 587*c917796cSXin LI 588*c917796cSXin LI# With the correct setting of option CASE_SENSE_NAMES doxygen will better be 589*c917796cSXin LI# able to match the capabilities of the underlying filesystem. In case the 590*c917796cSXin LI# filesystem is case sensitive (i.e. it supports files in the same directory 591*c917796cSXin LI# whose names only differ in casing), the option must be set to YES to properly 592*c917796cSXin LI# deal with such files in case they appear in the input. For filesystems that 593*c917796cSXin LI# are not case sensitive the option should be set to NO to properly deal with 594*c917796cSXin LI# output files written for symbols that only differ in casing, such as for two 595*c917796cSXin LI# classes, one named CLASS and the other named Class, and to also support 596*c917796cSXin LI# references to files without having to specify the exact matching casing. On 597*c917796cSXin LI# Windows (including Cygwin) and MacOS, users should typically set this option 598*c917796cSXin LI# to NO, whereas on Linux or other Unix flavors it should typically be set to 599*c917796cSXin LI# YES. 600*c917796cSXin LI# Possible values are: SYSTEM, NO and YES. 601*c917796cSXin LI# The default value is: SYSTEM. 602*c917796cSXin LI 603*c917796cSXin LICASE_SENSE_NAMES = YES 604*c917796cSXin LI 605*c917796cSXin LI# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 606*c917796cSXin LI# their full class and namespace scopes in the documentation. If set to YES, the 607*c917796cSXin LI# scope will be hidden. 608*c917796cSXin LI# The default value is: NO. 609*c917796cSXin LI 610*c917796cSXin LIHIDE_SCOPE_NAMES = NO 611*c917796cSXin LI 612*c917796cSXin LI# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 613*c917796cSXin LI# append additional text to a page's title, such as Class Reference. If set to 614*c917796cSXin LI# YES the compound reference will be hidden. 615*c917796cSXin LI# The default value is: NO. 616*c917796cSXin LI 617*c917796cSXin LIHIDE_COMPOUND_REFERENCE= NO 618*c917796cSXin LI 619*c917796cSXin LI# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class 620*c917796cSXin LI# will show which file needs to be included to use the class. 621*c917796cSXin LI# The default value is: YES. 622*c917796cSXin LI 623*c917796cSXin LISHOW_HEADERFILE = YES 624*c917796cSXin LI 625*c917796cSXin LI# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 626*c917796cSXin LI# the files that are included by a file in the documentation of that file. 627*c917796cSXin LI# The default value is: YES. 628*c917796cSXin LI 629*c917796cSXin LISHOW_INCLUDE_FILES = YES 630*c917796cSXin LI 631*c917796cSXin LI# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 632*c917796cSXin LI# grouped member an include statement to the documentation, telling the reader 633*c917796cSXin LI# which file to include in order to use the member. 634*c917796cSXin LI# The default value is: NO. 635*c917796cSXin LI 636*c917796cSXin LISHOW_GROUPED_MEMB_INC = NO 637*c917796cSXin LI 638*c917796cSXin LI# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 639*c917796cSXin LI# files with double quotes in the documentation rather than with sharp brackets. 640*c917796cSXin LI# The default value is: NO. 641*c917796cSXin LI 642*c917796cSXin LIFORCE_LOCAL_INCLUDES = NO 643*c917796cSXin LI 644*c917796cSXin LI# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 645*c917796cSXin LI# documentation for inline members. 646*c917796cSXin LI# The default value is: YES. 647*c917796cSXin LI 648*c917796cSXin LIINLINE_INFO = YES 649*c917796cSXin LI 650*c917796cSXin LI# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 651*c917796cSXin LI# (detailed) documentation of file and class members alphabetically by member 652*c917796cSXin LI# name. If set to NO, the members will appear in declaration order. 653*c917796cSXin LI# The default value is: YES. 654*c917796cSXin LI 655*c917796cSXin LISORT_MEMBER_DOCS = NO 656*c917796cSXin LI 657*c917796cSXin LI# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 658*c917796cSXin LI# descriptions of file, namespace and class members alphabetically by member 659*c917796cSXin LI# name. If set to NO, the members will appear in declaration order. Note that 660*c917796cSXin LI# this will also influence the order of the classes in the class list. 661*c917796cSXin LI# The default value is: NO. 662*c917796cSXin LI 663*c917796cSXin LISORT_BRIEF_DOCS = NO 664*c917796cSXin LI 665*c917796cSXin LI# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 666*c917796cSXin LI# (brief and detailed) documentation of class members so that constructors and 667*c917796cSXin LI# destructors are listed first. If set to NO the constructors will appear in the 668*c917796cSXin LI# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 669*c917796cSXin LI# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 670*c917796cSXin LI# member documentation. 671*c917796cSXin LI# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 672*c917796cSXin LI# detailed member documentation. 673*c917796cSXin LI# The default value is: NO. 674*c917796cSXin LI 675*c917796cSXin LISORT_MEMBERS_CTORS_1ST = NO 676*c917796cSXin LI 677*c917796cSXin LI# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 678*c917796cSXin LI# of group names into alphabetical order. If set to NO the group names will 679*c917796cSXin LI# appear in their defined order. 680*c917796cSXin LI# The default value is: NO. 681*c917796cSXin LI 682*c917796cSXin LISORT_GROUP_NAMES = NO 683*c917796cSXin LI 684*c917796cSXin LI# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 685*c917796cSXin LI# fully-qualified names, including namespaces. If set to NO, the class list will 686*c917796cSXin LI# be sorted only by class name, not including the namespace part. 687*c917796cSXin LI# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 688*c917796cSXin LI# Note: This option applies only to the class list, not to the alphabetical 689*c917796cSXin LI# list. 690*c917796cSXin LI# The default value is: NO. 691*c917796cSXin LI 692*c917796cSXin LISORT_BY_SCOPE_NAME = NO 693*c917796cSXin LI 694*c917796cSXin LI# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 695*c917796cSXin LI# type resolution of all parameters of a function it will reject a match between 696*c917796cSXin LI# the prototype and the implementation of a member function even if there is 697*c917796cSXin LI# only one candidate or it is obvious which candidate to choose by doing a 698*c917796cSXin LI# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 699*c917796cSXin LI# accept a match between prototype and implementation in such cases. 700*c917796cSXin LI# The default value is: NO. 701*c917796cSXin LI 702*c917796cSXin LISTRICT_PROTO_MATCHING = NO 703*c917796cSXin LI 704*c917796cSXin LI# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 705*c917796cSXin LI# list. This list is created by putting \todo commands in the documentation. 706*c917796cSXin LI# The default value is: YES. 707*c917796cSXin LI 708*c917796cSXin LIGENERATE_TODOLIST = YES 709*c917796cSXin LI 710*c917796cSXin LI# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 711*c917796cSXin LI# list. This list is created by putting \test commands in the documentation. 712*c917796cSXin LI# The default value is: YES. 713*c917796cSXin LI 714*c917796cSXin LIGENERATE_TESTLIST = YES 715*c917796cSXin LI 716*c917796cSXin LI# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 717*c917796cSXin LI# list. This list is created by putting \bug commands in the documentation. 718*c917796cSXin LI# The default value is: YES. 719*c917796cSXin LI 720*c917796cSXin LIGENERATE_BUGLIST = YES 721*c917796cSXin LI 722*c917796cSXin LI# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 723*c917796cSXin LI# the deprecated list. This list is created by putting \deprecated commands in 724*c917796cSXin LI# the documentation. 725*c917796cSXin LI# The default value is: YES. 726*c917796cSXin LI 727*c917796cSXin LIGENERATE_DEPRECATEDLIST= YES 728*c917796cSXin LI 729*c917796cSXin LI# The ENABLED_SECTIONS tag can be used to enable conditional documentation 730*c917796cSXin LI# sections, marked by \if <section_label> ... \endif and \cond <section_label> 731*c917796cSXin LI# ... \endcond blocks. 732*c917796cSXin LI 733*c917796cSXin LIENABLED_SECTIONS = 734*c917796cSXin LI 735*c917796cSXin LI# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 736*c917796cSXin LI# initial value of a variable or macro / define can have for it to appear in the 737*c917796cSXin LI# documentation. If the initializer consists of more lines than specified here 738*c917796cSXin LI# it will be hidden. Use a value of 0 to hide initializers completely. The 739*c917796cSXin LI# appearance of the value of individual variables and macros / defines can be 740*c917796cSXin LI# controlled using \showinitializer or \hideinitializer command in the 741*c917796cSXin LI# documentation regardless of this setting. 742*c917796cSXin LI# Minimum value: 0, maximum value: 10000, default value: 30. 743*c917796cSXin LI 744*c917796cSXin LIMAX_INITIALIZER_LINES = 30 745*c917796cSXin LI 746*c917796cSXin LI# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 747*c917796cSXin LI# the bottom of the documentation of classes and structs. If set to YES, the 748*c917796cSXin LI# list will mention the files that were used to generate the documentation. 749*c917796cSXin LI# The default value is: YES. 750*c917796cSXin LI 751*c917796cSXin LISHOW_USED_FILES = YES 752*c917796cSXin LI 753*c917796cSXin LI# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 754*c917796cSXin LI# will remove the Files entry from the Quick Index and from the Folder Tree View 755*c917796cSXin LI# (if specified). 756*c917796cSXin LI# The default value is: YES. 757*c917796cSXin LI 758*c917796cSXin LISHOW_FILES = YES 759*c917796cSXin LI 760*c917796cSXin LI# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 761*c917796cSXin LI# page. This will remove the Namespaces entry from the Quick Index and from the 762*c917796cSXin LI# Folder Tree View (if specified). 763*c917796cSXin LI# The default value is: YES. 764*c917796cSXin LI 765*c917796cSXin LISHOW_NAMESPACES = NO 766*c917796cSXin LI 767*c917796cSXin LI# The FILE_VERSION_FILTER tag can be used to specify a program or script that 768*c917796cSXin LI# doxygen should invoke to get the current version for each file (typically from 769*c917796cSXin LI# the version control system). Doxygen will invoke the program by executing (via 770*c917796cSXin LI# popen()) the command command input-file, where command is the value of the 771*c917796cSXin LI# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 772*c917796cSXin LI# by doxygen. Whatever the program writes to standard output is used as the file 773*c917796cSXin LI# version. For an example see the documentation. 774*c917796cSXin LI 775*c917796cSXin LIFILE_VERSION_FILTER = 776*c917796cSXin LI 777*c917796cSXin LI# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 778*c917796cSXin LI# by doxygen. The layout file controls the global structure of the generated 779*c917796cSXin LI# output files in an output format independent way. To create the layout file 780*c917796cSXin LI# that represents doxygen's defaults, run doxygen with the -l option. You can 781*c917796cSXin LI# optionally specify a file name after the option, if omitted DoxygenLayout.xml 782*c917796cSXin LI# will be used as the name of the layout file. See also section "Changing the 783*c917796cSXin LI# layout of pages" for information. 784*c917796cSXin LI# 785*c917796cSXin LI# Note that if you run doxygen from a directory containing a file called 786*c917796cSXin LI# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 787*c917796cSXin LI# tag is left empty. 788*c917796cSXin LI 789*c917796cSXin LILAYOUT_FILE = 790*c917796cSXin LI 791*c917796cSXin LI# The CITE_BIB_FILES tag can be used to specify one or more bib files containing 792*c917796cSXin LI# the reference definitions. This must be a list of .bib files. The .bib 793*c917796cSXin LI# extension is automatically appended if omitted. This requires the bibtex tool 794*c917796cSXin LI# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. 795*c917796cSXin LI# For LaTeX the style of the bibliography can be controlled using 796*c917796cSXin LI# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 797*c917796cSXin LI# search path. See also \cite for info how to create references. 798*c917796cSXin LI 799*c917796cSXin LICITE_BIB_FILES = 800*c917796cSXin LI 801*c917796cSXin LI#--------------------------------------------------------------------------- 802*c917796cSXin LI# Configuration options related to warning and progress messages 803*c917796cSXin LI#--------------------------------------------------------------------------- 804*c917796cSXin LI 805*c917796cSXin LI# The QUIET tag can be used to turn on/off the messages that are generated to 806*c917796cSXin LI# standard output by doxygen. If QUIET is set to YES this implies that the 807*c917796cSXin LI# messages are off. 808*c917796cSXin LI# The default value is: NO. 809*c917796cSXin LI 810*c917796cSXin LIQUIET = NO 811*c917796cSXin LI 812*c917796cSXin LI# The WARNINGS tag can be used to turn on/off the warning messages that are 813*c917796cSXin LI# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 814*c917796cSXin LI# this implies that the warnings are on. 815*c917796cSXin LI# 816*c917796cSXin LI# Tip: Turn warnings on while writing the documentation. 817*c917796cSXin LI# The default value is: YES. 818*c917796cSXin LI 819*c917796cSXin LIWARNINGS = YES 820*c917796cSXin LI 821*c917796cSXin LI# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 822*c917796cSXin LI# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 823*c917796cSXin LI# will automatically be disabled. 824*c917796cSXin LI# The default value is: YES. 825*c917796cSXin LI 826*c917796cSXin LIWARN_IF_UNDOCUMENTED = YES 827*c917796cSXin LI 828*c917796cSXin LI# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 829*c917796cSXin LI# potential errors in the documentation, such as documenting some parameters in 830*c917796cSXin LI# a documented function twice, or documenting parameters that don't exist or 831*c917796cSXin LI# using markup commands wrongly. 832*c917796cSXin LI# The default value is: YES. 833*c917796cSXin LI 834*c917796cSXin LIWARN_IF_DOC_ERROR = YES 835*c917796cSXin LI 836*c917796cSXin LI# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete 837*c917796cSXin LI# function parameter documentation. If set to NO, doxygen will accept that some 838*c917796cSXin LI# parameters have no documentation without warning. 839*c917796cSXin LI# The default value is: YES. 840*c917796cSXin LI 841*c917796cSXin LIWARN_IF_INCOMPLETE_DOC = YES 842*c917796cSXin LI 843*c917796cSXin LI# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 844*c917796cSXin LI# are documented, but have no documentation for their parameters or return 845*c917796cSXin LI# value. If set to NO, doxygen will only warn about wrong parameter 846*c917796cSXin LI# documentation, but not about the absence of documentation. If EXTRACT_ALL is 847*c917796cSXin LI# set to YES then this flag will automatically be disabled. See also 848*c917796cSXin LI# WARN_IF_INCOMPLETE_DOC 849*c917796cSXin LI# The default value is: NO. 850*c917796cSXin LI 851*c917796cSXin LIWARN_NO_PARAMDOC = NO 852*c917796cSXin LI 853*c917796cSXin LI# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about 854*c917796cSXin LI# undocumented enumeration values. If set to NO, doxygen will accept 855*c917796cSXin LI# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag 856*c917796cSXin LI# will automatically be disabled. 857*c917796cSXin LI# The default value is: NO. 858*c917796cSXin LI 859*c917796cSXin LIWARN_IF_UNDOC_ENUM_VAL = NO 860*c917796cSXin LI 861*c917796cSXin LI# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 862*c917796cSXin LI# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS 863*c917796cSXin LI# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but 864*c917796cSXin LI# at the end of the doxygen process doxygen will return with a non-zero status. 865*c917796cSXin LI# Possible values are: NO, YES and FAIL_ON_WARNINGS. 866*c917796cSXin LI# The default value is: NO. 867*c917796cSXin LI 868*c917796cSXin LIWARN_AS_ERROR = NO 869*c917796cSXin LI 870*c917796cSXin LI# The WARN_FORMAT tag determines the format of the warning messages that doxygen 871*c917796cSXin LI# can produce. The string should contain the $file, $line, and $text tags, which 872*c917796cSXin LI# will be replaced by the file and line number from which the warning originated 873*c917796cSXin LI# and the warning text. Optionally the format may contain $version, which will 874*c917796cSXin LI# be replaced by the version of the file (if it could be obtained via 875*c917796cSXin LI# FILE_VERSION_FILTER) 876*c917796cSXin LI# See also: WARN_LINE_FORMAT 877*c917796cSXin LI# The default value is: $file:$line: $text. 878*c917796cSXin LI 879*c917796cSXin LIWARN_FORMAT = "$file:$line: $text" 880*c917796cSXin LI 881*c917796cSXin LI# In the $text part of the WARN_FORMAT command it is possible that a reference 882*c917796cSXin LI# to a more specific place is given. To make it easier to jump to this place 883*c917796cSXin LI# (outside of doxygen) the user can define a custom "cut" / "paste" string. 884*c917796cSXin LI# Example: 885*c917796cSXin LI# WARN_LINE_FORMAT = "'vi $file +$line'" 886*c917796cSXin LI# See also: WARN_FORMAT 887*c917796cSXin LI# The default value is: at line $line of file $file. 888*c917796cSXin LI 889*c917796cSXin LIWARN_LINE_FORMAT = "at line $line of file $file" 890*c917796cSXin LI 891*c917796cSXin LI# The WARN_LOGFILE tag can be used to specify a file to which warning and error 892*c917796cSXin LI# messages should be written. If left blank the output is written to standard 893*c917796cSXin LI# error (stderr). In case the file specified cannot be opened for writing the 894*c917796cSXin LI# warning and error messages are written to standard error. When as file - is 895*c917796cSXin LI# specified the warning and error messages are written to standard output 896*c917796cSXin LI# (stdout). 897*c917796cSXin LI 898*c917796cSXin LIWARN_LOGFILE = 899*c917796cSXin LI 900*c917796cSXin LI#--------------------------------------------------------------------------- 901*c917796cSXin LI# Configuration options related to the input files 902*c917796cSXin LI#--------------------------------------------------------------------------- 903*c917796cSXin LI 904*c917796cSXin LI# The INPUT tag is used to specify the files and/or directories that contain 905*c917796cSXin LI# documented source files. You may enter file names like myfile.cpp or 906*c917796cSXin LI# directories like /usr/src/myproject. Separate the files or directories with 907*c917796cSXin LI# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 908*c917796cSXin LI# Note: If this tag is empty the current directory is searched. 909*c917796cSXin LI 910*c917796cSXin LIINPUT = ../src/liblzma/api 911*c917796cSXin LI 912*c917796cSXin LI# This tag can be used to specify the character encoding of the source files 913*c917796cSXin LI# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 914*c917796cSXin LI# libiconv (or the iconv built into libc) for the transcoding. See the libiconv 915*c917796cSXin LI# documentation (see: 916*c917796cSXin LI# https://www.gnu.org/software/libiconv/) for the list of possible encodings. 917*c917796cSXin LI# See also: INPUT_FILE_ENCODING 918*c917796cSXin LI# The default value is: UTF-8. 919*c917796cSXin LI 920*c917796cSXin LIINPUT_ENCODING = UTF-8 921*c917796cSXin LI 922*c917796cSXin LI# This tag can be used to specify the character encoding of the source files 923*c917796cSXin LI# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify 924*c917796cSXin LI# character encoding on a per file pattern basis. Doxygen will compare the file 925*c917796cSXin LI# name with each pattern and apply the encoding instead of the default 926*c917796cSXin LI# INPUT_ENCODING) if there is a match. The character encodings are a list of the 927*c917796cSXin LI# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding 928*c917796cSXin LI# "INPUT_ENCODING" for further information on supported encodings. 929*c917796cSXin LI 930*c917796cSXin LIINPUT_FILE_ENCODING = 931*c917796cSXin LI 932*c917796cSXin LI# If the value of the INPUT tag contains directories, you can use the 933*c917796cSXin LI# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 934*c917796cSXin LI# *.h) to filter out the source-files in the directories. 935*c917796cSXin LI# 936*c917796cSXin LI# Note that for custom extensions or not directly supported extensions you also 937*c917796cSXin LI# need to set EXTENSION_MAPPING for the extension otherwise the files are not 938*c917796cSXin LI# read by doxygen. 939*c917796cSXin LI# 940*c917796cSXin LI# Note the list of default checked file patterns might differ from the list of 941*c917796cSXin LI# default file extension mappings. 942*c917796cSXin LI# 943*c917796cSXin LI# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 944*c917796cSXin LI# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 945*c917796cSXin LI# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, 946*c917796cSXin LI# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C 947*c917796cSXin LI# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, 948*c917796cSXin LI# *.vhdl, *.ucf, *.qsf and *.ice. 949*c917796cSXin LI 950*c917796cSXin LIFILE_PATTERNS = *.c \ 951*c917796cSXin LI *.h 952*c917796cSXin LI 953*c917796cSXin LI# The RECURSIVE tag can be used to specify whether or not subdirectories should 954*c917796cSXin LI# be searched for input files as well. 955*c917796cSXin LI# The default value is: NO. 956*c917796cSXin LI 957*c917796cSXin LIRECURSIVE = YES 958*c917796cSXin LI 959*c917796cSXin LI# The EXCLUDE tag can be used to specify files and/or directories that should be 960*c917796cSXin LI# excluded from the INPUT source files. This way you can easily exclude a 961*c917796cSXin LI# subdirectory from a directory tree whose root is specified with the INPUT tag. 962*c917796cSXin LI# 963*c917796cSXin LI# Note that relative paths are relative to the directory from which doxygen is 964*c917796cSXin LI# run. 965*c917796cSXin LI 966*c917796cSXin LIEXCLUDE = 967*c917796cSXin LI 968*c917796cSXin LI# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 969*c917796cSXin LI# directories that are symbolic links (a Unix file system feature) are excluded 970*c917796cSXin LI# from the input. 971*c917796cSXin LI# The default value is: NO. 972*c917796cSXin LI 973*c917796cSXin LIEXCLUDE_SYMLINKS = YES 974*c917796cSXin LI 975*c917796cSXin LI# If the value of the INPUT tag contains directories, you can use the 976*c917796cSXin LI# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 977*c917796cSXin LI# certain files from those directories. 978*c917796cSXin LI# 979*c917796cSXin LI# Note that the wildcards are matched against the file with absolute path, so to 980*c917796cSXin LI# exclude all test directories for example use the pattern */test/* 981*c917796cSXin LI 982*c917796cSXin LIEXCLUDE_PATTERNS = 983*c917796cSXin LI 984*c917796cSXin LI# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 985*c917796cSXin LI# (namespaces, classes, functions, etc.) that should be excluded from the 986*c917796cSXin LI# output. The symbol name can be a fully qualified name, a word, or if the 987*c917796cSXin LI# wildcard * is used, a substring. Examples: ANamespace, AClass, 988*c917796cSXin LI# ANamespace::AClass, ANamespace::*Test 989*c917796cSXin LI# 990*c917796cSXin LI# Note that the wildcards are matched against the file with absolute path, so to 991*c917796cSXin LI# exclude all test directories use the pattern */test/* 992*c917796cSXin LI 993*c917796cSXin LIEXCLUDE_SYMBOLS = 994*c917796cSXin LI 995*c917796cSXin LI# The EXAMPLE_PATH tag can be used to specify one or more files or directories 996*c917796cSXin LI# that contain example code fragments that are included (see the \include 997*c917796cSXin LI# command). 998*c917796cSXin LI 999*c917796cSXin LIEXAMPLE_PATH = 1000*c917796cSXin LI 1001*c917796cSXin LI# If the value of the EXAMPLE_PATH tag contains directories, you can use the 1002*c917796cSXin LI# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 1003*c917796cSXin LI# *.h) to filter out the source-files in the directories. If left blank all 1004*c917796cSXin LI# files are included. 1005*c917796cSXin LI 1006*c917796cSXin LIEXAMPLE_PATTERNS = 1007*c917796cSXin LI 1008*c917796cSXin LI# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 1009*c917796cSXin LI# searched for input files to be used with the \include or \dontinclude commands 1010*c917796cSXin LI# irrespective of the value of the RECURSIVE tag. 1011*c917796cSXin LI# The default value is: NO. 1012*c917796cSXin LI 1013*c917796cSXin LIEXAMPLE_RECURSIVE = NO 1014*c917796cSXin LI 1015*c917796cSXin LI# The IMAGE_PATH tag can be used to specify one or more files or directories 1016*c917796cSXin LI# that contain images that are to be included in the documentation (see the 1017*c917796cSXin LI# \image command). 1018*c917796cSXin LI 1019*c917796cSXin LIIMAGE_PATH = 1020*c917796cSXin LI 1021*c917796cSXin LI# The INPUT_FILTER tag can be used to specify a program that doxygen should 1022*c917796cSXin LI# invoke to filter for each input file. Doxygen will invoke the filter program 1023*c917796cSXin LI# by executing (via popen()) the command: 1024*c917796cSXin LI# 1025*c917796cSXin LI# <filter> <input-file> 1026*c917796cSXin LI# 1027*c917796cSXin LI# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the 1028*c917796cSXin LI# name of an input file. Doxygen will then use the output that the filter 1029*c917796cSXin LI# program writes to standard output. If FILTER_PATTERNS is specified, this tag 1030*c917796cSXin LI# will be ignored. 1031*c917796cSXin LI# 1032*c917796cSXin LI# Note that the filter must not add or remove lines; it is applied before the 1033*c917796cSXin LI# code is scanned, but not when the output code is generated. If lines are added 1034*c917796cSXin LI# or removed, the anchors will not be placed correctly. 1035*c917796cSXin LI# 1036*c917796cSXin LI# Note that doxygen will use the data processed and written to standard output 1037*c917796cSXin LI# for further processing, therefore nothing else, like debug statements or used 1038*c917796cSXin LI# commands (so in case of a Windows batch file always use @echo OFF), should be 1039*c917796cSXin LI# written to standard output. 1040*c917796cSXin LI# 1041*c917796cSXin LI# Note that for custom extensions or not directly supported extensions you also 1042*c917796cSXin LI# need to set EXTENSION_MAPPING for the extension otherwise the files are not 1043*c917796cSXin LI# properly processed by doxygen. 1044*c917796cSXin LI 1045*c917796cSXin LIINPUT_FILTER = 1046*c917796cSXin LI 1047*c917796cSXin LI# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 1048*c917796cSXin LI# basis. Doxygen will compare the file name with each pattern and apply the 1049*c917796cSXin LI# filter if there is a match. The filters are a list of the form: pattern=filter 1050*c917796cSXin LI# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 1051*c917796cSXin LI# filters are used. If the FILTER_PATTERNS tag is empty or if none of the 1052*c917796cSXin LI# patterns match the file name, INPUT_FILTER is applied. 1053*c917796cSXin LI# 1054*c917796cSXin LI# Note that for custom extensions or not directly supported extensions you also 1055*c917796cSXin LI# need to set EXTENSION_MAPPING for the extension otherwise the files are not 1056*c917796cSXin LI# properly processed by doxygen. 1057*c917796cSXin LI 1058*c917796cSXin LIFILTER_PATTERNS = 1059*c917796cSXin LI 1060*c917796cSXin LI# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 1061*c917796cSXin LI# INPUT_FILTER) will also be used to filter the input files that are used for 1062*c917796cSXin LI# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 1063*c917796cSXin LI# The default value is: NO. 1064*c917796cSXin LI 1065*c917796cSXin LIFILTER_SOURCE_FILES = NO 1066*c917796cSXin LI 1067*c917796cSXin LI# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 1068*c917796cSXin LI# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 1069*c917796cSXin LI# it is also possible to disable source filtering for a specific pattern using 1070*c917796cSXin LI# *.ext= (so without naming a filter). 1071*c917796cSXin LI# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 1072*c917796cSXin LI 1073*c917796cSXin LIFILTER_SOURCE_PATTERNS = 1074*c917796cSXin LI 1075*c917796cSXin LI# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 1076*c917796cSXin LI# is part of the input, its contents will be placed on the main page 1077*c917796cSXin LI# (index.html). This can be useful if you have a project on for instance GitHub 1078*c917796cSXin LI# and want to reuse the introduction page also for the doxygen output. 1079*c917796cSXin LI 1080*c917796cSXin LIUSE_MDFILE_AS_MAINPAGE = 1081*c917796cSXin LI 1082*c917796cSXin LI# The Fortran standard specifies that for fixed formatted Fortran code all 1083*c917796cSXin LI# characters from position 72 are to be considered as comment. A common 1084*c917796cSXin LI# extension is to allow longer lines before the automatic comment starts. The 1085*c917796cSXin LI# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can 1086*c917796cSXin LI# be processed before the automatic comment starts. 1087*c917796cSXin LI# Minimum value: 7, maximum value: 10000, default value: 72. 1088*c917796cSXin LI 1089*c917796cSXin LIFORTRAN_COMMENT_AFTER = 72 1090*c917796cSXin LI 1091*c917796cSXin LI#--------------------------------------------------------------------------- 1092*c917796cSXin LI# Configuration options related to source browsing 1093*c917796cSXin LI#--------------------------------------------------------------------------- 1094*c917796cSXin LI 1095*c917796cSXin LI# If the SOURCE_BROWSER tag is set to YES then a list of source files will be 1096*c917796cSXin LI# generated. Documented entities will be cross-referenced with these sources. 1097*c917796cSXin LI# 1098*c917796cSXin LI# Note: To get rid of all source code in the generated output, make sure that 1099*c917796cSXin LI# also VERBATIM_HEADERS is set to NO. 1100*c917796cSXin LI# The default value is: NO. 1101*c917796cSXin LI 1102*c917796cSXin LISOURCE_BROWSER = NO 1103*c917796cSXin LI 1104*c917796cSXin LI# Setting the INLINE_SOURCES tag to YES will include the body of functions, 1105*c917796cSXin LI# classes and enums directly into the documentation. 1106*c917796cSXin LI# The default value is: NO. 1107*c917796cSXin LI 1108*c917796cSXin LIINLINE_SOURCES = NO 1109*c917796cSXin LI 1110*c917796cSXin LI# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 1111*c917796cSXin LI# special comment blocks from generated source code fragments. Normal C, C++ and 1112*c917796cSXin LI# Fortran comments will always remain visible. 1113*c917796cSXin LI# The default value is: YES. 1114*c917796cSXin LI 1115*c917796cSXin LISTRIP_CODE_COMMENTS = YES 1116*c917796cSXin LI 1117*c917796cSXin LI# If the REFERENCED_BY_RELATION tag is set to YES then for each documented 1118*c917796cSXin LI# entity all documented functions referencing it will be listed. 1119*c917796cSXin LI# The default value is: NO. 1120*c917796cSXin LI 1121*c917796cSXin LIREFERENCED_BY_RELATION = YES 1122*c917796cSXin LI 1123*c917796cSXin LI# If the REFERENCES_RELATION tag is set to YES then for each documented function 1124*c917796cSXin LI# all documented entities called/used by that function will be listed. 1125*c917796cSXin LI# The default value is: NO. 1126*c917796cSXin LI 1127*c917796cSXin LIREFERENCES_RELATION = YES 1128*c917796cSXin LI 1129*c917796cSXin LI# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1130*c917796cSXin LI# to YES then the hyperlinks from functions in REFERENCES_RELATION and 1131*c917796cSXin LI# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1132*c917796cSXin LI# link to the documentation. 1133*c917796cSXin LI# The default value is: YES. 1134*c917796cSXin LI 1135*c917796cSXin LIREFERENCES_LINK_SOURCE = YES 1136*c917796cSXin LI 1137*c917796cSXin LI# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1138*c917796cSXin LI# source code will show a tooltip with additional information such as prototype, 1139*c917796cSXin LI# brief description and links to the definition and documentation. Since this 1140*c917796cSXin LI# will make the HTML file larger and loading of large files a bit slower, you 1141*c917796cSXin LI# can opt to disable this feature. 1142*c917796cSXin LI# The default value is: YES. 1143*c917796cSXin LI# This tag requires that the tag SOURCE_BROWSER is set to YES. 1144*c917796cSXin LI 1145*c917796cSXin LISOURCE_TOOLTIPS = NO 1146*c917796cSXin LI 1147*c917796cSXin LI# If the USE_HTAGS tag is set to YES then the references to source code will 1148*c917796cSXin LI# point to the HTML generated by the htags(1) tool instead of doxygen built-in 1149*c917796cSXin LI# source browser. The htags tool is part of GNU's global source tagging system 1150*c917796cSXin LI# (see https://www.gnu.org/software/global/global.html). You will need version 1151*c917796cSXin LI# 4.8.6 or higher. 1152*c917796cSXin LI# 1153*c917796cSXin LI# To use it do the following: 1154*c917796cSXin LI# - Install the latest version of global 1155*c917796cSXin LI# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file 1156*c917796cSXin LI# - Make sure the INPUT points to the root of the source tree 1157*c917796cSXin LI# - Run doxygen as normal 1158*c917796cSXin LI# 1159*c917796cSXin LI# Doxygen will invoke htags (and that will in turn invoke gtags), so these 1160*c917796cSXin LI# tools must be available from the command line (i.e. in the search path). 1161*c917796cSXin LI# 1162*c917796cSXin LI# The result: instead of the source browser generated by doxygen, the links to 1163*c917796cSXin LI# source code will now point to the output of htags. 1164*c917796cSXin LI# The default value is: NO. 1165*c917796cSXin LI# This tag requires that the tag SOURCE_BROWSER is set to YES. 1166*c917796cSXin LI 1167*c917796cSXin LIUSE_HTAGS = NO 1168*c917796cSXin LI 1169*c917796cSXin LI# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1170*c917796cSXin LI# verbatim copy of the header file for each class for which an include is 1171*c917796cSXin LI# specified. Set to NO to disable this. 1172*c917796cSXin LI# See also: Section \class. 1173*c917796cSXin LI# The default value is: YES. 1174*c917796cSXin LI 1175*c917796cSXin LIVERBATIM_HEADERS = NO 1176*c917796cSXin LI 1177*c917796cSXin LI#--------------------------------------------------------------------------- 1178*c917796cSXin LI# Configuration options related to the alphabetical class index 1179*c917796cSXin LI#--------------------------------------------------------------------------- 1180*c917796cSXin LI 1181*c917796cSXin LI# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1182*c917796cSXin LI# compounds will be generated. Enable this if the project contains a lot of 1183*c917796cSXin LI# classes, structs, unions or interfaces. 1184*c917796cSXin LI# The default value is: YES. 1185*c917796cSXin LI 1186*c917796cSXin LIALPHABETICAL_INDEX = NO 1187*c917796cSXin LI 1188*c917796cSXin LI# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) 1189*c917796cSXin LI# that should be ignored while generating the index headers. The IGNORE_PREFIX 1190*c917796cSXin LI# tag works for classes, function and member names. The entity will be placed in 1191*c917796cSXin LI# the alphabetical list under the first letter of the entity name that remains 1192*c917796cSXin LI# after removing the prefix. 1193*c917796cSXin LI# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1194*c917796cSXin LI 1195*c917796cSXin LIIGNORE_PREFIX = 1196*c917796cSXin LI 1197*c917796cSXin LI#--------------------------------------------------------------------------- 1198*c917796cSXin LI# Configuration options related to the HTML output 1199*c917796cSXin LI#--------------------------------------------------------------------------- 1200*c917796cSXin LI 1201*c917796cSXin LI# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1202*c917796cSXin LI# The default value is: YES. 1203*c917796cSXin LI 1204*c917796cSXin LIGENERATE_HTML = YES 1205*c917796cSXin LI 1206*c917796cSXin LI# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1207*c917796cSXin LI# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1208*c917796cSXin LI# it. 1209*c917796cSXin LI# The default directory is: html. 1210*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1211*c917796cSXin LI 1212*c917796cSXin LIHTML_OUTPUT = api 1213*c917796cSXin LI 1214*c917796cSXin LI# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1215*c917796cSXin LI# generated HTML page (for example: .htm, .php, .asp). 1216*c917796cSXin LI# The default value is: .html. 1217*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1218*c917796cSXin LI 1219*c917796cSXin LIHTML_FILE_EXTENSION = .html 1220*c917796cSXin LI 1221*c917796cSXin LI# The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1222*c917796cSXin LI# each generated HTML page. If the tag is left blank doxygen will generate a 1223*c917796cSXin LI# standard header. 1224*c917796cSXin LI# 1225*c917796cSXin LI# To get valid HTML the header file that includes any scripts and style sheets 1226*c917796cSXin LI# that doxygen needs, which is dependent on the configuration options used (e.g. 1227*c917796cSXin LI# the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1228*c917796cSXin LI# default header using 1229*c917796cSXin LI# doxygen -w html new_header.html new_footer.html new_stylesheet.css 1230*c917796cSXin LI# YourConfigFile 1231*c917796cSXin LI# and then modify the file new_header.html. See also section "Doxygen usage" 1232*c917796cSXin LI# for information on how to generate the default header that doxygen normally 1233*c917796cSXin LI# uses. 1234*c917796cSXin LI# Note: The header is subject to change so you typically have to regenerate the 1235*c917796cSXin LI# default header when upgrading to a newer version of doxygen. For a description 1236*c917796cSXin LI# of the possible markers and block names see the documentation. 1237*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1238*c917796cSXin LI 1239*c917796cSXin LIHTML_HEADER = 1240*c917796cSXin LI 1241*c917796cSXin LI# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1242*c917796cSXin LI# generated HTML page. If the tag is left blank doxygen will generate a standard 1243*c917796cSXin LI# footer. See HTML_HEADER for more information on how to generate a default 1244*c917796cSXin LI# footer and what special commands can be used inside the footer. See also 1245*c917796cSXin LI# section "Doxygen usage" for information on how to generate the default footer 1246*c917796cSXin LI# that doxygen normally uses. 1247*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1248*c917796cSXin LI 1249*c917796cSXin LIHTML_FOOTER = 1250*c917796cSXin LI 1251*c917796cSXin LI# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1252*c917796cSXin LI# sheet that is used by each HTML page. It can be used to fine-tune the look of 1253*c917796cSXin LI# the HTML output. If left blank doxygen will generate a default style sheet. 1254*c917796cSXin LI# See also section "Doxygen usage" for information on how to generate the style 1255*c917796cSXin LI# sheet that doxygen normally uses. 1256*c917796cSXin LI# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1257*c917796cSXin LI# it is more robust and this tag (HTML_STYLESHEET) will in the future become 1258*c917796cSXin LI# obsolete. 1259*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1260*c917796cSXin LI 1261*c917796cSXin LIHTML_STYLESHEET = 1262*c917796cSXin LI 1263*c917796cSXin LI# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1264*c917796cSXin LI# cascading style sheets that are included after the standard style sheets 1265*c917796cSXin LI# created by doxygen. Using this option one can overrule certain style aspects. 1266*c917796cSXin LI# This is preferred over using HTML_STYLESHEET since it does not replace the 1267*c917796cSXin LI# standard style sheet and is therefore more robust against future updates. 1268*c917796cSXin LI# Doxygen will copy the style sheet files to the output directory. 1269*c917796cSXin LI# Note: The order of the extra style sheet files is of importance (e.g. the last 1270*c917796cSXin LI# style sheet in the list overrules the setting of the previous ones in the 1271*c917796cSXin LI# list). 1272*c917796cSXin LI# Note: Since the styling of scrollbars can currently not be overruled in 1273*c917796cSXin LI# Webkit/Chromium, the styling will be left out of the default doxygen.css if 1274*c917796cSXin LI# one or more extra stylesheets have been specified. So if scrollbar 1275*c917796cSXin LI# customization is desired it has to be added explicitly. For an example see the 1276*c917796cSXin LI# documentation. 1277*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1278*c917796cSXin LI 1279*c917796cSXin LIHTML_EXTRA_STYLESHEET = 1280*c917796cSXin LI 1281*c917796cSXin LI# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1282*c917796cSXin LI# other source files which should be copied to the HTML output directory. Note 1283*c917796cSXin LI# that these files will be copied to the base HTML output directory. Use the 1284*c917796cSXin LI# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1285*c917796cSXin LI# files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1286*c917796cSXin LI# files will be copied as-is; there are no commands or markers available. 1287*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1288*c917796cSXin LI 1289*c917796cSXin LIHTML_EXTRA_FILES = 1290*c917796cSXin LI 1291*c917796cSXin LI# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output 1292*c917796cSXin LI# should be rendered with a dark or light theme. 1293*c917796cSXin LI# Possible values are: LIGHT always generate light mode output, DARK always 1294*c917796cSXin LI# generate dark mode output, AUTO_LIGHT automatically set the mode according to 1295*c917796cSXin LI# the user preference, use light mode if no preference is set (the default), 1296*c917796cSXin LI# AUTO_DARK automatically set the mode according to the user preference, use 1297*c917796cSXin LI# dark mode if no preference is set and TOGGLE allow to user to switch between 1298*c917796cSXin LI# light and dark mode via a button. 1299*c917796cSXin LI# The default value is: AUTO_LIGHT. 1300*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1301*c917796cSXin LI 1302*c917796cSXin LIHTML_COLORSTYLE = AUTO_LIGHT 1303*c917796cSXin LI 1304*c917796cSXin LI# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1305*c917796cSXin LI# will adjust the colors in the style sheet and background images according to 1306*c917796cSXin LI# this color. Hue is specified as an angle on a color-wheel, see 1307*c917796cSXin LI# https://en.wikipedia.org/wiki/Hue for more information. For instance the value 1308*c917796cSXin LI# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1309*c917796cSXin LI# purple, and 360 is red again. 1310*c917796cSXin LI# Minimum value: 0, maximum value: 359, default value: 220. 1311*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1312*c917796cSXin LI 1313*c917796cSXin LIHTML_COLORSTYLE_HUE = 210 1314*c917796cSXin LI 1315*c917796cSXin LI# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1316*c917796cSXin LI# in the HTML output. For a value of 0 the output will use gray-scales only. A 1317*c917796cSXin LI# value of 255 will produce the most vivid colors. 1318*c917796cSXin LI# Minimum value: 0, maximum value: 255, default value: 100. 1319*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1320*c917796cSXin LI 1321*c917796cSXin LIHTML_COLORSTYLE_SAT = 180 1322*c917796cSXin LI 1323*c917796cSXin LI# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1324*c917796cSXin LI# luminance component of the colors in the HTML output. Values below 100 1325*c917796cSXin LI# gradually make the output lighter, whereas values above 100 make the output 1326*c917796cSXin LI# darker. The value divided by 100 is the actual gamma applied, so 80 represents 1327*c917796cSXin LI# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1328*c917796cSXin LI# change the gamma. 1329*c917796cSXin LI# Minimum value: 40, maximum value: 240, default value: 80. 1330*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1331*c917796cSXin LI 1332*c917796cSXin LIHTML_COLORSTYLE_GAMMA = 110 1333*c917796cSXin LI 1334*c917796cSXin LI# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1335*c917796cSXin LI# page will contain the date and time when the page was generated. Setting this 1336*c917796cSXin LI# to YES can help to show when doxygen was last run and thus if the 1337*c917796cSXin LI# documentation is up to date. 1338*c917796cSXin LI# The default value is: NO. 1339*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1340*c917796cSXin LI 1341*c917796cSXin LIHTML_TIMESTAMP = NO 1342*c917796cSXin LI 1343*c917796cSXin LI# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML 1344*c917796cSXin LI# documentation will contain a main index with vertical navigation menus that 1345*c917796cSXin LI# are dynamically created via JavaScript. If disabled, the navigation index will 1346*c917796cSXin LI# consists of multiple levels of tabs that are statically embedded in every HTML 1347*c917796cSXin LI# page. Disable this option to support browsers that do not have JavaScript, 1348*c917796cSXin LI# like the Qt help browser. 1349*c917796cSXin LI# The default value is: YES. 1350*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1351*c917796cSXin LI 1352*c917796cSXin LIHTML_DYNAMIC_MENUS = NO 1353*c917796cSXin LI 1354*c917796cSXin LI# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1355*c917796cSXin LI# documentation will contain sections that can be hidden and shown after the 1356*c917796cSXin LI# page has loaded. 1357*c917796cSXin LI# The default value is: NO. 1358*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1359*c917796cSXin LI 1360*c917796cSXin LIHTML_DYNAMIC_SECTIONS = NO 1361*c917796cSXin LI 1362*c917796cSXin LI# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1363*c917796cSXin LI# shown in the various tree structured indices initially; the user can expand 1364*c917796cSXin LI# and collapse entries dynamically later on. Doxygen will expand the tree to 1365*c917796cSXin LI# such a level that at most the specified number of entries are visible (unless 1366*c917796cSXin LI# a fully collapsed tree already exceeds this amount). So setting the number of 1367*c917796cSXin LI# entries 1 will produce a full collapsed tree by default. 0 is a special value 1368*c917796cSXin LI# representing an infinite number of entries and will result in a full expanded 1369*c917796cSXin LI# tree by default. 1370*c917796cSXin LI# Minimum value: 0, maximum value: 9999, default value: 100. 1371*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1372*c917796cSXin LI 1373*c917796cSXin LIHTML_INDEX_NUM_ENTRIES = 100 1374*c917796cSXin LI 1375*c917796cSXin LI# If the GENERATE_DOCSET tag is set to YES, additional index files will be 1376*c917796cSXin LI# generated that can be used as input for Apple's Xcode 3 integrated development 1377*c917796cSXin LI# environment (see: 1378*c917796cSXin LI# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To 1379*c917796cSXin LI# create a documentation set, doxygen will generate a Makefile in the HTML 1380*c917796cSXin LI# output directory. Running make will produce the docset in that directory and 1381*c917796cSXin LI# running make install will install the docset in 1382*c917796cSXin LI# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1383*c917796cSXin LI# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy 1384*c917796cSXin LI# genXcode/_index.html for more information. 1385*c917796cSXin LI# The default value is: NO. 1386*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1387*c917796cSXin LI 1388*c917796cSXin LIGENERATE_DOCSET = NO 1389*c917796cSXin LI 1390*c917796cSXin LI# This tag determines the name of the docset feed. A documentation feed provides 1391*c917796cSXin LI# an umbrella under which multiple documentation sets from a single provider 1392*c917796cSXin LI# (such as a company or product suite) can be grouped. 1393*c917796cSXin LI# The default value is: Doxygen generated docs. 1394*c917796cSXin LI# This tag requires that the tag GENERATE_DOCSET is set to YES. 1395*c917796cSXin LI 1396*c917796cSXin LIDOCSET_FEEDNAME = "Doxygen generated docs" 1397*c917796cSXin LI 1398*c917796cSXin LI# This tag determines the URL of the docset feed. A documentation feed provides 1399*c917796cSXin LI# an umbrella under which multiple documentation sets from a single provider 1400*c917796cSXin LI# (such as a company or product suite) can be grouped. 1401*c917796cSXin LI# This tag requires that the tag GENERATE_DOCSET is set to YES. 1402*c917796cSXin LI 1403*c917796cSXin LIDOCSET_FEEDURL = 1404*c917796cSXin LI 1405*c917796cSXin LI# This tag specifies a string that should uniquely identify the documentation 1406*c917796cSXin LI# set bundle. This should be a reverse domain-name style string, e.g. 1407*c917796cSXin LI# com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1408*c917796cSXin LI# The default value is: org.doxygen.Project. 1409*c917796cSXin LI# This tag requires that the tag GENERATE_DOCSET is set to YES. 1410*c917796cSXin LI 1411*c917796cSXin LIDOCSET_BUNDLE_ID = org.doxygen.Project 1412*c917796cSXin LI 1413*c917796cSXin LI# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1414*c917796cSXin LI# the documentation publisher. This should be a reverse domain-name style 1415*c917796cSXin LI# string, e.g. com.mycompany.MyDocSet.documentation. 1416*c917796cSXin LI# The default value is: org.doxygen.Publisher. 1417*c917796cSXin LI# This tag requires that the tag GENERATE_DOCSET is set to YES. 1418*c917796cSXin LI 1419*c917796cSXin LIDOCSET_PUBLISHER_ID = org.doxygen.Publisher 1420*c917796cSXin LI 1421*c917796cSXin LI# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1422*c917796cSXin LI# The default value is: Publisher. 1423*c917796cSXin LI# This tag requires that the tag GENERATE_DOCSET is set to YES. 1424*c917796cSXin LI 1425*c917796cSXin LIDOCSET_PUBLISHER_NAME = Publisher 1426*c917796cSXin LI 1427*c917796cSXin LI# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1428*c917796cSXin LI# additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1429*c917796cSXin LI# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1430*c917796cSXin LI# on Windows. In the beginning of 2021 Microsoft took the original page, with 1431*c917796cSXin LI# a.o. the download links, offline the HTML help workshop was already many years 1432*c917796cSXin LI# in maintenance mode). You can download the HTML help workshop from the web 1433*c917796cSXin LI# archives at Installation executable (see: 1434*c917796cSXin LI# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo 1435*c917796cSXin LI# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). 1436*c917796cSXin LI# 1437*c917796cSXin LI# The HTML Help Workshop contains a compiler that can convert all HTML output 1438*c917796cSXin LI# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1439*c917796cSXin LI# files are now used as the Windows 98 help format, and will replace the old 1440*c917796cSXin LI# Windows help format (.hlp) on all Windows platforms in the future. Compressed 1441*c917796cSXin LI# HTML files also contain an index, a table of contents, and you can search for 1442*c917796cSXin LI# words in the documentation. The HTML workshop also contains a viewer for 1443*c917796cSXin LI# compressed HTML files. 1444*c917796cSXin LI# The default value is: NO. 1445*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1446*c917796cSXin LI 1447*c917796cSXin LIGENERATE_HTMLHELP = NO 1448*c917796cSXin LI 1449*c917796cSXin LI# The CHM_FILE tag can be used to specify the file name of the resulting .chm 1450*c917796cSXin LI# file. You can add a path in front of the file if the result should not be 1451*c917796cSXin LI# written to the html output directory. 1452*c917796cSXin LI# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1453*c917796cSXin LI 1454*c917796cSXin LICHM_FILE = 1455*c917796cSXin LI 1456*c917796cSXin LI# The HHC_LOCATION tag can be used to specify the location (absolute path 1457*c917796cSXin LI# including file name) of the HTML help compiler (hhc.exe). If non-empty, 1458*c917796cSXin LI# doxygen will try to run the HTML help compiler on the generated index.hhp. 1459*c917796cSXin LI# The file has to be specified with full path. 1460*c917796cSXin LI# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1461*c917796cSXin LI 1462*c917796cSXin LIHHC_LOCATION = 1463*c917796cSXin LI 1464*c917796cSXin LI# The GENERATE_CHI flag controls if a separate .chi index file is generated 1465*c917796cSXin LI# (YES) or that it should be included in the main .chm file (NO). 1466*c917796cSXin LI# The default value is: NO. 1467*c917796cSXin LI# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1468*c917796cSXin LI 1469*c917796cSXin LIGENERATE_CHI = NO 1470*c917796cSXin LI 1471*c917796cSXin LI# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1472*c917796cSXin LI# and project file content. 1473*c917796cSXin LI# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1474*c917796cSXin LI 1475*c917796cSXin LICHM_INDEX_ENCODING = 1476*c917796cSXin LI 1477*c917796cSXin LI# The BINARY_TOC flag controls whether a binary table of contents is generated 1478*c917796cSXin LI# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1479*c917796cSXin LI# enables the Previous and Next buttons. 1480*c917796cSXin LI# The default value is: NO. 1481*c917796cSXin LI# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1482*c917796cSXin LI 1483*c917796cSXin LIBINARY_TOC = NO 1484*c917796cSXin LI 1485*c917796cSXin LI# The TOC_EXPAND flag can be set to YES to add extra items for group members to 1486*c917796cSXin LI# the table of contents of the HTML help documentation and to the tree view. 1487*c917796cSXin LI# The default value is: NO. 1488*c917796cSXin LI# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1489*c917796cSXin LI 1490*c917796cSXin LITOC_EXPAND = NO 1491*c917796cSXin LI 1492*c917796cSXin LI# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1493*c917796cSXin LI# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1494*c917796cSXin LI# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1495*c917796cSXin LI# (.qch) of the generated HTML documentation. 1496*c917796cSXin LI# The default value is: NO. 1497*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1498*c917796cSXin LI 1499*c917796cSXin LIGENERATE_QHP = NO 1500*c917796cSXin LI 1501*c917796cSXin LI# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1502*c917796cSXin LI# the file name of the resulting .qch file. The path specified is relative to 1503*c917796cSXin LI# the HTML output folder. 1504*c917796cSXin LI# This tag requires that the tag GENERATE_QHP is set to YES. 1505*c917796cSXin LI 1506*c917796cSXin LIQCH_FILE = 1507*c917796cSXin LI 1508*c917796cSXin LI# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1509*c917796cSXin LI# Project output. For more information please see Qt Help Project / Namespace 1510*c917796cSXin LI# (see: 1511*c917796cSXin LI# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). 1512*c917796cSXin LI# The default value is: org.doxygen.Project. 1513*c917796cSXin LI# This tag requires that the tag GENERATE_QHP is set to YES. 1514*c917796cSXin LI 1515*c917796cSXin LIQHP_NAMESPACE = org.doxygen.Project 1516*c917796cSXin LI 1517*c917796cSXin LI# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1518*c917796cSXin LI# Help Project output. For more information please see Qt Help Project / Virtual 1519*c917796cSXin LI# Folders (see: 1520*c917796cSXin LI# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). 1521*c917796cSXin LI# The default value is: doc. 1522*c917796cSXin LI# This tag requires that the tag GENERATE_QHP is set to YES. 1523*c917796cSXin LI 1524*c917796cSXin LIQHP_VIRTUAL_FOLDER = doc 1525*c917796cSXin LI 1526*c917796cSXin LI# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1527*c917796cSXin LI# filter to add. For more information please see Qt Help Project / Custom 1528*c917796cSXin LI# Filters (see: 1529*c917796cSXin LI# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). 1530*c917796cSXin LI# This tag requires that the tag GENERATE_QHP is set to YES. 1531*c917796cSXin LI 1532*c917796cSXin LIQHP_CUST_FILTER_NAME = 1533*c917796cSXin LI 1534*c917796cSXin LI# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1535*c917796cSXin LI# custom filter to add. For more information please see Qt Help Project / Custom 1536*c917796cSXin LI# Filters (see: 1537*c917796cSXin LI# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). 1538*c917796cSXin LI# This tag requires that the tag GENERATE_QHP is set to YES. 1539*c917796cSXin LI 1540*c917796cSXin LIQHP_CUST_FILTER_ATTRS = 1541*c917796cSXin LI 1542*c917796cSXin LI# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1543*c917796cSXin LI# project's filter section matches. Qt Help Project / Filter Attributes (see: 1544*c917796cSXin LI# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). 1545*c917796cSXin LI# This tag requires that the tag GENERATE_QHP is set to YES. 1546*c917796cSXin LI 1547*c917796cSXin LIQHP_SECT_FILTER_ATTRS = 1548*c917796cSXin LI 1549*c917796cSXin LI# The QHG_LOCATION tag can be used to specify the location (absolute path 1550*c917796cSXin LI# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to 1551*c917796cSXin LI# run qhelpgenerator on the generated .qhp file. 1552*c917796cSXin LI# This tag requires that the tag GENERATE_QHP is set to YES. 1553*c917796cSXin LI 1554*c917796cSXin LIQHG_LOCATION = 1555*c917796cSXin LI 1556*c917796cSXin LI# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1557*c917796cSXin LI# generated, together with the HTML files, they form an Eclipse help plugin. To 1558*c917796cSXin LI# install this plugin and make it available under the help contents menu in 1559*c917796cSXin LI# Eclipse, the contents of the directory containing the HTML and XML files needs 1560*c917796cSXin LI# to be copied into the plugins directory of eclipse. The name of the directory 1561*c917796cSXin LI# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1562*c917796cSXin LI# After copying Eclipse needs to be restarted before the help appears. 1563*c917796cSXin LI# The default value is: NO. 1564*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1565*c917796cSXin LI 1566*c917796cSXin LIGENERATE_ECLIPSEHELP = NO 1567*c917796cSXin LI 1568*c917796cSXin LI# A unique identifier for the Eclipse help plugin. When installing the plugin 1569*c917796cSXin LI# the directory name containing the HTML and XML files should also have this 1570*c917796cSXin LI# name. Each documentation set should have its own identifier. 1571*c917796cSXin LI# The default value is: org.doxygen.Project. 1572*c917796cSXin LI# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1573*c917796cSXin LI 1574*c917796cSXin LIECLIPSE_DOC_ID = org.doxygen.Project 1575*c917796cSXin LI 1576*c917796cSXin LI# If you want full control over the layout of the generated HTML pages it might 1577*c917796cSXin LI# be necessary to disable the index and replace it with your own. The 1578*c917796cSXin LI# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1579*c917796cSXin LI# of each HTML page. A value of NO enables the index and the value YES disables 1580*c917796cSXin LI# it. Since the tabs in the index contain the same information as the navigation 1581*c917796cSXin LI# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1582*c917796cSXin LI# The default value is: NO. 1583*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1584*c917796cSXin LI 1585*c917796cSXin LIDISABLE_INDEX = NO 1586*c917796cSXin LI 1587*c917796cSXin LI# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1588*c917796cSXin LI# structure should be generated to display hierarchical information. If the tag 1589*c917796cSXin LI# value is set to YES, a side panel will be generated containing a tree-like 1590*c917796cSXin LI# index structure (just like the one that is generated for HTML Help). For this 1591*c917796cSXin LI# to work a browser that supports JavaScript, DHTML, CSS and frames is required 1592*c917796cSXin LI# (i.e. any modern browser). Windows users are probably better off using the 1593*c917796cSXin LI# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1594*c917796cSXin LI# further fine tune the look of the index (see "Fine-tuning the output"). As an 1595*c917796cSXin LI# example, the default style sheet generated by doxygen has an example that 1596*c917796cSXin LI# shows how to put an image at the root of the tree instead of the PROJECT_NAME. 1597*c917796cSXin LI# Since the tree basically has the same information as the tab index, you could 1598*c917796cSXin LI# consider setting DISABLE_INDEX to YES when enabling this option. 1599*c917796cSXin LI# The default value is: NO. 1600*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1601*c917796cSXin LI 1602*c917796cSXin LIGENERATE_TREEVIEW = NO 1603*c917796cSXin LI 1604*c917796cSXin LI# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the 1605*c917796cSXin LI# FULL_SIDEBAR option determines if the side bar is limited to only the treeview 1606*c917796cSXin LI# area (value NO) or if it should extend to the full height of the window (value 1607*c917796cSXin LI# YES). Setting this to YES gives a layout similar to 1608*c917796cSXin LI# https://docs.readthedocs.io with more room for contents, but less room for the 1609*c917796cSXin LI# project logo, title, and description. If either GENERATE_TREEVIEW or 1610*c917796cSXin LI# DISABLE_INDEX is set to NO, this option has no effect. 1611*c917796cSXin LI# The default value is: NO. 1612*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1613*c917796cSXin LI 1614*c917796cSXin LIFULL_SIDEBAR = NO 1615*c917796cSXin LI 1616*c917796cSXin LI# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1617*c917796cSXin LI# doxygen will group on one line in the generated HTML documentation. 1618*c917796cSXin LI# 1619*c917796cSXin LI# Note that a value of 0 will completely suppress the enum values from appearing 1620*c917796cSXin LI# in the overview section. 1621*c917796cSXin LI# Minimum value: 0, maximum value: 20, default value: 4. 1622*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1623*c917796cSXin LI 1624*c917796cSXin LIENUM_VALUES_PER_LINE = 4 1625*c917796cSXin LI 1626*c917796cSXin LI# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1627*c917796cSXin LI# to set the initial width (in pixels) of the frame in which the tree is shown. 1628*c917796cSXin LI# Minimum value: 0, maximum value: 1500, default value: 250. 1629*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1630*c917796cSXin LI 1631*c917796cSXin LITREEVIEW_WIDTH = 250 1632*c917796cSXin LI 1633*c917796cSXin LI# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1634*c917796cSXin LI# external symbols imported via tag files in a separate window. 1635*c917796cSXin LI# The default value is: NO. 1636*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1637*c917796cSXin LI 1638*c917796cSXin LIEXT_LINKS_IN_WINDOW = NO 1639*c917796cSXin LI 1640*c917796cSXin LI# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email 1641*c917796cSXin LI# addresses. 1642*c917796cSXin LI# The default value is: YES. 1643*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1644*c917796cSXin LI 1645*c917796cSXin LIOBFUSCATE_EMAILS = YES 1646*c917796cSXin LI 1647*c917796cSXin LI# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg 1648*c917796cSXin LI# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see 1649*c917796cSXin LI# https://inkscape.org) to generate formulas as SVG images instead of PNGs for 1650*c917796cSXin LI# the HTML output. These images will generally look nicer at scaled resolutions. 1651*c917796cSXin LI# Possible values are: png (the default) and svg (looks nicer but requires the 1652*c917796cSXin LI# pdf2svg or inkscape tool). 1653*c917796cSXin LI# The default value is: png. 1654*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1655*c917796cSXin LI 1656*c917796cSXin LIHTML_FORMULA_FORMAT = png 1657*c917796cSXin LI 1658*c917796cSXin LI# Use this tag to change the font size of LaTeX formulas included as images in 1659*c917796cSXin LI# the HTML documentation. When you change the font size after a successful 1660*c917796cSXin LI# doxygen run you need to manually remove any form_*.png images from the HTML 1661*c917796cSXin LI# output directory to force them to be regenerated. 1662*c917796cSXin LI# Minimum value: 8, maximum value: 50, default value: 10. 1663*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1664*c917796cSXin LI 1665*c917796cSXin LIFORMULA_FONTSIZE = 10 1666*c917796cSXin LI 1667*c917796cSXin LI# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands 1668*c917796cSXin LI# to create new LaTeX commands to be used in formulas as building blocks. See 1669*c917796cSXin LI# the section "Including formulas" for details. 1670*c917796cSXin LI 1671*c917796cSXin LIFORMULA_MACROFILE = 1672*c917796cSXin LI 1673*c917796cSXin LI# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1674*c917796cSXin LI# https://www.mathjax.org) which uses client side JavaScript for the rendering 1675*c917796cSXin LI# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1676*c917796cSXin LI# installed or if you want to formulas look prettier in the HTML output. When 1677*c917796cSXin LI# enabled you may also need to install MathJax separately and configure the path 1678*c917796cSXin LI# to it using the MATHJAX_RELPATH option. 1679*c917796cSXin LI# The default value is: NO. 1680*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1681*c917796cSXin LI 1682*c917796cSXin LIUSE_MATHJAX = NO 1683*c917796cSXin LI 1684*c917796cSXin LI# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. 1685*c917796cSXin LI# Note that the different versions of MathJax have different requirements with 1686*c917796cSXin LI# regards to the different settings, so it is possible that also other MathJax 1687*c917796cSXin LI# settings have to be changed when switching between the different MathJax 1688*c917796cSXin LI# versions. 1689*c917796cSXin LI# Possible values are: MathJax_2 and MathJax_3. 1690*c917796cSXin LI# The default value is: MathJax_2. 1691*c917796cSXin LI# This tag requires that the tag USE_MATHJAX is set to YES. 1692*c917796cSXin LI 1693*c917796cSXin LIMATHJAX_VERSION = MathJax_2 1694*c917796cSXin LI 1695*c917796cSXin LI# When MathJax is enabled you can set the default output format to be used for 1696*c917796cSXin LI# the MathJax output. For more details about the output format see MathJax 1697*c917796cSXin LI# version 2 (see: 1698*c917796cSXin LI# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 1699*c917796cSXin LI# (see: 1700*c917796cSXin LI# http://docs.mathjax.org/en/latest/web/components/output.html). 1701*c917796cSXin LI# Possible values are: HTML-CSS (which is slower, but has the best 1702*c917796cSXin LI# compatibility. This is the name for Mathjax version 2, for MathJax version 3 1703*c917796cSXin LI# this will be translated into chtml), NativeMML (i.e. MathML. Only supported 1704*c917796cSXin LI# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This 1705*c917796cSXin LI# is the name for Mathjax version 3, for MathJax version 2 this will be 1706*c917796cSXin LI# translated into HTML-CSS) and SVG. 1707*c917796cSXin LI# The default value is: HTML-CSS. 1708*c917796cSXin LI# This tag requires that the tag USE_MATHJAX is set to YES. 1709*c917796cSXin LI 1710*c917796cSXin LIMATHJAX_FORMAT = HTML-CSS 1711*c917796cSXin LI 1712*c917796cSXin LI# When MathJax is enabled you need to specify the location relative to the HTML 1713*c917796cSXin LI# output directory using the MATHJAX_RELPATH option. The destination directory 1714*c917796cSXin LI# should contain the MathJax.js script. For instance, if the mathjax directory 1715*c917796cSXin LI# is located at the same level as the HTML output directory, then 1716*c917796cSXin LI# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1717*c917796cSXin LI# Content Delivery Network so you can quickly see the result without installing 1718*c917796cSXin LI# MathJax. However, it is strongly recommended to install a local copy of 1719*c917796cSXin LI# MathJax from https://www.mathjax.org before deployment. The default value is: 1720*c917796cSXin LI# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 1721*c917796cSXin LI# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 1722*c917796cSXin LI# This tag requires that the tag USE_MATHJAX is set to YES. 1723*c917796cSXin LI 1724*c917796cSXin LIMATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/ 1725*c917796cSXin LI 1726*c917796cSXin LI# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1727*c917796cSXin LI# extension names that should be enabled during MathJax rendering. For example 1728*c917796cSXin LI# for MathJax version 2 (see 1729*c917796cSXin LI# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): 1730*c917796cSXin LI# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1731*c917796cSXin LI# For example for MathJax version 3 (see 1732*c917796cSXin LI# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): 1733*c917796cSXin LI# MATHJAX_EXTENSIONS = ams 1734*c917796cSXin LI# This tag requires that the tag USE_MATHJAX is set to YES. 1735*c917796cSXin LI 1736*c917796cSXin LIMATHJAX_EXTENSIONS = 1737*c917796cSXin LI 1738*c917796cSXin LI# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1739*c917796cSXin LI# of code that will be used on startup of the MathJax code. See the MathJax site 1740*c917796cSXin LI# (see: 1741*c917796cSXin LI# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an 1742*c917796cSXin LI# example see the documentation. 1743*c917796cSXin LI# This tag requires that the tag USE_MATHJAX is set to YES. 1744*c917796cSXin LI 1745*c917796cSXin LIMATHJAX_CODEFILE = 1746*c917796cSXin LI 1747*c917796cSXin LI# When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1748*c917796cSXin LI# the HTML output. The underlying search engine uses javascript and DHTML and 1749*c917796cSXin LI# should work on any modern browser. Note that when using HTML help 1750*c917796cSXin LI# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1751*c917796cSXin LI# there is already a search function so this one should typically be disabled. 1752*c917796cSXin LI# For large projects the javascript based search engine can be slow, then 1753*c917796cSXin LI# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1754*c917796cSXin LI# search using the keyboard; to jump to the search box use <access key> + S 1755*c917796cSXin LI# (what the <access key> is depends on the OS and browser, but it is typically 1756*c917796cSXin LI# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down 1757*c917796cSXin LI# key> to jump into the search results window, the results can be navigated 1758*c917796cSXin LI# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel 1759*c917796cSXin LI# the search. The filter options can be selected when the cursor is inside the 1760*c917796cSXin LI# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> 1761*c917796cSXin LI# to select a filter and <Enter> or <escape> to activate or cancel the filter 1762*c917796cSXin LI# option. 1763*c917796cSXin LI# The default value is: YES. 1764*c917796cSXin LI# This tag requires that the tag GENERATE_HTML is set to YES. 1765*c917796cSXin LI 1766*c917796cSXin LISEARCHENGINE = NO 1767*c917796cSXin LI 1768*c917796cSXin LI# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1769*c917796cSXin LI# implemented using a web server instead of a web client using JavaScript. There 1770*c917796cSXin LI# are two flavors of web server based searching depending on the EXTERNAL_SEARCH 1771*c917796cSXin LI# setting. When disabled, doxygen will generate a PHP script for searching and 1772*c917796cSXin LI# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing 1773*c917796cSXin LI# and searching needs to be provided by external tools. See the section 1774*c917796cSXin LI# "External Indexing and Searching" for details. 1775*c917796cSXin LI# The default value is: NO. 1776*c917796cSXin LI# This tag requires that the tag SEARCHENGINE is set to YES. 1777*c917796cSXin LI 1778*c917796cSXin LISERVER_BASED_SEARCH = NO 1779*c917796cSXin LI 1780*c917796cSXin LI# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP 1781*c917796cSXin LI# script for searching. Instead the search results are written to an XML file 1782*c917796cSXin LI# which needs to be processed by an external indexer. Doxygen will invoke an 1783*c917796cSXin LI# external search engine pointed to by the SEARCHENGINE_URL option to obtain the 1784*c917796cSXin LI# search results. 1785*c917796cSXin LI# 1786*c917796cSXin LI# Doxygen ships with an example indexer (doxyindexer) and search engine 1787*c917796cSXin LI# (doxysearch.cgi) which are based on the open source search engine library 1788*c917796cSXin LI# Xapian (see: 1789*c917796cSXin LI# https://xapian.org/). 1790*c917796cSXin LI# 1791*c917796cSXin LI# See the section "External Indexing and Searching" for details. 1792*c917796cSXin LI# The default value is: NO. 1793*c917796cSXin LI# This tag requires that the tag SEARCHENGINE is set to YES. 1794*c917796cSXin LI 1795*c917796cSXin LIEXTERNAL_SEARCH = NO 1796*c917796cSXin LI 1797*c917796cSXin LI# The SEARCHENGINE_URL should point to a search engine hosted by a web server 1798*c917796cSXin LI# which will return the search results when EXTERNAL_SEARCH is enabled. 1799*c917796cSXin LI# 1800*c917796cSXin LI# Doxygen ships with an example indexer (doxyindexer) and search engine 1801*c917796cSXin LI# (doxysearch.cgi) which are based on the open source search engine library 1802*c917796cSXin LI# Xapian (see: 1803*c917796cSXin LI# https://xapian.org/). See the section "External Indexing and Searching" for 1804*c917796cSXin LI# details. 1805*c917796cSXin LI# This tag requires that the tag SEARCHENGINE is set to YES. 1806*c917796cSXin LI 1807*c917796cSXin LISEARCHENGINE_URL = 1808*c917796cSXin LI 1809*c917796cSXin LI# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed 1810*c917796cSXin LI# search data is written to a file for indexing by an external tool. With the 1811*c917796cSXin LI# SEARCHDATA_FILE tag the name of this file can be specified. 1812*c917796cSXin LI# The default file is: searchdata.xml. 1813*c917796cSXin LI# This tag requires that the tag SEARCHENGINE is set to YES. 1814*c917796cSXin LI 1815*c917796cSXin LISEARCHDATA_FILE = searchdata.xml 1816*c917796cSXin LI 1817*c917796cSXin LI# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the 1818*c917796cSXin LI# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is 1819*c917796cSXin LI# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple 1820*c917796cSXin LI# projects and redirect the results back to the right project. 1821*c917796cSXin LI# This tag requires that the tag SEARCHENGINE is set to YES. 1822*c917796cSXin LI 1823*c917796cSXin LIEXTERNAL_SEARCH_ID = 1824*c917796cSXin LI 1825*c917796cSXin LI# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen 1826*c917796cSXin LI# projects other than the one defined by this configuration file, but that are 1827*c917796cSXin LI# all added to the same external search index. Each project needs to have a 1828*c917796cSXin LI# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of 1829*c917796cSXin LI# to a relative location where the documentation can be found. The format is: 1830*c917796cSXin LI# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... 1831*c917796cSXin LI# This tag requires that the tag SEARCHENGINE is set to YES. 1832*c917796cSXin LI 1833*c917796cSXin LIEXTRA_SEARCH_MAPPINGS = 1834*c917796cSXin LI 1835*c917796cSXin LI#--------------------------------------------------------------------------- 1836*c917796cSXin LI# Configuration options related to the LaTeX output 1837*c917796cSXin LI#--------------------------------------------------------------------------- 1838*c917796cSXin LI 1839*c917796cSXin LI# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. 1840*c917796cSXin LI# The default value is: YES. 1841*c917796cSXin LI 1842*c917796cSXin LIGENERATE_LATEX = NO 1843*c917796cSXin LI 1844*c917796cSXin LI# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a 1845*c917796cSXin LI# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1846*c917796cSXin LI# it. 1847*c917796cSXin LI# The default directory is: latex. 1848*c917796cSXin LI# This tag requires that the tag GENERATE_LATEX is set to YES. 1849*c917796cSXin LI 1850*c917796cSXin LILATEX_OUTPUT = latex 1851*c917796cSXin LI 1852*c917796cSXin LI# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1853*c917796cSXin LI# invoked. 1854*c917796cSXin LI# 1855*c917796cSXin LI# Note that when not enabling USE_PDFLATEX the default is latex when enabling 1856*c917796cSXin LI# USE_PDFLATEX the default is pdflatex and when in the later case latex is 1857*c917796cSXin LI# chosen this is overwritten by pdflatex. For specific output languages the 1858*c917796cSXin LI# default can have been set differently, this depends on the implementation of 1859*c917796cSXin LI# the output language. 1860*c917796cSXin LI# This tag requires that the tag GENERATE_LATEX is set to YES. 1861*c917796cSXin LI 1862*c917796cSXin LILATEX_CMD_NAME = latex 1863*c917796cSXin LI 1864*c917796cSXin LI# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate 1865*c917796cSXin LI# index for LaTeX. 1866*c917796cSXin LI# Note: This tag is used in the Makefile / make.bat. 1867*c917796cSXin LI# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file 1868*c917796cSXin LI# (.tex). 1869*c917796cSXin LI# The default file is: makeindex. 1870*c917796cSXin LI# This tag requires that the tag GENERATE_LATEX is set to YES. 1871*c917796cSXin LI 1872*c917796cSXin LIMAKEINDEX_CMD_NAME = makeindex 1873*c917796cSXin LI 1874*c917796cSXin LI# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to 1875*c917796cSXin LI# generate index for LaTeX. In case there is no backslash (\) as first character 1876*c917796cSXin LI# it will be automatically added in the LaTeX code. 1877*c917796cSXin LI# Note: This tag is used in the generated output file (.tex). 1878*c917796cSXin LI# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat. 1879*c917796cSXin LI# The default value is: makeindex. 1880*c917796cSXin LI# This tag requires that the tag GENERATE_LATEX is set to YES. 1881*c917796cSXin LI 1882*c917796cSXin LILATEX_MAKEINDEX_CMD = makeindex 1883*c917796cSXin LI 1884*c917796cSXin LI# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX 1885*c917796cSXin LI# documents. This may be useful for small projects and may help to save some 1886*c917796cSXin LI# trees in general. 1887*c917796cSXin LI# The default value is: NO. 1888*c917796cSXin LI# This tag requires that the tag GENERATE_LATEX is set to YES. 1889*c917796cSXin LI 1890*c917796cSXin LICOMPACT_LATEX = NO 1891*c917796cSXin LI 1892*c917796cSXin LI# The PAPER_TYPE tag can be used to set the paper type that is used by the 1893*c917796cSXin LI# printer. 1894*c917796cSXin LI# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x 1895*c917796cSXin LI# 14 inches) and executive (7.25 x 10.5 inches). 1896*c917796cSXin LI# The default value is: a4. 1897*c917796cSXin LI# This tag requires that the tag GENERATE_LATEX is set to YES. 1898*c917796cSXin LI 1899*c917796cSXin LIPAPER_TYPE = a4 1900*c917796cSXin LI 1901*c917796cSXin LI# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names 1902*c917796cSXin LI# that should be included in the LaTeX output. The package can be specified just 1903*c917796cSXin LI# by its name or with the correct syntax as to be used with the LaTeX 1904*c917796cSXin LI# \usepackage command. To get the times font for instance you can specify : 1905*c917796cSXin LI# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} 1906*c917796cSXin LI# To use the option intlimits with the amsmath package you can specify: 1907*c917796cSXin LI# EXTRA_PACKAGES=[intlimits]{amsmath} 1908*c917796cSXin LI# If left blank no extra packages will be included. 1909*c917796cSXin LI# This tag requires that the tag GENERATE_LATEX is set to YES. 1910*c917796cSXin LI 1911*c917796cSXin LIEXTRA_PACKAGES = 1912*c917796cSXin LI 1913*c917796cSXin LI# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for 1914*c917796cSXin LI# the generated LaTeX document. The header should contain everything until the 1915*c917796cSXin LI# first chapter. If it is left blank doxygen will generate a standard header. It 1916*c917796cSXin LI# is highly recommended to start with a default header using 1917*c917796cSXin LI# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty 1918*c917796cSXin LI# and then modify the file new_header.tex. See also section "Doxygen usage" for 1919*c917796cSXin LI# information on how to generate the default header that doxygen normally uses. 1920*c917796cSXin LI# 1921*c917796cSXin LI# Note: Only use a user-defined header if you know what you are doing! 1922*c917796cSXin LI# Note: The header is subject to change so you typically have to regenerate the 1923*c917796cSXin LI# default header when upgrading to a newer version of doxygen. The following 1924*c917796cSXin LI# commands have a special meaning inside the header (and footer): For a 1925*c917796cSXin LI# description of the possible markers and block names see the documentation. 1926*c917796cSXin LI# This tag requires that the tag GENERATE_LATEX is set to YES. 1927*c917796cSXin LI 1928*c917796cSXin LILATEX_HEADER = 1929*c917796cSXin LI 1930*c917796cSXin LI# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for 1931*c917796cSXin LI# the generated LaTeX document. The footer should contain everything after the 1932*c917796cSXin LI# last chapter. If it is left blank doxygen will generate a standard footer. See 1933*c917796cSXin LI# LATEX_HEADER for more information on how to generate a default footer and what 1934*c917796cSXin LI# special commands can be used inside the footer. See also section "Doxygen 1935*c917796cSXin LI# usage" for information on how to generate the default footer that doxygen 1936*c917796cSXin LI# normally uses. Note: Only use a user-defined footer if you know what you are 1937*c917796cSXin LI# doing! 1938*c917796cSXin LI# This tag requires that the tag GENERATE_LATEX is set to YES. 1939*c917796cSXin LI 1940*c917796cSXin LILATEX_FOOTER = 1941*c917796cSXin LI 1942*c917796cSXin LI# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1943*c917796cSXin LI# LaTeX style sheets that are included after the standard style sheets created 1944*c917796cSXin LI# by doxygen. Using this option one can overrule certain style aspects. Doxygen 1945*c917796cSXin LI# will copy the style sheet files to the output directory. 1946*c917796cSXin LI# Note: The order of the extra style sheet files is of importance (e.g. the last 1947*c917796cSXin LI# style sheet in the list overrules the setting of the previous ones in the 1948*c917796cSXin LI# list). 1949*c917796cSXin LI# This tag requires that the tag GENERATE_LATEX is set to YES. 1950*c917796cSXin LI 1951*c917796cSXin LILATEX_EXTRA_STYLESHEET = 1952*c917796cSXin LI 1953*c917796cSXin LI# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or 1954*c917796cSXin LI# other source files which should be copied to the LATEX_OUTPUT output 1955*c917796cSXin LI# directory. Note that the files will be copied as-is; there are no commands or 1956*c917796cSXin LI# markers available. 1957*c917796cSXin LI# This tag requires that the tag GENERATE_LATEX is set to YES. 1958*c917796cSXin LI 1959*c917796cSXin LILATEX_EXTRA_FILES = 1960*c917796cSXin LI 1961*c917796cSXin LI# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is 1962*c917796cSXin LI# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will 1963*c917796cSXin LI# contain links (just like the HTML output) instead of page references. This 1964*c917796cSXin LI# makes the output suitable for online browsing using a PDF viewer. 1965*c917796cSXin LI# The default value is: YES. 1966*c917796cSXin LI# This tag requires that the tag GENERATE_LATEX is set to YES. 1967*c917796cSXin LI 1968*c917796cSXin LIPDF_HYPERLINKS = NO 1969*c917796cSXin LI 1970*c917796cSXin LI# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as 1971*c917796cSXin LI# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX 1972*c917796cSXin LI# files. Set this option to YES, to get a higher quality PDF documentation. 1973*c917796cSXin LI# 1974*c917796cSXin LI# See also section LATEX_CMD_NAME for selecting the engine. 1975*c917796cSXin LI# The default value is: YES. 1976*c917796cSXin LI# This tag requires that the tag GENERATE_LATEX is set to YES. 1977*c917796cSXin LI 1978*c917796cSXin LIUSE_PDFLATEX = YES 1979*c917796cSXin LI 1980*c917796cSXin LI# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode 1981*c917796cSXin LI# command to the generated LaTeX files. This will instruct LaTeX to keep running 1982*c917796cSXin LI# if errors occur, instead of asking the user for help. 1983*c917796cSXin LI# The default value is: NO. 1984*c917796cSXin LI# This tag requires that the tag GENERATE_LATEX is set to YES. 1985*c917796cSXin LI 1986*c917796cSXin LILATEX_BATCHMODE = NO 1987*c917796cSXin LI 1988*c917796cSXin LI# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the 1989*c917796cSXin LI# index chapters (such as File Index, Compound Index, etc.) in the output. 1990*c917796cSXin LI# The default value is: NO. 1991*c917796cSXin LI# This tag requires that the tag GENERATE_LATEX is set to YES. 1992*c917796cSXin LI 1993*c917796cSXin LILATEX_HIDE_INDICES = NO 1994*c917796cSXin LI 1995*c917796cSXin LI# The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1996*c917796cSXin LI# bibliography, e.g. plainnat, or ieeetr. See 1997*c917796cSXin LI# https://en.wikipedia.org/wiki/BibTeX and \cite for more info. 1998*c917796cSXin LI# The default value is: plain. 1999*c917796cSXin LI# This tag requires that the tag GENERATE_LATEX is set to YES. 2000*c917796cSXin LI 2001*c917796cSXin LILATEX_BIB_STYLE = plain 2002*c917796cSXin LI 2003*c917796cSXin LI# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated 2004*c917796cSXin LI# page will contain the date and time when the page was generated. Setting this 2005*c917796cSXin LI# to NO can help when comparing the output of multiple runs. 2006*c917796cSXin LI# The default value is: NO. 2007*c917796cSXin LI# This tag requires that the tag GENERATE_LATEX is set to YES. 2008*c917796cSXin LI 2009*c917796cSXin LILATEX_TIMESTAMP = NO 2010*c917796cSXin LI 2011*c917796cSXin LI# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) 2012*c917796cSXin LI# path from which the emoji images will be read. If a relative path is entered, 2013*c917796cSXin LI# it will be relative to the LATEX_OUTPUT directory. If left blank the 2014*c917796cSXin LI# LATEX_OUTPUT directory will be used. 2015*c917796cSXin LI# This tag requires that the tag GENERATE_LATEX is set to YES. 2016*c917796cSXin LI 2017*c917796cSXin LILATEX_EMOJI_DIRECTORY = 2018*c917796cSXin LI 2019*c917796cSXin LI#--------------------------------------------------------------------------- 2020*c917796cSXin LI# Configuration options related to the RTF output 2021*c917796cSXin LI#--------------------------------------------------------------------------- 2022*c917796cSXin LI 2023*c917796cSXin LI# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The 2024*c917796cSXin LI# RTF output is optimized for Word 97 and may not look too pretty with other RTF 2025*c917796cSXin LI# readers/editors. 2026*c917796cSXin LI# The default value is: NO. 2027*c917796cSXin LI 2028*c917796cSXin LIGENERATE_RTF = NO 2029*c917796cSXin LI 2030*c917796cSXin LI# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a 2031*c917796cSXin LI# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 2032*c917796cSXin LI# it. 2033*c917796cSXin LI# The default directory is: rtf. 2034*c917796cSXin LI# This tag requires that the tag GENERATE_RTF is set to YES. 2035*c917796cSXin LI 2036*c917796cSXin LIRTF_OUTPUT = rtf 2037*c917796cSXin LI 2038*c917796cSXin LI# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF 2039*c917796cSXin LI# documents. This may be useful for small projects and may help to save some 2040*c917796cSXin LI# trees in general. 2041*c917796cSXin LI# The default value is: NO. 2042*c917796cSXin LI# This tag requires that the tag GENERATE_RTF is set to YES. 2043*c917796cSXin LI 2044*c917796cSXin LICOMPACT_RTF = NO 2045*c917796cSXin LI 2046*c917796cSXin LI# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will 2047*c917796cSXin LI# contain hyperlink fields. The RTF file will contain links (just like the HTML 2048*c917796cSXin LI# output) instead of page references. This makes the output suitable for online 2049*c917796cSXin LI# browsing using Word or some other Word compatible readers that support those 2050*c917796cSXin LI# fields. 2051*c917796cSXin LI# 2052*c917796cSXin LI# Note: WordPad (write) and others do not support links. 2053*c917796cSXin LI# The default value is: NO. 2054*c917796cSXin LI# This tag requires that the tag GENERATE_RTF is set to YES. 2055*c917796cSXin LI 2056*c917796cSXin LIRTF_HYPERLINKS = NO 2057*c917796cSXin LI 2058*c917796cSXin LI# Load stylesheet definitions from file. Syntax is similar to doxygen's 2059*c917796cSXin LI# configuration file, i.e. a series of assignments. You only have to provide 2060*c917796cSXin LI# replacements, missing definitions are set to their default value. 2061*c917796cSXin LI# 2062*c917796cSXin LI# See also section "Doxygen usage" for information on how to generate the 2063*c917796cSXin LI# default style sheet that doxygen normally uses. 2064*c917796cSXin LI# This tag requires that the tag GENERATE_RTF is set to YES. 2065*c917796cSXin LI 2066*c917796cSXin LIRTF_STYLESHEET_FILE = 2067*c917796cSXin LI 2068*c917796cSXin LI# Set optional variables used in the generation of an RTF document. Syntax is 2069*c917796cSXin LI# similar to doxygen's configuration file. A template extensions file can be 2070*c917796cSXin LI# generated using doxygen -e rtf extensionFile. 2071*c917796cSXin LI# This tag requires that the tag GENERATE_RTF is set to YES. 2072*c917796cSXin LI 2073*c917796cSXin LIRTF_EXTENSIONS_FILE = 2074*c917796cSXin LI 2075*c917796cSXin LI#--------------------------------------------------------------------------- 2076*c917796cSXin LI# Configuration options related to the man page output 2077*c917796cSXin LI#--------------------------------------------------------------------------- 2078*c917796cSXin LI 2079*c917796cSXin LI# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for 2080*c917796cSXin LI# classes and files. 2081*c917796cSXin LI# The default value is: NO. 2082*c917796cSXin LI 2083*c917796cSXin LIGENERATE_MAN = NO 2084*c917796cSXin LI 2085*c917796cSXin LI# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a 2086*c917796cSXin LI# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 2087*c917796cSXin LI# it. A directory man3 will be created inside the directory specified by 2088*c917796cSXin LI# MAN_OUTPUT. 2089*c917796cSXin LI# The default directory is: man. 2090*c917796cSXin LI# This tag requires that the tag GENERATE_MAN is set to YES. 2091*c917796cSXin LI 2092*c917796cSXin LIMAN_OUTPUT = man 2093*c917796cSXin LI 2094*c917796cSXin LI# The MAN_EXTENSION tag determines the extension that is added to the generated 2095*c917796cSXin LI# man pages. In case the manual section does not start with a number, the number 2096*c917796cSXin LI# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is 2097*c917796cSXin LI# optional. 2098*c917796cSXin LI# The default value is: .3. 2099*c917796cSXin LI# This tag requires that the tag GENERATE_MAN is set to YES. 2100*c917796cSXin LI 2101*c917796cSXin LIMAN_EXTENSION = .3 2102*c917796cSXin LI 2103*c917796cSXin LI# The MAN_SUBDIR tag determines the name of the directory created within 2104*c917796cSXin LI# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by 2105*c917796cSXin LI# MAN_EXTENSION with the initial . removed. 2106*c917796cSXin LI# This tag requires that the tag GENERATE_MAN is set to YES. 2107*c917796cSXin LI 2108*c917796cSXin LIMAN_SUBDIR = 2109*c917796cSXin LI 2110*c917796cSXin LI# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it 2111*c917796cSXin LI# will generate one additional man file for each entity documented in the real 2112*c917796cSXin LI# man page(s). These additional files only source the real man page, but without 2113*c917796cSXin LI# them the man command would be unable to find the correct page. 2114*c917796cSXin LI# The default value is: NO. 2115*c917796cSXin LI# This tag requires that the tag GENERATE_MAN is set to YES. 2116*c917796cSXin LI 2117*c917796cSXin LIMAN_LINKS = NO 2118*c917796cSXin LI 2119*c917796cSXin LI#--------------------------------------------------------------------------- 2120*c917796cSXin LI# Configuration options related to the XML output 2121*c917796cSXin LI#--------------------------------------------------------------------------- 2122*c917796cSXin LI 2123*c917796cSXin LI# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that 2124*c917796cSXin LI# captures the structure of the code including all documentation. 2125*c917796cSXin LI# The default value is: NO. 2126*c917796cSXin LI 2127*c917796cSXin LIGENERATE_XML = NO 2128*c917796cSXin LI 2129*c917796cSXin LI# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a 2130*c917796cSXin LI# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 2131*c917796cSXin LI# it. 2132*c917796cSXin LI# The default directory is: xml. 2133*c917796cSXin LI# This tag requires that the tag GENERATE_XML is set to YES. 2134*c917796cSXin LI 2135*c917796cSXin LIXML_OUTPUT = xml 2136*c917796cSXin LI 2137*c917796cSXin LI# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program 2138*c917796cSXin LI# listings (including syntax highlighting and cross-referencing information) to 2139*c917796cSXin LI# the XML output. Note that enabling this will significantly increase the size 2140*c917796cSXin LI# of the XML output. 2141*c917796cSXin LI# The default value is: YES. 2142*c917796cSXin LI# This tag requires that the tag GENERATE_XML is set to YES. 2143*c917796cSXin LI 2144*c917796cSXin LIXML_PROGRAMLISTING = NO 2145*c917796cSXin LI 2146*c917796cSXin LI# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include 2147*c917796cSXin LI# namespace members in file scope as well, matching the HTML output. 2148*c917796cSXin LI# The default value is: NO. 2149*c917796cSXin LI# This tag requires that the tag GENERATE_XML is set to YES. 2150*c917796cSXin LI 2151*c917796cSXin LIXML_NS_MEMB_FILE_SCOPE = NO 2152*c917796cSXin LI 2153*c917796cSXin LI#--------------------------------------------------------------------------- 2154*c917796cSXin LI# Configuration options related to the DOCBOOK output 2155*c917796cSXin LI#--------------------------------------------------------------------------- 2156*c917796cSXin LI 2157*c917796cSXin LI# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files 2158*c917796cSXin LI# that can be used to generate PDF. 2159*c917796cSXin LI# The default value is: NO. 2160*c917796cSXin LI 2161*c917796cSXin LIGENERATE_DOCBOOK = NO 2162*c917796cSXin LI 2163*c917796cSXin LI# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. 2164*c917796cSXin LI# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in 2165*c917796cSXin LI# front of it. 2166*c917796cSXin LI# The default directory is: docbook. 2167*c917796cSXin LI# This tag requires that the tag GENERATE_DOCBOOK is set to YES. 2168*c917796cSXin LI 2169*c917796cSXin LIDOCBOOK_OUTPUT = docbook 2170*c917796cSXin LI 2171*c917796cSXin LI#--------------------------------------------------------------------------- 2172*c917796cSXin LI# Configuration options for the AutoGen Definitions output 2173*c917796cSXin LI#--------------------------------------------------------------------------- 2174*c917796cSXin LI 2175*c917796cSXin LI# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an 2176*c917796cSXin LI# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures 2177*c917796cSXin LI# the structure of the code including all documentation. Note that this feature 2178*c917796cSXin LI# is still experimental and incomplete at the moment. 2179*c917796cSXin LI# The default value is: NO. 2180*c917796cSXin LI 2181*c917796cSXin LIGENERATE_AUTOGEN_DEF = NO 2182*c917796cSXin LI 2183*c917796cSXin LI#--------------------------------------------------------------------------- 2184*c917796cSXin LI# Configuration options related to the Perl module output 2185*c917796cSXin LI#--------------------------------------------------------------------------- 2186*c917796cSXin LI 2187*c917796cSXin LI# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module 2188*c917796cSXin LI# file that captures the structure of the code including all documentation. 2189*c917796cSXin LI# 2190*c917796cSXin LI# Note that this feature is still experimental and incomplete at the moment. 2191*c917796cSXin LI# The default value is: NO. 2192*c917796cSXin LI 2193*c917796cSXin LIGENERATE_PERLMOD = NO 2194*c917796cSXin LI 2195*c917796cSXin LI# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary 2196*c917796cSXin LI# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI 2197*c917796cSXin LI# output from the Perl module output. 2198*c917796cSXin LI# The default value is: NO. 2199*c917796cSXin LI# This tag requires that the tag GENERATE_PERLMOD is set to YES. 2200*c917796cSXin LI 2201*c917796cSXin LIPERLMOD_LATEX = NO 2202*c917796cSXin LI 2203*c917796cSXin LI# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely 2204*c917796cSXin LI# formatted so it can be parsed by a human reader. This is useful if you want to 2205*c917796cSXin LI# understand what is going on. On the other hand, if this tag is set to NO, the 2206*c917796cSXin LI# size of the Perl module output will be much smaller and Perl will parse it 2207*c917796cSXin LI# just the same. 2208*c917796cSXin LI# The default value is: YES. 2209*c917796cSXin LI# This tag requires that the tag GENERATE_PERLMOD is set to YES. 2210*c917796cSXin LI 2211*c917796cSXin LIPERLMOD_PRETTY = YES 2212*c917796cSXin LI 2213*c917796cSXin LI# The names of the make variables in the generated doxyrules.make file are 2214*c917796cSXin LI# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful 2215*c917796cSXin LI# so different doxyrules.make files included by the same Makefile don't 2216*c917796cSXin LI# overwrite each other's variables. 2217*c917796cSXin LI# This tag requires that the tag GENERATE_PERLMOD is set to YES. 2218*c917796cSXin LI 2219*c917796cSXin LIPERLMOD_MAKEVAR_PREFIX = 2220*c917796cSXin LI 2221*c917796cSXin LI#--------------------------------------------------------------------------- 2222*c917796cSXin LI# Configuration options related to the preprocessor 2223*c917796cSXin LI#--------------------------------------------------------------------------- 2224*c917796cSXin LI 2225*c917796cSXin LI# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all 2226*c917796cSXin LI# C-preprocessor directives found in the sources and include files. 2227*c917796cSXin LI# The default value is: YES. 2228*c917796cSXin LI 2229*c917796cSXin LIENABLE_PREPROCESSING = YES 2230*c917796cSXin LI 2231*c917796cSXin LI# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names 2232*c917796cSXin LI# in the source code. If set to NO, only conditional compilation will be 2233*c917796cSXin LI# performed. Macro expansion can be done in a controlled way by setting 2234*c917796cSXin LI# EXPAND_ONLY_PREDEF to YES. 2235*c917796cSXin LI# The default value is: NO. 2236*c917796cSXin LI# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2237*c917796cSXin LI 2238*c917796cSXin LIMACRO_EXPANSION = YES 2239*c917796cSXin LI 2240*c917796cSXin LI# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then 2241*c917796cSXin LI# the macro expansion is limited to the macros specified with the PREDEFINED and 2242*c917796cSXin LI# EXPAND_AS_DEFINED tags. 2243*c917796cSXin LI# The default value is: NO. 2244*c917796cSXin LI# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2245*c917796cSXin LI 2246*c917796cSXin LIEXPAND_ONLY_PREDEF = YES 2247*c917796cSXin LI 2248*c917796cSXin LI# If the SEARCH_INCLUDES tag is set to YES, the include files in the 2249*c917796cSXin LI# INCLUDE_PATH will be searched if a #include is found. 2250*c917796cSXin LI# The default value is: YES. 2251*c917796cSXin LI# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2252*c917796cSXin LI 2253*c917796cSXin LISEARCH_INCLUDES = YES 2254*c917796cSXin LI 2255*c917796cSXin LI# The INCLUDE_PATH tag can be used to specify one or more directories that 2256*c917796cSXin LI# contain include files that are not input files but should be processed by the 2257*c917796cSXin LI# preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of 2258*c917796cSXin LI# RECURSIVE has no effect here. 2259*c917796cSXin LI# This tag requires that the tag SEARCH_INCLUDES is set to YES. 2260*c917796cSXin LI 2261*c917796cSXin LIINCLUDE_PATH = 2262*c917796cSXin LI 2263*c917796cSXin LI# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 2264*c917796cSXin LI# patterns (like *.h and *.hpp) to filter out the header-files in the 2265*c917796cSXin LI# directories. If left blank, the patterns specified with FILE_PATTERNS will be 2266*c917796cSXin LI# used. 2267*c917796cSXin LI# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2268*c917796cSXin LI 2269*c917796cSXin LIINCLUDE_FILE_PATTERNS = 2270*c917796cSXin LI 2271*c917796cSXin LI# The PREDEFINED tag can be used to specify one or more macro names that are 2272*c917796cSXin LI# defined before the preprocessor is started (similar to the -D option of e.g. 2273*c917796cSXin LI# gcc). The argument of the tag is a list of macros of the form: name or 2274*c917796cSXin LI# name=definition (no spaces). If the definition and the "=" are omitted, "=1" 2275*c917796cSXin LI# is assumed. To prevent a macro definition from being undefined via #undef or 2276*c917796cSXin LI# recursively expanded use the := operator instead of the = operator. 2277*c917796cSXin LI# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2278*c917796cSXin LI 2279*c917796cSXin LIPREDEFINED = LZMA_API(type)=type \ 2280*c917796cSXin LI LZMA_API_IMPORT \ 2281*c917796cSXin LI LZMA_API_CALL= 2282*c917796cSXin LI 2283*c917796cSXin LI# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this 2284*c917796cSXin LI# tag can be used to specify a list of macro names that should be expanded. The 2285*c917796cSXin LI# macro definition that is found in the sources will be used. Use the PREDEFINED 2286*c917796cSXin LI# tag if you want to use a different macro definition that overrules the 2287*c917796cSXin LI# definition found in the source code. 2288*c917796cSXin LI# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2289*c917796cSXin LI 2290*c917796cSXin LIEXPAND_AS_DEFINED = 2291*c917796cSXin LI 2292*c917796cSXin LI# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will 2293*c917796cSXin LI# remove all references to function-like macros that are alone on a line, have 2294*c917796cSXin LI# an all uppercase name, and do not end with a semicolon. Such function macros 2295*c917796cSXin LI# are typically used for boiler-plate code, and will confuse the parser if not 2296*c917796cSXin LI# removed. 2297*c917796cSXin LI# The default value is: YES. 2298*c917796cSXin LI# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2299*c917796cSXin LI 2300*c917796cSXin LISKIP_FUNCTION_MACROS = YES 2301*c917796cSXin LI 2302*c917796cSXin LI#--------------------------------------------------------------------------- 2303*c917796cSXin LI# Configuration options related to external references 2304*c917796cSXin LI#--------------------------------------------------------------------------- 2305*c917796cSXin LI 2306*c917796cSXin LI# The TAGFILES tag can be used to specify one or more tag files. For each tag 2307*c917796cSXin LI# file the location of the external documentation should be added. The format of 2308*c917796cSXin LI# a tag file without this location is as follows: 2309*c917796cSXin LI# TAGFILES = file1 file2 ... 2310*c917796cSXin LI# Adding location for the tag files is done as follows: 2311*c917796cSXin LI# TAGFILES = file1=loc1 "file2 = loc2" ... 2312*c917796cSXin LI# where loc1 and loc2 can be relative or absolute paths or URLs. See the 2313*c917796cSXin LI# section "Linking to external documentation" for more information about the use 2314*c917796cSXin LI# of tag files. 2315*c917796cSXin LI# Note: Each tag file must have a unique name (where the name does NOT include 2316*c917796cSXin LI# the path). If a tag file is not located in the directory in which doxygen is 2317*c917796cSXin LI# run, you must also specify the path to the tagfile here. 2318*c917796cSXin LI 2319*c917796cSXin LITAGFILES = 2320*c917796cSXin LI 2321*c917796cSXin LI# When a file name is specified after GENERATE_TAGFILE, doxygen will create a 2322*c917796cSXin LI# tag file that is based on the input files it reads. See section "Linking to 2323*c917796cSXin LI# external documentation" for more information about the usage of tag files. 2324*c917796cSXin LI 2325*c917796cSXin LIGENERATE_TAGFILE = 2326*c917796cSXin LI 2327*c917796cSXin LI# If the ALLEXTERNALS tag is set to YES, all external class will be listed in 2328*c917796cSXin LI# the class index. If set to NO, only the inherited external classes will be 2329*c917796cSXin LI# listed. 2330*c917796cSXin LI# The default value is: NO. 2331*c917796cSXin LI 2332*c917796cSXin LIALLEXTERNALS = NO 2333*c917796cSXin LI 2334*c917796cSXin LI# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed 2335*c917796cSXin LI# in the modules index. If set to NO, only the current project's groups will be 2336*c917796cSXin LI# listed. 2337*c917796cSXin LI# The default value is: YES. 2338*c917796cSXin LI 2339*c917796cSXin LIEXTERNAL_GROUPS = YES 2340*c917796cSXin LI 2341*c917796cSXin LI# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in 2342*c917796cSXin LI# the related pages index. If set to NO, only the current project's pages will 2343*c917796cSXin LI# be listed. 2344*c917796cSXin LI# The default value is: YES. 2345*c917796cSXin LI 2346*c917796cSXin LIEXTERNAL_PAGES = YES 2347*c917796cSXin LI 2348*c917796cSXin LI#--------------------------------------------------------------------------- 2349*c917796cSXin LI# Configuration options related to the dot tool 2350*c917796cSXin LI#--------------------------------------------------------------------------- 2351*c917796cSXin LI 2352*c917796cSXin LI# You can include diagrams made with dia in doxygen documentation. Doxygen will 2353*c917796cSXin LI# then run dia to produce the diagram and insert it in the documentation. The 2354*c917796cSXin LI# DIA_PATH tag allows you to specify the directory where the dia binary resides. 2355*c917796cSXin LI# If left empty dia is assumed to be found in the default search path. 2356*c917796cSXin LI 2357*c917796cSXin LIDIA_PATH = 2358*c917796cSXin LI 2359*c917796cSXin LI# If set to YES the inheritance and collaboration graphs will hide inheritance 2360*c917796cSXin LI# and usage relations if the target is undocumented or is not a class. 2361*c917796cSXin LI# The default value is: YES. 2362*c917796cSXin LI 2363*c917796cSXin LIHIDE_UNDOC_RELATIONS = YES 2364*c917796cSXin LI 2365*c917796cSXin LI# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 2366*c917796cSXin LI# available from the path. This tool is part of Graphviz (see: 2367*c917796cSXin LI# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent 2368*c917796cSXin LI# Bell Labs. The other options in this section have no effect if this option is 2369*c917796cSXin LI# set to NO 2370*c917796cSXin LI# The default value is: NO. 2371*c917796cSXin LI 2372*c917796cSXin LIHAVE_DOT = NO 2373*c917796cSXin LI 2374*c917796cSXin LI# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed 2375*c917796cSXin LI# to run in parallel. When set to 0 doxygen will base this on the number of 2376*c917796cSXin LI# processors available in the system. You can set it explicitly to a value 2377*c917796cSXin LI# larger than 0 to get control over the balance between CPU load and processing 2378*c917796cSXin LI# speed. 2379*c917796cSXin LI# Minimum value: 0, maximum value: 32, default value: 0. 2380*c917796cSXin LI# This tag requires that the tag HAVE_DOT is set to YES. 2381*c917796cSXin LI 2382*c917796cSXin LIDOT_NUM_THREADS = 0 2383*c917796cSXin LI 2384*c917796cSXin LI# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of 2385*c917796cSXin LI# subgraphs. When you want a differently looking font in the dot files that 2386*c917796cSXin LI# doxygen generates you can specify fontname, fontcolor and fontsize attributes. 2387*c917796cSXin LI# For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node, 2388*c917796cSXin LI# Edge and Graph Attributes specification</a> You need to make sure dot is able 2389*c917796cSXin LI# to find the font, which can be done by putting it in a standard location or by 2390*c917796cSXin LI# setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the 2391*c917796cSXin LI# directory containing the font. Default graphviz fontsize is 14. 2392*c917796cSXin LI# The default value is: fontname=Helvetica,fontsize=10. 2393*c917796cSXin LI# This tag requires that the tag HAVE_DOT is set to YES. 2394*c917796cSXin LI 2395*c917796cSXin LIDOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10" 2396*c917796cSXin LI 2397*c917796cSXin LI# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can 2398*c917796cSXin LI# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a 2399*c917796cSXin LI# href=https://graphviz.org/doc/info/arrows.html>Complete documentation about 2400*c917796cSXin LI# arrows shapes.</a> 2401*c917796cSXin LI# The default value is: labelfontname=Helvetica,labelfontsize=10. 2402*c917796cSXin LI# This tag requires that the tag HAVE_DOT is set to YES. 2403*c917796cSXin LI 2404*c917796cSXin LIDOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10" 2405*c917796cSXin LI 2406*c917796cSXin LI# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes 2407*c917796cSXin LI# around nodes set 'shape=plain' or 'shape=plaintext' <a 2408*c917796cSXin LI# href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a> 2409*c917796cSXin LI# The default value is: shape=box,height=0.2,width=0.4. 2410*c917796cSXin LI# This tag requires that the tag HAVE_DOT is set to YES. 2411*c917796cSXin LI 2412*c917796cSXin LIDOT_NODE_ATTR = "shape=box,height=0.2,width=0.4" 2413*c917796cSXin LI 2414*c917796cSXin LI# You can set the path where dot can find font specified with fontname in 2415*c917796cSXin LI# DOT_COMMON_ATTR and others dot attributes. 2416*c917796cSXin LI# This tag requires that the tag HAVE_DOT is set to YES. 2417*c917796cSXin LI 2418*c917796cSXin LIDOT_FONTPATH = 2419*c917796cSXin LI 2420*c917796cSXin LI# If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a 2421*c917796cSXin LI# graph for each documented class showing the direct and indirect inheritance 2422*c917796cSXin LI# relations. In case HAVE_DOT is set as well dot will be used to draw the graph, 2423*c917796cSXin LI# otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set 2424*c917796cSXin LI# to TEXT the direct and indirect inheritance relations will be shown as texts / 2425*c917796cSXin LI# links. 2426*c917796cSXin LI# Possible values are: NO, YES, TEXT and GRAPH. 2427*c917796cSXin LI# The default value is: YES. 2428*c917796cSXin LI 2429*c917796cSXin LICLASS_GRAPH = YES 2430*c917796cSXin LI 2431*c917796cSXin LI# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a 2432*c917796cSXin LI# graph for each documented class showing the direct and indirect implementation 2433*c917796cSXin LI# dependencies (inheritance, containment, and class references variables) of the 2434*c917796cSXin LI# class with other documented classes. 2435*c917796cSXin LI# The default value is: YES. 2436*c917796cSXin LI# This tag requires that the tag HAVE_DOT is set to YES. 2437*c917796cSXin LI 2438*c917796cSXin LICOLLABORATION_GRAPH = YES 2439*c917796cSXin LI 2440*c917796cSXin LI# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for 2441*c917796cSXin LI# groups, showing the direct groups dependencies. See also the chapter Grouping 2442*c917796cSXin LI# in the manual. 2443*c917796cSXin LI# The default value is: YES. 2444*c917796cSXin LI# This tag requires that the tag HAVE_DOT is set to YES. 2445*c917796cSXin LI 2446*c917796cSXin LIGROUP_GRAPHS = YES 2447*c917796cSXin LI 2448*c917796cSXin LI# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and 2449*c917796cSXin LI# collaboration diagrams in a style similar to the OMG's Unified Modeling 2450*c917796cSXin LI# Language. 2451*c917796cSXin LI# The default value is: NO. 2452*c917796cSXin LI# This tag requires that the tag HAVE_DOT is set to YES. 2453*c917796cSXin LI 2454*c917796cSXin LIUML_LOOK = NO 2455*c917796cSXin LI 2456*c917796cSXin LI# If the UML_LOOK tag is enabled, the fields and methods are shown inside the 2457*c917796cSXin LI# class node. If there are many fields or methods and many nodes the graph may 2458*c917796cSXin LI# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the 2459*c917796cSXin LI# number of items for each type to make the size more manageable. Set this to 0 2460*c917796cSXin LI# for no limit. Note that the threshold may be exceeded by 50% before the limit 2461*c917796cSXin LI# is enforced. So when you set the threshold to 10, up to 15 fields may appear, 2462*c917796cSXin LI# but if the number exceeds 15, the total amount of fields shown is limited to 2463*c917796cSXin LI# 10. 2464*c917796cSXin LI# Minimum value: 0, maximum value: 100, default value: 10. 2465*c917796cSXin LI# This tag requires that the tag UML_LOOK is set to YES. 2466*c917796cSXin LI 2467*c917796cSXin LIUML_LIMIT_NUM_FIELDS = 10 2468*c917796cSXin LI 2469*c917796cSXin LI# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and 2470*c917796cSXin LI# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS 2471*c917796cSXin LI# tag is set to YES, doxygen will add type and arguments for attributes and 2472*c917796cSXin LI# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen 2473*c917796cSXin LI# will not generate fields with class member information in the UML graphs. The 2474*c917796cSXin LI# class diagrams will look similar to the default class diagrams but using UML 2475*c917796cSXin LI# notation for the relationships. 2476*c917796cSXin LI# Possible values are: NO, YES and NONE. 2477*c917796cSXin LI# The default value is: NO. 2478*c917796cSXin LI# This tag requires that the tag UML_LOOK is set to YES. 2479*c917796cSXin LI 2480*c917796cSXin LIDOT_UML_DETAILS = NO 2481*c917796cSXin LI 2482*c917796cSXin LI# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters 2483*c917796cSXin LI# to display on a single line. If the actual line length exceeds this threshold 2484*c917796cSXin LI# significantly it will wrapped across multiple lines. Some heuristics are apply 2485*c917796cSXin LI# to avoid ugly line breaks. 2486*c917796cSXin LI# Minimum value: 0, maximum value: 1000, default value: 17. 2487*c917796cSXin LI# This tag requires that the tag HAVE_DOT is set to YES. 2488*c917796cSXin LI 2489*c917796cSXin LIDOT_WRAP_THRESHOLD = 17 2490*c917796cSXin LI 2491*c917796cSXin LI# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and 2492*c917796cSXin LI# collaboration graphs will show the relations between templates and their 2493*c917796cSXin LI# instances. 2494*c917796cSXin LI# The default value is: NO. 2495*c917796cSXin LI# This tag requires that the tag HAVE_DOT is set to YES. 2496*c917796cSXin LI 2497*c917796cSXin LITEMPLATE_RELATIONS = NO 2498*c917796cSXin LI 2499*c917796cSXin LI# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to 2500*c917796cSXin LI# YES then doxygen will generate a graph for each documented file showing the 2501*c917796cSXin LI# direct and indirect include dependencies of the file with other documented 2502*c917796cSXin LI# files. 2503*c917796cSXin LI# The default value is: YES. 2504*c917796cSXin LI# This tag requires that the tag HAVE_DOT is set to YES. 2505*c917796cSXin LI 2506*c917796cSXin LIINCLUDE_GRAPH = YES 2507*c917796cSXin LI 2508*c917796cSXin LI# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are 2509*c917796cSXin LI# set to YES then doxygen will generate a graph for each documented file showing 2510*c917796cSXin LI# the direct and indirect include dependencies of the file with other documented 2511*c917796cSXin LI# files. 2512*c917796cSXin LI# The default value is: YES. 2513*c917796cSXin LI# This tag requires that the tag HAVE_DOT is set to YES. 2514*c917796cSXin LI 2515*c917796cSXin LIINCLUDED_BY_GRAPH = YES 2516*c917796cSXin LI 2517*c917796cSXin LI# If the CALL_GRAPH tag is set to YES then doxygen will generate a call 2518*c917796cSXin LI# dependency graph for every global function or class method. 2519*c917796cSXin LI# 2520*c917796cSXin LI# Note that enabling this option will significantly increase the time of a run. 2521*c917796cSXin LI# So in most cases it will be better to enable call graphs for selected 2522*c917796cSXin LI# functions only using the \callgraph command. Disabling a call graph can be 2523*c917796cSXin LI# accomplished by means of the command \hidecallgraph. 2524*c917796cSXin LI# The default value is: NO. 2525*c917796cSXin LI# This tag requires that the tag HAVE_DOT is set to YES. 2526*c917796cSXin LI 2527*c917796cSXin LICALL_GRAPH = NO 2528*c917796cSXin LI 2529*c917796cSXin LI# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller 2530*c917796cSXin LI# dependency graph for every global function or class method. 2531*c917796cSXin LI# 2532*c917796cSXin LI# Note that enabling this option will significantly increase the time of a run. 2533*c917796cSXin LI# So in most cases it will be better to enable caller graphs for selected 2534*c917796cSXin LI# functions only using the \callergraph command. Disabling a caller graph can be 2535*c917796cSXin LI# accomplished by means of the command \hidecallergraph. 2536*c917796cSXin LI# The default value is: NO. 2537*c917796cSXin LI# This tag requires that the tag HAVE_DOT is set to YES. 2538*c917796cSXin LI 2539*c917796cSXin LICALLER_GRAPH = NO 2540*c917796cSXin LI 2541*c917796cSXin LI# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical 2542*c917796cSXin LI# hierarchy of all classes instead of a textual one. 2543*c917796cSXin LI# The default value is: YES. 2544*c917796cSXin LI# This tag requires that the tag HAVE_DOT is set to YES. 2545*c917796cSXin LI 2546*c917796cSXin LIGRAPHICAL_HIERARCHY = YES 2547*c917796cSXin LI 2548*c917796cSXin LI# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the 2549*c917796cSXin LI# dependencies a directory has on other directories in a graphical way. The 2550*c917796cSXin LI# dependency relations are determined by the #include relations between the 2551*c917796cSXin LI# files in the directories. 2552*c917796cSXin LI# The default value is: YES. 2553*c917796cSXin LI# This tag requires that the tag HAVE_DOT is set to YES. 2554*c917796cSXin LI 2555*c917796cSXin LIDIRECTORY_GRAPH = YES 2556*c917796cSXin LI 2557*c917796cSXin LI# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels 2558*c917796cSXin LI# of child directories generated in directory dependency graphs by dot. 2559*c917796cSXin LI# Minimum value: 1, maximum value: 25, default value: 1. 2560*c917796cSXin LI# This tag requires that the tag DIRECTORY_GRAPH is set to YES. 2561*c917796cSXin LI 2562*c917796cSXin LIDIR_GRAPH_MAX_DEPTH = 1 2563*c917796cSXin LI 2564*c917796cSXin LI# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 2565*c917796cSXin LI# generated by dot. For an explanation of the image formats see the section 2566*c917796cSXin LI# output formats in the documentation of the dot tool (Graphviz (see: 2567*c917796cSXin LI# http://www.graphviz.org/)). 2568*c917796cSXin LI# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order 2569*c917796cSXin LI# to make the SVG files visible in IE 9+ (other browsers do not have this 2570*c917796cSXin LI# requirement). 2571*c917796cSXin LI# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, 2572*c917796cSXin LI# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and 2573*c917796cSXin LI# png:gdiplus:gdiplus. 2574*c917796cSXin LI# The default value is: png. 2575*c917796cSXin LI# This tag requires that the tag HAVE_DOT is set to YES. 2576*c917796cSXin LI 2577*c917796cSXin LIDOT_IMAGE_FORMAT = png 2578*c917796cSXin LI 2579*c917796cSXin LI# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 2580*c917796cSXin LI# enable generation of interactive SVG images that allow zooming and panning. 2581*c917796cSXin LI# 2582*c917796cSXin LI# Note that this requires a modern browser other than Internet Explorer. Tested 2583*c917796cSXin LI# and working are Firefox, Chrome, Safari, and Opera. 2584*c917796cSXin LI# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make 2585*c917796cSXin LI# the SVG files visible. Older versions of IE do not have SVG support. 2586*c917796cSXin LI# The default value is: NO. 2587*c917796cSXin LI# This tag requires that the tag HAVE_DOT is set to YES. 2588*c917796cSXin LI 2589*c917796cSXin LIINTERACTIVE_SVG = NO 2590*c917796cSXin LI 2591*c917796cSXin LI# The DOT_PATH tag can be used to specify the path where the dot tool can be 2592*c917796cSXin LI# found. If left blank, it is assumed the dot tool can be found in the path. 2593*c917796cSXin LI# This tag requires that the tag HAVE_DOT is set to YES. 2594*c917796cSXin LI 2595*c917796cSXin LIDOT_PATH = 2596*c917796cSXin LI 2597*c917796cSXin LI# The DOTFILE_DIRS tag can be used to specify one or more directories that 2598*c917796cSXin LI# contain dot files that are included in the documentation (see the \dotfile 2599*c917796cSXin LI# command). 2600*c917796cSXin LI# This tag requires that the tag HAVE_DOT is set to YES. 2601*c917796cSXin LI 2602*c917796cSXin LIDOTFILE_DIRS = 2603*c917796cSXin LI 2604*c917796cSXin LI# The MSCFILE_DIRS tag can be used to specify one or more directories that 2605*c917796cSXin LI# contain msc files that are included in the documentation (see the \mscfile 2606*c917796cSXin LI# command). 2607*c917796cSXin LI 2608*c917796cSXin LIMSCFILE_DIRS = 2609*c917796cSXin LI 2610*c917796cSXin LI# The DIAFILE_DIRS tag can be used to specify one or more directories that 2611*c917796cSXin LI# contain dia files that are included in the documentation (see the \diafile 2612*c917796cSXin LI# command). 2613*c917796cSXin LI 2614*c917796cSXin LIDIAFILE_DIRS = 2615*c917796cSXin LI 2616*c917796cSXin LI# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the 2617*c917796cSXin LI# path where java can find the plantuml.jar file or to the filename of jar file 2618*c917796cSXin LI# to be used. If left blank, it is assumed PlantUML is not used or called during 2619*c917796cSXin LI# a preprocessing step. Doxygen will generate a warning when it encounters a 2620*c917796cSXin LI# \startuml command in this case and will not generate output for the diagram. 2621*c917796cSXin LI 2622*c917796cSXin LIPLANTUML_JAR_PATH = 2623*c917796cSXin LI 2624*c917796cSXin LI# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a 2625*c917796cSXin LI# configuration file for plantuml. 2626*c917796cSXin LI 2627*c917796cSXin LIPLANTUML_CFG_FILE = 2628*c917796cSXin LI 2629*c917796cSXin LI# When using plantuml, the specified paths are searched for files specified by 2630*c917796cSXin LI# the !include statement in a plantuml block. 2631*c917796cSXin LI 2632*c917796cSXin LIPLANTUML_INCLUDE_PATH = 2633*c917796cSXin LI 2634*c917796cSXin LI# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes 2635*c917796cSXin LI# that will be shown in the graph. If the number of nodes in a graph becomes 2636*c917796cSXin LI# larger than this value, doxygen will truncate the graph, which is visualized 2637*c917796cSXin LI# by representing a node as a red box. Note that doxygen if the number of direct 2638*c917796cSXin LI# children of the root node in a graph is already larger than 2639*c917796cSXin LI# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that 2640*c917796cSXin LI# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 2641*c917796cSXin LI# Minimum value: 0, maximum value: 10000, default value: 50. 2642*c917796cSXin LI# This tag requires that the tag HAVE_DOT is set to YES. 2643*c917796cSXin LI 2644*c917796cSXin LIDOT_GRAPH_MAX_NODES = 50 2645*c917796cSXin LI 2646*c917796cSXin LI# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs 2647*c917796cSXin LI# generated by dot. A depth value of 3 means that only nodes reachable from the 2648*c917796cSXin LI# root by following a path via at most 3 edges will be shown. Nodes that lay 2649*c917796cSXin LI# further from the root node will be omitted. Note that setting this option to 1 2650*c917796cSXin LI# or 2 may greatly reduce the computation time needed for large code bases. Also 2651*c917796cSXin LI# note that the size of a graph can be further restricted by 2652*c917796cSXin LI# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 2653*c917796cSXin LI# Minimum value: 0, maximum value: 1000, default value: 0. 2654*c917796cSXin LI# This tag requires that the tag HAVE_DOT is set to YES. 2655*c917796cSXin LI 2656*c917796cSXin LIMAX_DOT_GRAPH_DEPTH = 0 2657*c917796cSXin LI 2658*c917796cSXin LI# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output 2659*c917796cSXin LI# files in one run (i.e. multiple -o and -T options on the command line). This 2660*c917796cSXin LI# makes dot run faster, but since only newer versions of dot (>1.8.10) support 2661*c917796cSXin LI# this, this feature is disabled by default. 2662*c917796cSXin LI# The default value is: NO. 2663*c917796cSXin LI# This tag requires that the tag HAVE_DOT is set to YES. 2664*c917796cSXin LI 2665*c917796cSXin LIDOT_MULTI_TARGETS = NO 2666*c917796cSXin LI 2667*c917796cSXin LI# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page 2668*c917796cSXin LI# explaining the meaning of the various boxes and arrows in the dot generated 2669*c917796cSXin LI# graphs. 2670*c917796cSXin LI# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal 2671*c917796cSXin LI# graphical representation for inheritance and collaboration diagrams is used. 2672*c917796cSXin LI# The default value is: YES. 2673*c917796cSXin LI# This tag requires that the tag HAVE_DOT is set to YES. 2674*c917796cSXin LI 2675*c917796cSXin LIGENERATE_LEGEND = YES 2676*c917796cSXin LI 2677*c917796cSXin LI# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate 2678*c917796cSXin LI# files that are used to generate the various graphs. 2679*c917796cSXin LI# 2680*c917796cSXin LI# Note: This setting is not only used for dot files but also for msc temporary 2681*c917796cSXin LI# files. 2682*c917796cSXin LI# The default value is: YES. 2683*c917796cSXin LI 2684*c917796cSXin LIDOT_CLEANUP = YES 2685