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