1cb93a386Sopenharmony_ci# Doxyfile 1.8.13 2cb93a386Sopenharmony_ci 3cb93a386Sopenharmony_ci# This file describes the settings to be used by the documentation system 4cb93a386Sopenharmony_ci# doxygen (www.doxygen.org) for a project. 5cb93a386Sopenharmony_ci# 6cb93a386Sopenharmony_ci# All text after a double hash (##) is considered a comment and is placed in 7cb93a386Sopenharmony_ci# front of the TAG it is preceding. 8cb93a386Sopenharmony_ci# 9cb93a386Sopenharmony_ci# All text after a single hash (#) is considered a comment and will be ignored. 10cb93a386Sopenharmony_ci# The format is: 11cb93a386Sopenharmony_ci# TAG = value [value, ...] 12cb93a386Sopenharmony_ci# For lists, items can also be appended using: 13cb93a386Sopenharmony_ci# TAG += value [value, ...] 14cb93a386Sopenharmony_ci# Values that contain spaces should be placed between quotes (\" \"). 15cb93a386Sopenharmony_ci 16cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 17cb93a386Sopenharmony_ci# Project related configuration options 18cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 19cb93a386Sopenharmony_ci 20cb93a386Sopenharmony_ci# This tag specifies the encoding used for all characters in the config file 21cb93a386Sopenharmony_ci# that follow. The default is UTF-8 which is also the encoding used for all text 22cb93a386Sopenharmony_ci# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 23cb93a386Sopenharmony_ci# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 24cb93a386Sopenharmony_ci# for the list of possible encodings. 25cb93a386Sopenharmony_ci# The default value is: UTF-8. 26cb93a386Sopenharmony_ci 27cb93a386Sopenharmony_ciDOXYFILE_ENCODING = UTF-8 28cb93a386Sopenharmony_ci 29cb93a386Sopenharmony_ci# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 30cb93a386Sopenharmony_ci# double-quotes, unless you are using Doxywizard) that should identify the 31cb93a386Sopenharmony_ci# project for which the documentation is generated. This name is used in the 32cb93a386Sopenharmony_ci# title of most generated pages and in a few other places. 33cb93a386Sopenharmony_ci# The default value is: My Project. 34cb93a386Sopenharmony_ci 35cb93a386Sopenharmony_ciPROJECT_NAME = "Skia" 36cb93a386Sopenharmony_ci 37cb93a386Sopenharmony_ci# The PROJECT_NUMBER tag can be used to enter a project or revision number. This 38cb93a386Sopenharmony_ci# could be handy for archiving the generated documentation or if some version 39cb93a386Sopenharmony_ci# control system is used. 40cb93a386Sopenharmony_ci 41cb93a386Sopenharmony_ciPROJECT_NUMBER = 42cb93a386Sopenharmony_ci 43cb93a386Sopenharmony_ci# Using the PROJECT_BRIEF tag one can provide an optional one line description 44cb93a386Sopenharmony_ci# for a project that appears at the top of each page and should give viewer a 45cb93a386Sopenharmony_ci# quick idea about the purpose of the project. Keep the description short. 46cb93a386Sopenharmony_ci 47cb93a386Sopenharmony_ciPROJECT_BRIEF = "2D Graphics Library" 48cb93a386Sopenharmony_ci 49cb93a386Sopenharmony_ci# With the PROJECT_LOGO tag one can specify a logo or an icon that is included 50cb93a386Sopenharmony_ci# in the documentation. The maximum height of the logo should not exceed 55 51cb93a386Sopenharmony_ci# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 52cb93a386Sopenharmony_ci# the logo to the output directory. 53cb93a386Sopenharmony_ci 54cb93a386Sopenharmony_ciPROJECT_LOGO = logo.png 55cb93a386Sopenharmony_ci 56cb93a386Sopenharmony_ci# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57cb93a386Sopenharmony_ci# into which the generated documentation will be written. If a relative path is 58cb93a386Sopenharmony_ci# entered, it will be relative to the location where doxygen was started. If 59cb93a386Sopenharmony_ci# left blank the current directory will be used. 60cb93a386Sopenharmony_ci 61cb93a386Sopenharmony_ciOUTPUT_DIRECTORY = /tmp/doxygen 62cb93a386Sopenharmony_ci 63cb93a386Sopenharmony_ci# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- 64cb93a386Sopenharmony_ci# directories (in 2 levels) under the output directory of each output format and 65cb93a386Sopenharmony_ci# will distribute the generated files over these directories. Enabling this 66cb93a386Sopenharmony_ci# option can be useful when feeding doxygen a huge amount of source files, where 67cb93a386Sopenharmony_ci# putting all generated files in the same directory would otherwise causes 68cb93a386Sopenharmony_ci# performance problems for the file system. 69cb93a386Sopenharmony_ci# The default value is: NO. 70cb93a386Sopenharmony_ci 71cb93a386Sopenharmony_ciCREATE_SUBDIRS = NO 72cb93a386Sopenharmony_ci 73cb93a386Sopenharmony_ci# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74cb93a386Sopenharmony_ci# characters to appear in the names of generated files. If set to NO, non-ASCII 75cb93a386Sopenharmony_ci# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76cb93a386Sopenharmony_ci# U+3044. 77cb93a386Sopenharmony_ci# The default value is: NO. 78cb93a386Sopenharmony_ci 79cb93a386Sopenharmony_ciALLOW_UNICODE_NAMES = NO 80cb93a386Sopenharmony_ci 81cb93a386Sopenharmony_ci# The OUTPUT_LANGUAGE tag is used to specify the language in which all 82cb93a386Sopenharmony_ci# documentation generated by doxygen is written. Doxygen will use this 83cb93a386Sopenharmony_ci# information to generate all constant output in the proper language. 84cb93a386Sopenharmony_ci# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 85cb93a386Sopenharmony_ci# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 86cb93a386Sopenharmony_ci# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 87cb93a386Sopenharmony_ci# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 88cb93a386Sopenharmony_ci# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 89cb93a386Sopenharmony_ci# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 90cb93a386Sopenharmony_ci# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 91cb93a386Sopenharmony_ci# Ukrainian and Vietnamese. 92cb93a386Sopenharmony_ci# The default value is: English. 93cb93a386Sopenharmony_ci 94cb93a386Sopenharmony_ciOUTPUT_LANGUAGE = English 95cb93a386Sopenharmony_ci 96cb93a386Sopenharmony_ci# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 97cb93a386Sopenharmony_ci# descriptions after the members that are listed in the file and class 98cb93a386Sopenharmony_ci# documentation (similar to Javadoc). Set to NO to disable this. 99cb93a386Sopenharmony_ci# The default value is: YES. 100cb93a386Sopenharmony_ci 101cb93a386Sopenharmony_ciBRIEF_MEMBER_DESC = YES 102cb93a386Sopenharmony_ci 103cb93a386Sopenharmony_ci# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 104cb93a386Sopenharmony_ci# description of a member or function before the detailed description 105cb93a386Sopenharmony_ci# 106cb93a386Sopenharmony_ci# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 107cb93a386Sopenharmony_ci# brief descriptions will be completely suppressed. 108cb93a386Sopenharmony_ci# The default value is: YES. 109cb93a386Sopenharmony_ci 110cb93a386Sopenharmony_ciREPEAT_BRIEF = YES 111cb93a386Sopenharmony_ci 112cb93a386Sopenharmony_ci# This tag implements a quasi-intelligent brief description abbreviator that is 113cb93a386Sopenharmony_ci# used to form the text in various listings. Each string in this list, if found 114cb93a386Sopenharmony_ci# as the leading text of the brief description, will be stripped from the text 115cb93a386Sopenharmony_ci# and the result, after processing the whole list, is used as the annotated 116cb93a386Sopenharmony_ci# text. Otherwise, the brief description is used as-is. If left blank, the 117cb93a386Sopenharmony_ci# following values are used ($name is automatically replaced with the name of 118cb93a386Sopenharmony_ci# the entity):The $name class, The $name widget, The $name file, is, provides, 119cb93a386Sopenharmony_ci# specifies, contains, represents, a, an and the. 120cb93a386Sopenharmony_ci 121cb93a386Sopenharmony_ciABBREVIATE_BRIEF = "The $name class" \ 122cb93a386Sopenharmony_ci "The $name widget" \ 123cb93a386Sopenharmony_ci "The $name file" \ 124cb93a386Sopenharmony_ci is \ 125cb93a386Sopenharmony_ci provides \ 126cb93a386Sopenharmony_ci specifies \ 127cb93a386Sopenharmony_ci contains \ 128cb93a386Sopenharmony_ci represents \ 129cb93a386Sopenharmony_ci a \ 130cb93a386Sopenharmony_ci an \ 131cb93a386Sopenharmony_ci the 132cb93a386Sopenharmony_ci 133cb93a386Sopenharmony_ci# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 134cb93a386Sopenharmony_ci# doxygen will generate a detailed section even if there is only a brief 135cb93a386Sopenharmony_ci# description. 136cb93a386Sopenharmony_ci# The default value is: NO. 137cb93a386Sopenharmony_ci 138cb93a386Sopenharmony_ciALWAYS_DETAILED_SEC = YES 139cb93a386Sopenharmony_ci 140cb93a386Sopenharmony_ci# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 141cb93a386Sopenharmony_ci# inherited members of a class in the documentation of that class as if those 142cb93a386Sopenharmony_ci# members were ordinary class members. Constructors, destructors and assignment 143cb93a386Sopenharmony_ci# operators of the base classes will not be shown. 144cb93a386Sopenharmony_ci# The default value is: NO. 145cb93a386Sopenharmony_ci 146cb93a386Sopenharmony_ciINLINE_INHERITED_MEMB = YES 147cb93a386Sopenharmony_ci 148cb93a386Sopenharmony_ci# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 149cb93a386Sopenharmony_ci# before files name in the file list and in the header files. If set to NO the 150cb93a386Sopenharmony_ci# shortest path that makes the file name unique will be used 151cb93a386Sopenharmony_ci# The default value is: YES. 152cb93a386Sopenharmony_ci 153cb93a386Sopenharmony_ciFULL_PATH_NAMES = YES 154cb93a386Sopenharmony_ci 155cb93a386Sopenharmony_ci# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 156cb93a386Sopenharmony_ci# Stripping is only done if one of the specified strings matches the left-hand 157cb93a386Sopenharmony_ci# part of the path. The tag can be used to show relative paths in the file list. 158cb93a386Sopenharmony_ci# If left blank the directory from which doxygen is run is used as the path to 159cb93a386Sopenharmony_ci# strip. 160cb93a386Sopenharmony_ci# 161cb93a386Sopenharmony_ci# Note that you can specify absolute paths here, but also relative paths, which 162cb93a386Sopenharmony_ci# will be relative from the directory where doxygen is started. 163cb93a386Sopenharmony_ci# This tag requires that the tag FULL_PATH_NAMES is set to YES. 164cb93a386Sopenharmony_ci 165cb93a386Sopenharmony_ciSTRIP_FROM_PATH = 166cb93a386Sopenharmony_ci 167cb93a386Sopenharmony_ci# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 168cb93a386Sopenharmony_ci# path mentioned in the documentation of a class, which tells the reader which 169cb93a386Sopenharmony_ci# header file to include in order to use a class. If left blank only the name of 170cb93a386Sopenharmony_ci# the header file containing the class definition is used. Otherwise one should 171cb93a386Sopenharmony_ci# specify the list of include paths that are normally passed to the compiler 172cb93a386Sopenharmony_ci# using the -I flag. 173cb93a386Sopenharmony_ci 174cb93a386Sopenharmony_ciSTRIP_FROM_INC_PATH = 175cb93a386Sopenharmony_ci 176cb93a386Sopenharmony_ci# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 177cb93a386Sopenharmony_ci# less readable) file names. This can be useful is your file systems doesn't 178cb93a386Sopenharmony_ci# support long names like on DOS, Mac, or CD-ROM. 179cb93a386Sopenharmony_ci# The default value is: NO. 180cb93a386Sopenharmony_ci 181cb93a386Sopenharmony_ciSHORT_NAMES = NO 182cb93a386Sopenharmony_ci 183cb93a386Sopenharmony_ci# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 184cb93a386Sopenharmony_ci# first line (until the first dot) of a Javadoc-style comment as the brief 185cb93a386Sopenharmony_ci# description. If set to NO, the Javadoc-style will behave just like regular Qt- 186cb93a386Sopenharmony_ci# style comments (thus requiring an explicit @brief command for a brief 187cb93a386Sopenharmony_ci# description.) 188cb93a386Sopenharmony_ci# The default value is: NO. 189cb93a386Sopenharmony_ci 190cb93a386Sopenharmony_ciJAVADOC_AUTOBRIEF = YES 191cb93a386Sopenharmony_ci 192cb93a386Sopenharmony_ci# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 193cb93a386Sopenharmony_ci# line (until the first dot) of a Qt-style comment as the brief description. If 194cb93a386Sopenharmony_ci# set to NO, the Qt-style will behave just like regular Qt-style comments (thus 195cb93a386Sopenharmony_ci# requiring an explicit \brief command for a brief description.) 196cb93a386Sopenharmony_ci# The default value is: NO. 197cb93a386Sopenharmony_ci 198cb93a386Sopenharmony_ciQT_AUTOBRIEF = NO 199cb93a386Sopenharmony_ci 200cb93a386Sopenharmony_ci# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 201cb93a386Sopenharmony_ci# multi-line C++ special comment block (i.e. a block of //! or /// comments) as 202cb93a386Sopenharmony_ci# a brief description. This used to be the default behavior. The new default is 203cb93a386Sopenharmony_ci# to treat a multi-line C++ comment block as a detailed description. Set this 204cb93a386Sopenharmony_ci# tag to YES if you prefer the old behavior instead. 205cb93a386Sopenharmony_ci# 206cb93a386Sopenharmony_ci# Note that setting this tag to YES also means that rational rose comments are 207cb93a386Sopenharmony_ci# not recognized any more. 208cb93a386Sopenharmony_ci# The default value is: NO. 209cb93a386Sopenharmony_ci 210cb93a386Sopenharmony_ciMULTILINE_CPP_IS_BRIEF = YES 211cb93a386Sopenharmony_ci 212cb93a386Sopenharmony_ci# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 213cb93a386Sopenharmony_ci# documentation from any documented member that it re-implements. 214cb93a386Sopenharmony_ci# The default value is: YES. 215cb93a386Sopenharmony_ci 216cb93a386Sopenharmony_ciINHERIT_DOCS = YES 217cb93a386Sopenharmony_ci 218cb93a386Sopenharmony_ci# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 219cb93a386Sopenharmony_ci# page for each member. If set to NO, the documentation of a member will be part 220cb93a386Sopenharmony_ci# of the file/class/namespace that contains it. 221cb93a386Sopenharmony_ci# The default value is: NO. 222cb93a386Sopenharmony_ci 223cb93a386Sopenharmony_ciSEPARATE_MEMBER_PAGES = NO 224cb93a386Sopenharmony_ci 225cb93a386Sopenharmony_ci# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 226cb93a386Sopenharmony_ci# uses this value to replace tabs by spaces in code fragments. 227cb93a386Sopenharmony_ci# Minimum value: 1, maximum value: 16, default value: 4. 228cb93a386Sopenharmony_ci 229cb93a386Sopenharmony_ciTAB_SIZE = 4 230cb93a386Sopenharmony_ci 231cb93a386Sopenharmony_ci# This tag can be used to specify a number of aliases that act as commands in 232cb93a386Sopenharmony_ci# the documentation. An alias has the form: 233cb93a386Sopenharmony_ci# name=value 234cb93a386Sopenharmony_ci# For example adding 235cb93a386Sopenharmony_ci# "sideeffect=@par Side Effects:\n" 236cb93a386Sopenharmony_ci# will allow you to put the command \sideeffect (or @sideeffect) in the 237cb93a386Sopenharmony_ci# documentation, which will result in a user-defined paragraph with heading 238cb93a386Sopenharmony_ci# "Side Effects:". You can put \n's in the value part of an alias to insert 239cb93a386Sopenharmony_ci# newlines. 240cb93a386Sopenharmony_ci 241cb93a386Sopenharmony_ciALIASES = "copy{1}=\htmlonly <script>document.write('<div style=\'display:none;visibility:hidden;\'>');</script> \endhtmlonly \image html \1 \n \htmlonly <script>document.write('</div>');</script> \endhtmlonly" 242cb93a386Sopenharmony_ci 243cb93a386Sopenharmony_ci# This tag can be used to specify a number of word-keyword mappings (TCL only). 244cb93a386Sopenharmony_ci# A mapping has the form "name=value". For example adding "class=itcl::class" 245cb93a386Sopenharmony_ci# will allow you to use the command class in the itcl::class meaning. 246cb93a386Sopenharmony_ci 247cb93a386Sopenharmony_ciTCL_SUBST = 248cb93a386Sopenharmony_ci 249cb93a386Sopenharmony_ci# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 250cb93a386Sopenharmony_ci# only. Doxygen will then generate output that is more tailored for C. For 251cb93a386Sopenharmony_ci# instance, some of the names that are used will be different. The list of all 252cb93a386Sopenharmony_ci# members will be omitted, etc. 253cb93a386Sopenharmony_ci# The default value is: NO. 254cb93a386Sopenharmony_ci 255cb93a386Sopenharmony_ciOPTIMIZE_OUTPUT_FOR_C = NO 256cb93a386Sopenharmony_ci 257cb93a386Sopenharmony_ci# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 258cb93a386Sopenharmony_ci# Python sources only. Doxygen will then generate output that is more tailored 259cb93a386Sopenharmony_ci# for that language. For instance, namespaces will be presented as packages, 260cb93a386Sopenharmony_ci# qualified scopes will look different, etc. 261cb93a386Sopenharmony_ci# The default value is: NO. 262cb93a386Sopenharmony_ci 263cb93a386Sopenharmony_ciOPTIMIZE_OUTPUT_JAVA = NO 264cb93a386Sopenharmony_ci 265cb93a386Sopenharmony_ci# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 266cb93a386Sopenharmony_ci# sources. Doxygen will then generate output that is tailored for Fortran. 267cb93a386Sopenharmony_ci# The default value is: NO. 268cb93a386Sopenharmony_ci 269cb93a386Sopenharmony_ciOPTIMIZE_FOR_FORTRAN = NO 270cb93a386Sopenharmony_ci 271cb93a386Sopenharmony_ci# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 272cb93a386Sopenharmony_ci# sources. Doxygen will then generate output that is tailored for VHDL. 273cb93a386Sopenharmony_ci# The default value is: NO. 274cb93a386Sopenharmony_ci 275cb93a386Sopenharmony_ciOPTIMIZE_OUTPUT_VHDL = NO 276cb93a386Sopenharmony_ci 277cb93a386Sopenharmony_ci# Doxygen selects the parser to use depending on the extension of the files it 278cb93a386Sopenharmony_ci# parses. With this tag you can assign which parser to use for a given 279cb93a386Sopenharmony_ci# extension. Doxygen has a built-in mapping, but you can override or extend it 280cb93a386Sopenharmony_ci# using this tag. The format is ext=language, where ext is a file extension, and 281cb93a386Sopenharmony_ci# language is one of the parsers supported by doxygen: IDL, Java, Javascript, 282cb93a386Sopenharmony_ci# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 283cb93a386Sopenharmony_ci# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 284cb93a386Sopenharmony_ci# Fortran. In the later case the parser tries to guess whether the code is fixed 285cb93a386Sopenharmony_ci# or free formatted code, this is the default for Fortran type files), VHDL. For 286cb93a386Sopenharmony_ci# instance to make doxygen treat .inc files as Fortran files (default is PHP), 287cb93a386Sopenharmony_ci# and .f files as C (default is Fortran), use: inc=Fortran f=C. 288cb93a386Sopenharmony_ci# 289cb93a386Sopenharmony_ci# Note: For files without extension you can use no_extension as a placeholder. 290cb93a386Sopenharmony_ci# 291cb93a386Sopenharmony_ci# Note that for custom extensions you also need to set FILE_PATTERNS otherwise 292cb93a386Sopenharmony_ci# the files are not read by doxygen. 293cb93a386Sopenharmony_ci 294cb93a386Sopenharmony_ciEXTENSION_MAPPING = 295cb93a386Sopenharmony_ci 296cb93a386Sopenharmony_ci# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 297cb93a386Sopenharmony_ci# according to the Markdown format, which allows for more readable 298cb93a386Sopenharmony_ci# documentation. See http://daringfireball.net/projects/markdown/ for details. 299cb93a386Sopenharmony_ci# The output of markdown processing is further processed by doxygen, so you can 300cb93a386Sopenharmony_ci# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 301cb93a386Sopenharmony_ci# case of backward compatibilities issues. 302cb93a386Sopenharmony_ci# The default value is: YES. 303cb93a386Sopenharmony_ci 304cb93a386Sopenharmony_ciMARKDOWN_SUPPORT = YES 305cb93a386Sopenharmony_ci 306cb93a386Sopenharmony_ci# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 307cb93a386Sopenharmony_ci# to that level are automatically included in the table of contents, even if 308cb93a386Sopenharmony_ci# they do not have an id attribute. 309cb93a386Sopenharmony_ci# Note: This feature currently applies only to Markdown headings. 310cb93a386Sopenharmony_ci# Minimum value: 0, maximum value: 99, default value: 0. 311cb93a386Sopenharmony_ci# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 312cb93a386Sopenharmony_ci 313cb93a386Sopenharmony_ciTOC_INCLUDE_HEADINGS = 2 314cb93a386Sopenharmony_ci 315cb93a386Sopenharmony_ci# When enabled doxygen tries to link words that correspond to documented 316cb93a386Sopenharmony_ci# classes, or namespaces to their corresponding documentation. Such a link can 317cb93a386Sopenharmony_ci# be prevented in individual cases by putting a % sign in front of the word or 318cb93a386Sopenharmony_ci# globally by setting AUTOLINK_SUPPORT to NO. 319cb93a386Sopenharmony_ci# The default value is: YES. 320cb93a386Sopenharmony_ci 321cb93a386Sopenharmony_ciAUTOLINK_SUPPORT = YES 322cb93a386Sopenharmony_ci 323cb93a386Sopenharmony_ci# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 324cb93a386Sopenharmony_ci# to include (a tag file for) the STL sources as input, then you should set this 325cb93a386Sopenharmony_ci# tag to YES in order to let doxygen match functions declarations and 326cb93a386Sopenharmony_ci# definitions whose arguments contain STL classes (e.g. func(std::string); 327cb93a386Sopenharmony_ci# versus func(std::string) {}). This also make the inheritance and collaboration 328cb93a386Sopenharmony_ci# diagrams that involve STL classes more complete and accurate. 329cb93a386Sopenharmony_ci# The default value is: NO. 330cb93a386Sopenharmony_ci 331cb93a386Sopenharmony_ciBUILTIN_STL_SUPPORT = NO 332cb93a386Sopenharmony_ci 333cb93a386Sopenharmony_ci# If you use Microsoft's C++/CLI language, you should set this option to YES to 334cb93a386Sopenharmony_ci# enable parsing support. 335cb93a386Sopenharmony_ci# The default value is: NO. 336cb93a386Sopenharmony_ci 337cb93a386Sopenharmony_ciCPP_CLI_SUPPORT = NO 338cb93a386Sopenharmony_ci 339cb93a386Sopenharmony_ci# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 340cb93a386Sopenharmony_ci# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 341cb93a386Sopenharmony_ci# will parse them like normal C++ but will assume all classes use public instead 342cb93a386Sopenharmony_ci# of private inheritance when no explicit protection keyword is present. 343cb93a386Sopenharmony_ci# The default value is: NO. 344cb93a386Sopenharmony_ci 345cb93a386Sopenharmony_ciSIP_SUPPORT = NO 346cb93a386Sopenharmony_ci 347cb93a386Sopenharmony_ci# For Microsoft's IDL there are propget and propput attributes to indicate 348cb93a386Sopenharmony_ci# getter and setter methods for a property. Setting this option to YES will make 349cb93a386Sopenharmony_ci# doxygen to replace the get and set methods by a property in the documentation. 350cb93a386Sopenharmony_ci# This will only work if the methods are indeed getting or setting a simple 351cb93a386Sopenharmony_ci# type. If this is not the case, or you want to show the methods anyway, you 352cb93a386Sopenharmony_ci# should set this option to NO. 353cb93a386Sopenharmony_ci# The default value is: YES. 354cb93a386Sopenharmony_ci 355cb93a386Sopenharmony_ciIDL_PROPERTY_SUPPORT = YES 356cb93a386Sopenharmony_ci 357cb93a386Sopenharmony_ci# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 358cb93a386Sopenharmony_ci# tag is set to YES then doxygen will reuse the documentation of the first 359cb93a386Sopenharmony_ci# member in the group (if any) for the other members of the group. By default 360cb93a386Sopenharmony_ci# all members of a group must be documented explicitly. 361cb93a386Sopenharmony_ci# The default value is: NO. 362cb93a386Sopenharmony_ci 363cb93a386Sopenharmony_ciDISTRIBUTE_GROUP_DOC = NO 364cb93a386Sopenharmony_ci 365cb93a386Sopenharmony_ci# If one adds a struct or class to a group and this option is enabled, then also 366cb93a386Sopenharmony_ci# any nested class or struct is added to the same group. By default this option 367cb93a386Sopenharmony_ci# is disabled and one has to add nested compounds explicitly via \ingroup. 368cb93a386Sopenharmony_ci# The default value is: NO. 369cb93a386Sopenharmony_ci 370cb93a386Sopenharmony_ciGROUP_NESTED_COMPOUNDS = NO 371cb93a386Sopenharmony_ci 372cb93a386Sopenharmony_ci# Set the SUBGROUPING tag to YES to allow class member groups of the same type 373cb93a386Sopenharmony_ci# (for instance a group of public functions) to be put as a subgroup of that 374cb93a386Sopenharmony_ci# type (e.g. under the Public Functions section). Set it to NO to prevent 375cb93a386Sopenharmony_ci# subgrouping. Alternatively, this can be done per class using the 376cb93a386Sopenharmony_ci# \nosubgrouping command. 377cb93a386Sopenharmony_ci# The default value is: YES. 378cb93a386Sopenharmony_ci 379cb93a386Sopenharmony_ciSUBGROUPING = YES 380cb93a386Sopenharmony_ci 381cb93a386Sopenharmony_ci# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 382cb93a386Sopenharmony_ci# are shown inside the group in which they are included (e.g. using \ingroup) 383cb93a386Sopenharmony_ci# instead of on a separate page (for HTML and Man pages) or section (for LaTeX 384cb93a386Sopenharmony_ci# and RTF). 385cb93a386Sopenharmony_ci# 386cb93a386Sopenharmony_ci# Note that this feature does not work in combination with 387cb93a386Sopenharmony_ci# SEPARATE_MEMBER_PAGES. 388cb93a386Sopenharmony_ci# The default value is: NO. 389cb93a386Sopenharmony_ci 390cb93a386Sopenharmony_ciINLINE_GROUPED_CLASSES = NO 391cb93a386Sopenharmony_ci 392cb93a386Sopenharmony_ci# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 393cb93a386Sopenharmony_ci# with only public data fields or simple typedef fields will be shown inline in 394cb93a386Sopenharmony_ci# the documentation of the scope in which they are defined (i.e. file, 395cb93a386Sopenharmony_ci# namespace, or group documentation), provided this scope is documented. If set 396cb93a386Sopenharmony_ci# to NO, structs, classes, and unions are shown on a separate page (for HTML and 397cb93a386Sopenharmony_ci# Man pages) or section (for LaTeX and RTF). 398cb93a386Sopenharmony_ci# The default value is: NO. 399cb93a386Sopenharmony_ci 400cb93a386Sopenharmony_ciINLINE_SIMPLE_STRUCTS = NO 401cb93a386Sopenharmony_ci 402cb93a386Sopenharmony_ci# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 403cb93a386Sopenharmony_ci# enum is documented as struct, union, or enum with the name of the typedef. So 404cb93a386Sopenharmony_ci# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 405cb93a386Sopenharmony_ci# with name TypeT. When disabled the typedef will appear as a member of a file, 406cb93a386Sopenharmony_ci# namespace, or class. And the struct will be named TypeS. This can typically be 407cb93a386Sopenharmony_ci# useful for C code in case the coding convention dictates that all compound 408cb93a386Sopenharmony_ci# types are typedef'ed and only the typedef is referenced, never the tag name. 409cb93a386Sopenharmony_ci# The default value is: NO. 410cb93a386Sopenharmony_ci 411cb93a386Sopenharmony_ciTYPEDEF_HIDES_STRUCT = NO 412cb93a386Sopenharmony_ci 413cb93a386Sopenharmony_ci# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 414cb93a386Sopenharmony_ci# cache is used to resolve symbols given their name and scope. Since this can be 415cb93a386Sopenharmony_ci# an expensive process and often the same symbol appears multiple times in the 416cb93a386Sopenharmony_ci# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 417cb93a386Sopenharmony_ci# doxygen will become slower. If the cache is too large, memory is wasted. The 418cb93a386Sopenharmony_ci# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 419cb93a386Sopenharmony_ci# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 420cb93a386Sopenharmony_ci# symbols. At the end of a run doxygen will report the cache usage and suggest 421cb93a386Sopenharmony_ci# the optimal cache size from a speed point of view. 422cb93a386Sopenharmony_ci# Minimum value: 0, maximum value: 9, default value: 0. 423cb93a386Sopenharmony_ci 424cb93a386Sopenharmony_ciLOOKUP_CACHE_SIZE = 8 425cb93a386Sopenharmony_ci 426cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 427cb93a386Sopenharmony_ci# Build related configuration options 428cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 429cb93a386Sopenharmony_ci 430cb93a386Sopenharmony_ci# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 431cb93a386Sopenharmony_ci# documentation are documented, even if no documentation was available. Private 432cb93a386Sopenharmony_ci# class members and static file members will be hidden unless the 433cb93a386Sopenharmony_ci# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 434cb93a386Sopenharmony_ci# Note: This will also disable the warnings about undocumented members that are 435cb93a386Sopenharmony_ci# normally produced when WARNINGS is set to YES. 436cb93a386Sopenharmony_ci# The default value is: NO. 437cb93a386Sopenharmony_ci 438cb93a386Sopenharmony_ciEXTRACT_ALL = YES 439cb93a386Sopenharmony_ci 440cb93a386Sopenharmony_ci# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 441cb93a386Sopenharmony_ci# be included in the documentation. 442cb93a386Sopenharmony_ci# The default value is: NO. 443cb93a386Sopenharmony_ci 444cb93a386Sopenharmony_ciEXTRACT_PRIVATE = NO 445cb93a386Sopenharmony_ci 446cb93a386Sopenharmony_ci# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 447cb93a386Sopenharmony_ci# scope will be included in the documentation. 448cb93a386Sopenharmony_ci# The default value is: NO. 449cb93a386Sopenharmony_ci 450cb93a386Sopenharmony_ciEXTRACT_PACKAGE = NO 451cb93a386Sopenharmony_ci 452cb93a386Sopenharmony_ci# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 453cb93a386Sopenharmony_ci# included in the documentation. 454cb93a386Sopenharmony_ci# The default value is: NO. 455cb93a386Sopenharmony_ci 456cb93a386Sopenharmony_ciEXTRACT_STATIC = YES 457cb93a386Sopenharmony_ci 458cb93a386Sopenharmony_ci# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 459cb93a386Sopenharmony_ci# locally in source files will be included in the documentation. If set to NO, 460cb93a386Sopenharmony_ci# only classes defined in header files are included. Does not have any effect 461cb93a386Sopenharmony_ci# for Java sources. 462cb93a386Sopenharmony_ci# The default value is: YES. 463cb93a386Sopenharmony_ci 464cb93a386Sopenharmony_ciEXTRACT_LOCAL_CLASSES = YES 465cb93a386Sopenharmony_ci 466cb93a386Sopenharmony_ci# This flag is only useful for Objective-C code. If set to YES, local methods, 467cb93a386Sopenharmony_ci# which are defined in the implementation section but not in the interface are 468cb93a386Sopenharmony_ci# included in the documentation. If set to NO, only methods in the interface are 469cb93a386Sopenharmony_ci# included. 470cb93a386Sopenharmony_ci# The default value is: NO. 471cb93a386Sopenharmony_ci 472cb93a386Sopenharmony_ciEXTRACT_LOCAL_METHODS = NO 473cb93a386Sopenharmony_ci 474cb93a386Sopenharmony_ci# If this flag is set to YES, the members of anonymous namespaces will be 475cb93a386Sopenharmony_ci# extracted and appear in the documentation as a namespace called 476cb93a386Sopenharmony_ci# 'anonymous_namespace{file}', where file will be replaced with the base name of 477cb93a386Sopenharmony_ci# the file that contains the anonymous namespace. By default anonymous namespace 478cb93a386Sopenharmony_ci# are hidden. 479cb93a386Sopenharmony_ci# The default value is: NO. 480cb93a386Sopenharmony_ci 481cb93a386Sopenharmony_ciEXTRACT_ANON_NSPACES = NO 482cb93a386Sopenharmony_ci 483cb93a386Sopenharmony_ci# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 484cb93a386Sopenharmony_ci# undocumented members inside documented classes or files. If set to NO these 485cb93a386Sopenharmony_ci# members will be included in the various overviews, but no documentation 486cb93a386Sopenharmony_ci# section is generated. This option has no effect if EXTRACT_ALL is enabled. 487cb93a386Sopenharmony_ci# The default value is: NO. 488cb93a386Sopenharmony_ci 489cb93a386Sopenharmony_ciHIDE_UNDOC_MEMBERS = NO 490cb93a386Sopenharmony_ci 491cb93a386Sopenharmony_ci# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 492cb93a386Sopenharmony_ci# undocumented classes that are normally visible in the class hierarchy. If set 493cb93a386Sopenharmony_ci# to NO, these classes will be included in the various overviews. This option 494cb93a386Sopenharmony_ci# has no effect if EXTRACT_ALL is enabled. 495cb93a386Sopenharmony_ci# The default value is: NO. 496cb93a386Sopenharmony_ci 497cb93a386Sopenharmony_ciHIDE_UNDOC_CLASSES = NO 498cb93a386Sopenharmony_ci 499cb93a386Sopenharmony_ci# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 500cb93a386Sopenharmony_ci# (class|struct|union) declarations. If set to NO, these declarations will be 501cb93a386Sopenharmony_ci# included in the documentation. 502cb93a386Sopenharmony_ci# The default value is: NO. 503cb93a386Sopenharmony_ci 504cb93a386Sopenharmony_ciHIDE_FRIEND_COMPOUNDS = NO 505cb93a386Sopenharmony_ci 506cb93a386Sopenharmony_ci# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 507cb93a386Sopenharmony_ci# documentation blocks found inside the body of a function. If set to NO, these 508cb93a386Sopenharmony_ci# blocks will be appended to the function's detailed documentation block. 509cb93a386Sopenharmony_ci# The default value is: NO. 510cb93a386Sopenharmony_ci 511cb93a386Sopenharmony_ciHIDE_IN_BODY_DOCS = NO 512cb93a386Sopenharmony_ci 513cb93a386Sopenharmony_ci# The INTERNAL_DOCS tag determines if documentation that is typed after a 514cb93a386Sopenharmony_ci# \internal command is included. If the tag is set to NO then the documentation 515cb93a386Sopenharmony_ci# will be excluded. Set it to YES to include the internal documentation. 516cb93a386Sopenharmony_ci# The default value is: NO. 517cb93a386Sopenharmony_ci 518cb93a386Sopenharmony_ciINTERNAL_DOCS = NO 519cb93a386Sopenharmony_ci 520cb93a386Sopenharmony_ci# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 521cb93a386Sopenharmony_ci# names in lower-case letters. If set to YES, upper-case letters are also 522cb93a386Sopenharmony_ci# allowed. This is useful if you have classes or files whose names only differ 523cb93a386Sopenharmony_ci# in case and if your file system supports case sensitive file names. Windows 524cb93a386Sopenharmony_ci# and Mac users are advised to set this option to NO. 525cb93a386Sopenharmony_ci# The default value is: system dependent. 526cb93a386Sopenharmony_ci 527cb93a386Sopenharmony_ciCASE_SENSE_NAMES = YES 528cb93a386Sopenharmony_ci 529cb93a386Sopenharmony_ci# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 530cb93a386Sopenharmony_ci# their full class and namespace scopes in the documentation. If set to YES, the 531cb93a386Sopenharmony_ci# scope will be hidden. 532cb93a386Sopenharmony_ci# The default value is: NO. 533cb93a386Sopenharmony_ci 534cb93a386Sopenharmony_ciHIDE_SCOPE_NAMES = NO 535cb93a386Sopenharmony_ci 536cb93a386Sopenharmony_ci# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 537cb93a386Sopenharmony_ci# append additional text to a page's title, such as Class Reference. If set to 538cb93a386Sopenharmony_ci# YES the compound reference will be hidden. 539cb93a386Sopenharmony_ci# The default value is: NO. 540cb93a386Sopenharmony_ci 541cb93a386Sopenharmony_ciHIDE_COMPOUND_REFERENCE= NO 542cb93a386Sopenharmony_ci 543cb93a386Sopenharmony_ci# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 544cb93a386Sopenharmony_ci# the files that are included by a file in the documentation of that file. 545cb93a386Sopenharmony_ci# The default value is: YES. 546cb93a386Sopenharmony_ci 547cb93a386Sopenharmony_ciSHOW_INCLUDE_FILES = YES 548cb93a386Sopenharmony_ci 549cb93a386Sopenharmony_ci# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 550cb93a386Sopenharmony_ci# grouped member an include statement to the documentation, telling the reader 551cb93a386Sopenharmony_ci# which file to include in order to use the member. 552cb93a386Sopenharmony_ci# The default value is: NO. 553cb93a386Sopenharmony_ci 554cb93a386Sopenharmony_ciSHOW_GROUPED_MEMB_INC = NO 555cb93a386Sopenharmony_ci 556cb93a386Sopenharmony_ci# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 557cb93a386Sopenharmony_ci# files with double quotes in the documentation rather than with sharp brackets. 558cb93a386Sopenharmony_ci# The default value is: NO. 559cb93a386Sopenharmony_ci 560cb93a386Sopenharmony_ciFORCE_LOCAL_INCLUDES = NO 561cb93a386Sopenharmony_ci 562cb93a386Sopenharmony_ci# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 563cb93a386Sopenharmony_ci# documentation for inline members. 564cb93a386Sopenharmony_ci# The default value is: YES. 565cb93a386Sopenharmony_ci 566cb93a386Sopenharmony_ciINLINE_INFO = YES 567cb93a386Sopenharmony_ci 568cb93a386Sopenharmony_ci# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 569cb93a386Sopenharmony_ci# (detailed) documentation of file and class members alphabetically by member 570cb93a386Sopenharmony_ci# name. If set to NO, the members will appear in declaration order. 571cb93a386Sopenharmony_ci# The default value is: YES. 572cb93a386Sopenharmony_ci 573cb93a386Sopenharmony_ciSORT_MEMBER_DOCS = YES 574cb93a386Sopenharmony_ci 575cb93a386Sopenharmony_ci# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 576cb93a386Sopenharmony_ci# descriptions of file, namespace and class members alphabetically by member 577cb93a386Sopenharmony_ci# name. If set to NO, the members will appear in declaration order. Note that 578cb93a386Sopenharmony_ci# this will also influence the order of the classes in the class list. 579cb93a386Sopenharmony_ci# The default value is: NO. 580cb93a386Sopenharmony_ci 581cb93a386Sopenharmony_ciSORT_BRIEF_DOCS = NO 582cb93a386Sopenharmony_ci 583cb93a386Sopenharmony_ci# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 584cb93a386Sopenharmony_ci# (brief and detailed) documentation of class members so that constructors and 585cb93a386Sopenharmony_ci# destructors are listed first. If set to NO the constructors will appear in the 586cb93a386Sopenharmony_ci# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 587cb93a386Sopenharmony_ci# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 588cb93a386Sopenharmony_ci# member documentation. 589cb93a386Sopenharmony_ci# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 590cb93a386Sopenharmony_ci# detailed member documentation. 591cb93a386Sopenharmony_ci# The default value is: NO. 592cb93a386Sopenharmony_ci 593cb93a386Sopenharmony_ciSORT_MEMBERS_CTORS_1ST = NO 594cb93a386Sopenharmony_ci 595cb93a386Sopenharmony_ci# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 596cb93a386Sopenharmony_ci# of group names into alphabetical order. If set to NO the group names will 597cb93a386Sopenharmony_ci# appear in their defined order. 598cb93a386Sopenharmony_ci# The default value is: NO. 599cb93a386Sopenharmony_ci 600cb93a386Sopenharmony_ciSORT_GROUP_NAMES = NO 601cb93a386Sopenharmony_ci 602cb93a386Sopenharmony_ci# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 603cb93a386Sopenharmony_ci# fully-qualified names, including namespaces. If set to NO, the class list will 604cb93a386Sopenharmony_ci# be sorted only by class name, not including the namespace part. 605cb93a386Sopenharmony_ci# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 606cb93a386Sopenharmony_ci# Note: This option applies only to the class list, not to the alphabetical 607cb93a386Sopenharmony_ci# list. 608cb93a386Sopenharmony_ci# The default value is: NO. 609cb93a386Sopenharmony_ci 610cb93a386Sopenharmony_ciSORT_BY_SCOPE_NAME = NO 611cb93a386Sopenharmony_ci 612cb93a386Sopenharmony_ci# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 613cb93a386Sopenharmony_ci# type resolution of all parameters of a function it will reject a match between 614cb93a386Sopenharmony_ci# the prototype and the implementation of a member function even if there is 615cb93a386Sopenharmony_ci# only one candidate or it is obvious which candidate to choose by doing a 616cb93a386Sopenharmony_ci# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 617cb93a386Sopenharmony_ci# accept a match between prototype and implementation in such cases. 618cb93a386Sopenharmony_ci# The default value is: NO. 619cb93a386Sopenharmony_ci 620cb93a386Sopenharmony_ciSTRICT_PROTO_MATCHING = NO 621cb93a386Sopenharmony_ci 622cb93a386Sopenharmony_ci# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 623cb93a386Sopenharmony_ci# list. This list is created by putting \todo commands in the documentation. 624cb93a386Sopenharmony_ci# The default value is: YES. 625cb93a386Sopenharmony_ci 626cb93a386Sopenharmony_ciGENERATE_TODOLIST = YES 627cb93a386Sopenharmony_ci 628cb93a386Sopenharmony_ci# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 629cb93a386Sopenharmony_ci# list. This list is created by putting \test commands in the documentation. 630cb93a386Sopenharmony_ci# The default value is: YES. 631cb93a386Sopenharmony_ci 632cb93a386Sopenharmony_ciGENERATE_TESTLIST = YES 633cb93a386Sopenharmony_ci 634cb93a386Sopenharmony_ci# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 635cb93a386Sopenharmony_ci# list. This list is created by putting \bug commands in the documentation. 636cb93a386Sopenharmony_ci# The default value is: YES. 637cb93a386Sopenharmony_ci 638cb93a386Sopenharmony_ciGENERATE_BUGLIST = YES 639cb93a386Sopenharmony_ci 640cb93a386Sopenharmony_ci# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 641cb93a386Sopenharmony_ci# the deprecated list. This list is created by putting \deprecated commands in 642cb93a386Sopenharmony_ci# the documentation. 643cb93a386Sopenharmony_ci# The default value is: YES. 644cb93a386Sopenharmony_ci 645cb93a386Sopenharmony_ciGENERATE_DEPRECATEDLIST= YES 646cb93a386Sopenharmony_ci 647cb93a386Sopenharmony_ci# The ENABLED_SECTIONS tag can be used to enable conditional documentation 648cb93a386Sopenharmony_ci# sections, marked by \if <section_label> ... \endif and \cond <section_label> 649cb93a386Sopenharmony_ci# ... \endcond blocks. 650cb93a386Sopenharmony_ci 651cb93a386Sopenharmony_ciENABLED_SECTIONS = 652cb93a386Sopenharmony_ci 653cb93a386Sopenharmony_ci# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 654cb93a386Sopenharmony_ci# initial value of a variable or macro / define can have for it to appear in the 655cb93a386Sopenharmony_ci# documentation. If the initializer consists of more lines than specified here 656cb93a386Sopenharmony_ci# it will be hidden. Use a value of 0 to hide initializers completely. The 657cb93a386Sopenharmony_ci# appearance of the value of individual variables and macros / defines can be 658cb93a386Sopenharmony_ci# controlled using \showinitializer or \hideinitializer command in the 659cb93a386Sopenharmony_ci# documentation regardless of this setting. 660cb93a386Sopenharmony_ci# Minimum value: 0, maximum value: 10000, default value: 30. 661cb93a386Sopenharmony_ci 662cb93a386Sopenharmony_ciMAX_INITIALIZER_LINES = 30 663cb93a386Sopenharmony_ci 664cb93a386Sopenharmony_ci# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 665cb93a386Sopenharmony_ci# the bottom of the documentation of classes and structs. If set to YES, the 666cb93a386Sopenharmony_ci# list will mention the files that were used to generate the documentation. 667cb93a386Sopenharmony_ci# The default value is: YES. 668cb93a386Sopenharmony_ci 669cb93a386Sopenharmony_ciSHOW_USED_FILES = YES 670cb93a386Sopenharmony_ci 671cb93a386Sopenharmony_ci# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 672cb93a386Sopenharmony_ci# will remove the Files entry from the Quick Index and from the Folder Tree View 673cb93a386Sopenharmony_ci# (if specified). 674cb93a386Sopenharmony_ci# The default value is: YES. 675cb93a386Sopenharmony_ci 676cb93a386Sopenharmony_ciSHOW_FILES = YES 677cb93a386Sopenharmony_ci 678cb93a386Sopenharmony_ci# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 679cb93a386Sopenharmony_ci# page. This will remove the Namespaces entry from the Quick Index and from the 680cb93a386Sopenharmony_ci# Folder Tree View (if specified). 681cb93a386Sopenharmony_ci# The default value is: YES. 682cb93a386Sopenharmony_ci 683cb93a386Sopenharmony_ciSHOW_NAMESPACES = YES 684cb93a386Sopenharmony_ci 685cb93a386Sopenharmony_ci# The FILE_VERSION_FILTER tag can be used to specify a program or script that 686cb93a386Sopenharmony_ci# doxygen should invoke to get the current version for each file (typically from 687cb93a386Sopenharmony_ci# the version control system). Doxygen will invoke the program by executing (via 688cb93a386Sopenharmony_ci# popen()) the command command input-file, where command is the value of the 689cb93a386Sopenharmony_ci# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 690cb93a386Sopenharmony_ci# by doxygen. Whatever the program writes to standard output is used as the file 691cb93a386Sopenharmony_ci# version. For an example see the documentation. 692cb93a386Sopenharmony_ci 693cb93a386Sopenharmony_ciFILE_VERSION_FILTER = 694cb93a386Sopenharmony_ci 695cb93a386Sopenharmony_ci# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 696cb93a386Sopenharmony_ci# by doxygen. The layout file controls the global structure of the generated 697cb93a386Sopenharmony_ci# output files in an output format independent way. To create the layout file 698cb93a386Sopenharmony_ci# that represents doxygen's defaults, run doxygen with the -l option. You can 699cb93a386Sopenharmony_ci# optionally specify a file name after the option, if omitted DoxygenLayout.xml 700cb93a386Sopenharmony_ci# will be used as the name of the layout file. 701cb93a386Sopenharmony_ci# 702cb93a386Sopenharmony_ci# Note that if you run doxygen from a directory containing a file called 703cb93a386Sopenharmony_ci# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 704cb93a386Sopenharmony_ci# tag is left empty. 705cb93a386Sopenharmony_ci 706cb93a386Sopenharmony_ciLAYOUT_FILE = 707cb93a386Sopenharmony_ci 708cb93a386Sopenharmony_ci# The CITE_BIB_FILES tag can be used to specify one or more bib files containing 709cb93a386Sopenharmony_ci# the reference definitions. This must be a list of .bib files. The .bib 710cb93a386Sopenharmony_ci# extension is automatically appended if omitted. This requires the bibtex tool 711cb93a386Sopenharmony_ci# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 712cb93a386Sopenharmony_ci# For LaTeX the style of the bibliography can be controlled using 713cb93a386Sopenharmony_ci# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 714cb93a386Sopenharmony_ci# search path. See also \cite for info how to create references. 715cb93a386Sopenharmony_ci 716cb93a386Sopenharmony_ciCITE_BIB_FILES = 717cb93a386Sopenharmony_ci 718cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 719cb93a386Sopenharmony_ci# Configuration options related to warning and progress messages 720cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 721cb93a386Sopenharmony_ci 722cb93a386Sopenharmony_ci# The QUIET tag can be used to turn on/off the messages that are generated to 723cb93a386Sopenharmony_ci# standard output by doxygen. If QUIET is set to YES this implies that the 724cb93a386Sopenharmony_ci# messages are off. 725cb93a386Sopenharmony_ci# The default value is: NO. 726cb93a386Sopenharmony_ci 727cb93a386Sopenharmony_ciQUIET = NO 728cb93a386Sopenharmony_ci 729cb93a386Sopenharmony_ci# The WARNINGS tag can be used to turn on/off the warning messages that are 730cb93a386Sopenharmony_ci# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 731cb93a386Sopenharmony_ci# this implies that the warnings are on. 732cb93a386Sopenharmony_ci# 733cb93a386Sopenharmony_ci# Tip: Turn warnings on while writing the documentation. 734cb93a386Sopenharmony_ci# The default value is: YES. 735cb93a386Sopenharmony_ci 736cb93a386Sopenharmony_ciWARNINGS = YES 737cb93a386Sopenharmony_ci 738cb93a386Sopenharmony_ci# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 739cb93a386Sopenharmony_ci# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 740cb93a386Sopenharmony_ci# will automatically be disabled. 741cb93a386Sopenharmony_ci# The default value is: YES. 742cb93a386Sopenharmony_ci 743cb93a386Sopenharmony_ciWARN_IF_UNDOCUMENTED = YES 744cb93a386Sopenharmony_ci 745cb93a386Sopenharmony_ci# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 746cb93a386Sopenharmony_ci# potential errors in the documentation, such as not documenting some parameters 747cb93a386Sopenharmony_ci# in a documented function, or documenting parameters that don't exist or using 748cb93a386Sopenharmony_ci# markup commands wrongly. 749cb93a386Sopenharmony_ci# The default value is: YES. 750cb93a386Sopenharmony_ci 751cb93a386Sopenharmony_ciWARN_IF_DOC_ERROR = YES 752cb93a386Sopenharmony_ci 753cb93a386Sopenharmony_ci# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 754cb93a386Sopenharmony_ci# are documented, but have no documentation for their parameters or return 755cb93a386Sopenharmony_ci# value. If set to NO, doxygen will only warn about wrong or incomplete 756cb93a386Sopenharmony_ci# parameter documentation, but not about the absence of documentation. 757cb93a386Sopenharmony_ci# The default value is: NO. 758cb93a386Sopenharmony_ci 759cb93a386Sopenharmony_ciWARN_NO_PARAMDOC = NO 760cb93a386Sopenharmony_ci 761cb93a386Sopenharmony_ci# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 762cb93a386Sopenharmony_ci# a warning is encountered. 763cb93a386Sopenharmony_ci# The default value is: NO. 764cb93a386Sopenharmony_ci 765cb93a386Sopenharmony_ciWARN_AS_ERROR = NO 766cb93a386Sopenharmony_ci 767cb93a386Sopenharmony_ci# The WARN_FORMAT tag determines the format of the warning messages that doxygen 768cb93a386Sopenharmony_ci# can produce. The string should contain the $file, $line, and $text tags, which 769cb93a386Sopenharmony_ci# will be replaced by the file and line number from which the warning originated 770cb93a386Sopenharmony_ci# and the warning text. Optionally the format may contain $version, which will 771cb93a386Sopenharmony_ci# be replaced by the version of the file (if it could be obtained via 772cb93a386Sopenharmony_ci# FILE_VERSION_FILTER) 773cb93a386Sopenharmony_ci# The default value is: $file:$line: $text. 774cb93a386Sopenharmony_ci 775cb93a386Sopenharmony_ciWARN_FORMAT = "$file:$line: $text" 776cb93a386Sopenharmony_ci 777cb93a386Sopenharmony_ci# The WARN_LOGFILE tag can be used to specify a file to which warning and error 778cb93a386Sopenharmony_ci# messages should be written. If left blank the output is written to standard 779cb93a386Sopenharmony_ci# error (stderr). 780cb93a386Sopenharmony_ci 781cb93a386Sopenharmony_ciWARN_LOGFILE = 782cb93a386Sopenharmony_ci 783cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 784cb93a386Sopenharmony_ci# Configuration options related to the input files 785cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 786cb93a386Sopenharmony_ci 787cb93a386Sopenharmony_ci# The INPUT tag is used to specify the files and/or directories that contain 788cb93a386Sopenharmony_ci# documented source files. You may enter file names like myfile.cpp or 789cb93a386Sopenharmony_ci# directories like /usr/src/myproject. Separate the files or directories with 790cb93a386Sopenharmony_ci# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 791cb93a386Sopenharmony_ci# Note: If this tag is empty the current directory is searched. 792cb93a386Sopenharmony_ci 793cb93a386Sopenharmony_ciINPUT = ../../include/core \ 794cb93a386Sopenharmony_ci ../../include/effects \ 795cb93a386Sopenharmony_ci ../../include/docs \ 796cb93a386Sopenharmony_ci ../../include/gpu \ 797cb93a386Sopenharmony_ci ../../include/pathops \ 798cb93a386Sopenharmony_ci ../../third_party/skcms \ 799cb93a386Sopenharmony_ci ../../modules/particles/include \ 800cb93a386Sopenharmony_ci ../../modules/skottie/include \ 801cb93a386Sopenharmony_ci ../../modules/sksg/include \ 802cb93a386Sopenharmony_ci ../../modules/skshaper/include \ 803cb93a386Sopenharmony_ci ../../modules/svg/include \ 804cb93a386Sopenharmony_ci ./mainpage 805cb93a386Sopenharmony_ci 806cb93a386Sopenharmony_ci# This tag can be used to specify the character encoding of the source files 807cb93a386Sopenharmony_ci# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 808cb93a386Sopenharmony_ci# libiconv (or the iconv built into libc) for the transcoding. See the libiconv 809cb93a386Sopenharmony_ci# documentation (see: http://www.gnu.org/software/libiconv) for the list of 810cb93a386Sopenharmony_ci# possible encodings. 811cb93a386Sopenharmony_ci# The default value is: UTF-8. 812cb93a386Sopenharmony_ci 813cb93a386Sopenharmony_ciINPUT_ENCODING = UTF-8 814cb93a386Sopenharmony_ci 815cb93a386Sopenharmony_ci# If the value of the INPUT tag contains directories, you can use the 816cb93a386Sopenharmony_ci# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 817cb93a386Sopenharmony_ci# *.h) to filter out the source-files in the directories. 818cb93a386Sopenharmony_ci# 819cb93a386Sopenharmony_ci# Note that for custom extensions or not directly supported extensions you also 820cb93a386Sopenharmony_ci# need to set EXTENSION_MAPPING for the extension otherwise the files are not 821cb93a386Sopenharmony_ci# read by doxygen. 822cb93a386Sopenharmony_ci# 823cb93a386Sopenharmony_ci# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 824cb93a386Sopenharmony_ci# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 825cb93a386Sopenharmony_ci# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 826cb93a386Sopenharmony_ci# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, 827cb93a386Sopenharmony_ci# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. 828cb93a386Sopenharmony_ci 829cb93a386Sopenharmony_ciFILE_PATTERNS = *.c \ 830cb93a386Sopenharmony_ci *.cc \ 831cb93a386Sopenharmony_ci *.cxx \ 832cb93a386Sopenharmony_ci *.cpp \ 833cb93a386Sopenharmony_ci *.c++ \ 834cb93a386Sopenharmony_ci *.java \ 835cb93a386Sopenharmony_ci *.ii \ 836cb93a386Sopenharmony_ci *.ixx \ 837cb93a386Sopenharmony_ci *.ipp \ 838cb93a386Sopenharmony_ci *.i++ \ 839cb93a386Sopenharmony_ci *.inl \ 840cb93a386Sopenharmony_ci *.idl \ 841cb93a386Sopenharmony_ci *.ddl \ 842cb93a386Sopenharmony_ci *.odl \ 843cb93a386Sopenharmony_ci *.h \ 844cb93a386Sopenharmony_ci *.hh \ 845cb93a386Sopenharmony_ci *.hxx \ 846cb93a386Sopenharmony_ci *.hpp \ 847cb93a386Sopenharmony_ci *.h++ \ 848cb93a386Sopenharmony_ci *.cs \ 849cb93a386Sopenharmony_ci *.d \ 850cb93a386Sopenharmony_ci *.php \ 851cb93a386Sopenharmony_ci *.php4 \ 852cb93a386Sopenharmony_ci *.php5 \ 853cb93a386Sopenharmony_ci *.phtml \ 854cb93a386Sopenharmony_ci *.inc \ 855cb93a386Sopenharmony_ci *.m \ 856cb93a386Sopenharmony_ci *.markdown \ 857cb93a386Sopenharmony_ci *.md \ 858cb93a386Sopenharmony_ci *.mm \ 859cb93a386Sopenharmony_ci *.dox \ 860cb93a386Sopenharmony_ci *.py \ 861cb93a386Sopenharmony_ci *.pyw \ 862cb93a386Sopenharmony_ci *.f90 \ 863cb93a386Sopenharmony_ci *.f95 \ 864cb93a386Sopenharmony_ci *.f03 \ 865cb93a386Sopenharmony_ci *.f08 \ 866cb93a386Sopenharmony_ci *.f \ 867cb93a386Sopenharmony_ci *.for \ 868cb93a386Sopenharmony_ci *.tcl \ 869cb93a386Sopenharmony_ci *.vhd \ 870cb93a386Sopenharmony_ci *.vhdl \ 871cb93a386Sopenharmony_ci *.ucf \ 872cb93a386Sopenharmony_ci *.qsf 873cb93a386Sopenharmony_ci 874cb93a386Sopenharmony_ci# The RECURSIVE tag can be used to specify whether or not subdirectories should 875cb93a386Sopenharmony_ci# be searched for input files as well. 876cb93a386Sopenharmony_ci# The default value is: NO. 877cb93a386Sopenharmony_ci 878cb93a386Sopenharmony_ciRECURSIVE = NO 879cb93a386Sopenharmony_ci 880cb93a386Sopenharmony_ci# The EXCLUDE tag can be used to specify files and/or directories that should be 881cb93a386Sopenharmony_ci# excluded from the INPUT source files. This way you can easily exclude a 882cb93a386Sopenharmony_ci# subdirectory from a directory tree whose root is specified with the INPUT tag. 883cb93a386Sopenharmony_ci# 884cb93a386Sopenharmony_ci# Note that relative paths are relative to the directory from which doxygen is 885cb93a386Sopenharmony_ci# run. 886cb93a386Sopenharmony_ci 887cb93a386Sopenharmony_ciEXCLUDE = 888cb93a386Sopenharmony_ci 889cb93a386Sopenharmony_ci# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 890cb93a386Sopenharmony_ci# directories that are symbolic links (a Unix file system feature) are excluded 891cb93a386Sopenharmony_ci# from the input. 892cb93a386Sopenharmony_ci# The default value is: NO. 893cb93a386Sopenharmony_ci 894cb93a386Sopenharmony_ciEXCLUDE_SYMLINKS = NO 895cb93a386Sopenharmony_ci 896cb93a386Sopenharmony_ci# If the value of the INPUT tag contains directories, you can use the 897cb93a386Sopenharmony_ci# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 898cb93a386Sopenharmony_ci# certain files from those directories. 899cb93a386Sopenharmony_ci# 900cb93a386Sopenharmony_ci# Note that the wildcards are matched against the file with absolute path, so to 901cb93a386Sopenharmony_ci# exclude all test directories for example use the pattern */test/* 902cb93a386Sopenharmony_ci 903cb93a386Sopenharmony_ciEXCLUDE_PATTERNS = 904cb93a386Sopenharmony_ci 905cb93a386Sopenharmony_ci# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 906cb93a386Sopenharmony_ci# (namespaces, classes, functions, etc.) that should be excluded from the 907cb93a386Sopenharmony_ci# output. The symbol name can be a fully qualified name, a word, or if the 908cb93a386Sopenharmony_ci# wildcard * is used, a substring. Examples: ANamespace, AClass, 909cb93a386Sopenharmony_ci# AClass::ANamespace, ANamespace::*Test 910cb93a386Sopenharmony_ci# 911cb93a386Sopenharmony_ci# Note that the wildcards are matched against the file with absolute path, so to 912cb93a386Sopenharmony_ci# exclude all test directories use the pattern */test/* 913cb93a386Sopenharmony_ci 914cb93a386Sopenharmony_ciEXCLUDE_SYMBOLS = 915cb93a386Sopenharmony_ci 916cb93a386Sopenharmony_ci# The EXAMPLE_PATH tag can be used to specify one or more files or directories 917cb93a386Sopenharmony_ci# that contain example code fragments that are included (see the \include 918cb93a386Sopenharmony_ci# command). 919cb93a386Sopenharmony_ci 920cb93a386Sopenharmony_ciEXAMPLE_PATH = ./mainpage/markdeep 921cb93a386Sopenharmony_ci 922cb93a386Sopenharmony_ci# If the value of the EXAMPLE_PATH tag contains directories, you can use the 923cb93a386Sopenharmony_ci# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 924cb93a386Sopenharmony_ci# *.h) to filter out the source-files in the directories. If left blank all 925cb93a386Sopenharmony_ci# files are included. 926cb93a386Sopenharmony_ci 927cb93a386Sopenharmony_ciEXAMPLE_PATTERNS = * 928cb93a386Sopenharmony_ci 929cb93a386Sopenharmony_ci# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 930cb93a386Sopenharmony_ci# searched for input files to be used with the \include or \dontinclude commands 931cb93a386Sopenharmony_ci# irrespective of the value of the RECURSIVE tag. 932cb93a386Sopenharmony_ci# The default value is: NO. 933cb93a386Sopenharmony_ci 934cb93a386Sopenharmony_ciEXAMPLE_RECURSIVE = NO 935cb93a386Sopenharmony_ci 936cb93a386Sopenharmony_ci# The IMAGE_PATH tag can be used to specify one or more files or directories 937cb93a386Sopenharmony_ci# that contain images that are to be included in the documentation (see the 938cb93a386Sopenharmony_ci# \image command). 939cb93a386Sopenharmony_ci 940cb93a386Sopenharmony_ciIMAGE_PATH = 941cb93a386Sopenharmony_ci 942cb93a386Sopenharmony_ci# The INPUT_FILTER tag can be used to specify a program that doxygen should 943cb93a386Sopenharmony_ci# invoke to filter for each input file. Doxygen will invoke the filter program 944cb93a386Sopenharmony_ci# by executing (via popen()) the command: 945cb93a386Sopenharmony_ci# 946cb93a386Sopenharmony_ci# <filter> <input-file> 947cb93a386Sopenharmony_ci# 948cb93a386Sopenharmony_ci# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the 949cb93a386Sopenharmony_ci# name of an input file. Doxygen will then use the output that the filter 950cb93a386Sopenharmony_ci# program writes to standard output. If FILTER_PATTERNS is specified, this tag 951cb93a386Sopenharmony_ci# will be ignored. 952cb93a386Sopenharmony_ci# 953cb93a386Sopenharmony_ci# Note that the filter must not add or remove lines; it is applied before the 954cb93a386Sopenharmony_ci# code is scanned, but not when the output code is generated. If lines are added 955cb93a386Sopenharmony_ci# or removed, the anchors will not be placed correctly. 956cb93a386Sopenharmony_ci# 957cb93a386Sopenharmony_ci# Note that for custom extensions or not directly supported extensions you also 958cb93a386Sopenharmony_ci# need to set EXTENSION_MAPPING for the extension otherwise the files are not 959cb93a386Sopenharmony_ci# properly processed by doxygen. 960cb93a386Sopenharmony_ci 961cb93a386Sopenharmony_ciINPUT_FILTER = 962cb93a386Sopenharmony_ci 963cb93a386Sopenharmony_ci# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 964cb93a386Sopenharmony_ci# basis. Doxygen will compare the file name with each pattern and apply the 965cb93a386Sopenharmony_ci# filter if there is a match. The filters are a list of the form: pattern=filter 966cb93a386Sopenharmony_ci# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 967cb93a386Sopenharmony_ci# filters are used. If the FILTER_PATTERNS tag is empty or if none of the 968cb93a386Sopenharmony_ci# patterns match the file name, INPUT_FILTER is applied. 969cb93a386Sopenharmony_ci# 970cb93a386Sopenharmony_ci# Note that for custom extensions or not directly supported extensions you also 971cb93a386Sopenharmony_ci# need to set EXTENSION_MAPPING for the extension otherwise the files are not 972cb93a386Sopenharmony_ci# properly processed by doxygen. 973cb93a386Sopenharmony_ci 974cb93a386Sopenharmony_ciFILTER_PATTERNS = 975cb93a386Sopenharmony_ci 976cb93a386Sopenharmony_ci# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 977cb93a386Sopenharmony_ci# INPUT_FILTER) will also be used to filter the input files that are used for 978cb93a386Sopenharmony_ci# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 979cb93a386Sopenharmony_ci# The default value is: NO. 980cb93a386Sopenharmony_ci 981cb93a386Sopenharmony_ciFILTER_SOURCE_FILES = NO 982cb93a386Sopenharmony_ci 983cb93a386Sopenharmony_ci# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 984cb93a386Sopenharmony_ci# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 985cb93a386Sopenharmony_ci# it is also possible to disable source filtering for a specific pattern using 986cb93a386Sopenharmony_ci# *.ext= (so without naming a filter). 987cb93a386Sopenharmony_ci# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 988cb93a386Sopenharmony_ci 989cb93a386Sopenharmony_ciFILTER_SOURCE_PATTERNS = 990cb93a386Sopenharmony_ci 991cb93a386Sopenharmony_ci# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 992cb93a386Sopenharmony_ci# is part of the input, its contents will be placed on the main page 993cb93a386Sopenharmony_ci# (index.html). This can be useful if you have a project on for instance GitHub 994cb93a386Sopenharmony_ci# and want to reuse the introduction page also for the doxygen output. 995cb93a386Sopenharmony_ci 996cb93a386Sopenharmony_ciUSE_MDFILE_AS_MAINPAGE = 997cb93a386Sopenharmony_ci 998cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 999cb93a386Sopenharmony_ci# Configuration options related to source browsing 1000cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 1001cb93a386Sopenharmony_ci 1002cb93a386Sopenharmony_ci# If the SOURCE_BROWSER tag is set to YES then a list of source files will be 1003cb93a386Sopenharmony_ci# generated. Documented entities will be cross-referenced with these sources. 1004cb93a386Sopenharmony_ci# 1005cb93a386Sopenharmony_ci# Note: To get rid of all source code in the generated output, make sure that 1006cb93a386Sopenharmony_ci# also VERBATIM_HEADERS is set to NO. 1007cb93a386Sopenharmony_ci# The default value is: NO. 1008cb93a386Sopenharmony_ci 1009cb93a386Sopenharmony_ciSOURCE_BROWSER = NO 1010cb93a386Sopenharmony_ci 1011cb93a386Sopenharmony_ci# Setting the INLINE_SOURCES tag to YES will include the body of functions, 1012cb93a386Sopenharmony_ci# classes and enums directly into the documentation. 1013cb93a386Sopenharmony_ci# The default value is: NO. 1014cb93a386Sopenharmony_ci 1015cb93a386Sopenharmony_ciINLINE_SOURCES = NO 1016cb93a386Sopenharmony_ci 1017cb93a386Sopenharmony_ci# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 1018cb93a386Sopenharmony_ci# special comment blocks from generated source code fragments. Normal C, C++ and 1019cb93a386Sopenharmony_ci# Fortran comments will always remain visible. 1020cb93a386Sopenharmony_ci# The default value is: YES. 1021cb93a386Sopenharmony_ci 1022cb93a386Sopenharmony_ciSTRIP_CODE_COMMENTS = YES 1023cb93a386Sopenharmony_ci 1024cb93a386Sopenharmony_ci# If the REFERENCED_BY_RELATION tag is set to YES then for each documented 1025cb93a386Sopenharmony_ci# function all documented functions referencing it will be listed. 1026cb93a386Sopenharmony_ci# The default value is: NO. 1027cb93a386Sopenharmony_ci 1028cb93a386Sopenharmony_ciREFERENCED_BY_RELATION = NO 1029cb93a386Sopenharmony_ci 1030cb93a386Sopenharmony_ci# If the REFERENCES_RELATION tag is set to YES then for each documented function 1031cb93a386Sopenharmony_ci# all documented entities called/used by that function will be listed. 1032cb93a386Sopenharmony_ci# The default value is: NO. 1033cb93a386Sopenharmony_ci 1034cb93a386Sopenharmony_ciREFERENCES_RELATION = NO 1035cb93a386Sopenharmony_ci 1036cb93a386Sopenharmony_ci# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1037cb93a386Sopenharmony_ci# to YES then the hyperlinks from functions in REFERENCES_RELATION and 1038cb93a386Sopenharmony_ci# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1039cb93a386Sopenharmony_ci# link to the documentation. 1040cb93a386Sopenharmony_ci# The default value is: YES. 1041cb93a386Sopenharmony_ci 1042cb93a386Sopenharmony_ciREFERENCES_LINK_SOURCE = YES 1043cb93a386Sopenharmony_ci 1044cb93a386Sopenharmony_ci# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1045cb93a386Sopenharmony_ci# source code will show a tooltip with additional information such as prototype, 1046cb93a386Sopenharmony_ci# brief description and links to the definition and documentation. Since this 1047cb93a386Sopenharmony_ci# will make the HTML file larger and loading of large files a bit slower, you 1048cb93a386Sopenharmony_ci# can opt to disable this feature. 1049cb93a386Sopenharmony_ci# The default value is: YES. 1050cb93a386Sopenharmony_ci# This tag requires that the tag SOURCE_BROWSER is set to YES. 1051cb93a386Sopenharmony_ci 1052cb93a386Sopenharmony_ciSOURCE_TOOLTIPS = YES 1053cb93a386Sopenharmony_ci 1054cb93a386Sopenharmony_ci# If the USE_HTAGS tag is set to YES then the references to source code will 1055cb93a386Sopenharmony_ci# point to the HTML generated by the htags(1) tool instead of doxygen built-in 1056cb93a386Sopenharmony_ci# source browser. The htags tool is part of GNU's global source tagging system 1057cb93a386Sopenharmony_ci# (see http://www.gnu.org/software/global/global.html). You will need version 1058cb93a386Sopenharmony_ci# 4.8.6 or higher. 1059cb93a386Sopenharmony_ci# 1060cb93a386Sopenharmony_ci# To use it do the following: 1061cb93a386Sopenharmony_ci# - Install the latest version of global 1062cb93a386Sopenharmony_ci# - Enable SOURCE_BROWSER and USE_HTAGS in the config file 1063cb93a386Sopenharmony_ci# - Make sure the INPUT points to the root of the source tree 1064cb93a386Sopenharmony_ci# - Run doxygen as normal 1065cb93a386Sopenharmony_ci# 1066cb93a386Sopenharmony_ci# Doxygen will invoke htags (and that will in turn invoke gtags), so these 1067cb93a386Sopenharmony_ci# tools must be available from the command line (i.e. in the search path). 1068cb93a386Sopenharmony_ci# 1069cb93a386Sopenharmony_ci# The result: instead of the source browser generated by doxygen, the links to 1070cb93a386Sopenharmony_ci# source code will now point to the output of htags. 1071cb93a386Sopenharmony_ci# The default value is: NO. 1072cb93a386Sopenharmony_ci# This tag requires that the tag SOURCE_BROWSER is set to YES. 1073cb93a386Sopenharmony_ci 1074cb93a386Sopenharmony_ciUSE_HTAGS = NO 1075cb93a386Sopenharmony_ci 1076cb93a386Sopenharmony_ci# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1077cb93a386Sopenharmony_ci# verbatim copy of the header file for each class for which an include is 1078cb93a386Sopenharmony_ci# specified. Set to NO to disable this. 1079cb93a386Sopenharmony_ci# See also: Section \class. 1080cb93a386Sopenharmony_ci# The default value is: YES. 1081cb93a386Sopenharmony_ci 1082cb93a386Sopenharmony_ciVERBATIM_HEADERS = YES 1083cb93a386Sopenharmony_ci 1084cb93a386Sopenharmony_ci# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the 1085cb93a386Sopenharmony_ci# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the 1086cb93a386Sopenharmony_ci# cost of reduced performance. This can be particularly helpful with template 1087cb93a386Sopenharmony_ci# rich C++ code for which doxygen's built-in parser lacks the necessary type 1088cb93a386Sopenharmony_ci# information. 1089cb93a386Sopenharmony_ci# Note: The availability of this option depends on whether or not doxygen was 1090cb93a386Sopenharmony_ci# generated with the -Duse-libclang=ON option for CMake. 1091cb93a386Sopenharmony_ci# The default value is: NO. 1092cb93a386Sopenharmony_ci 1093cb93a386Sopenharmony_ciCLANG_ASSISTED_PARSING = NO 1094cb93a386Sopenharmony_ci 1095cb93a386Sopenharmony_ci# If clang assisted parsing is enabled you can provide the compiler with command 1096cb93a386Sopenharmony_ci# line options that you would normally use when invoking the compiler. Note that 1097cb93a386Sopenharmony_ci# the include paths will already be set by doxygen for the files and directories 1098cb93a386Sopenharmony_ci# specified with INPUT and INCLUDE_PATH. 1099cb93a386Sopenharmony_ci# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. 1100cb93a386Sopenharmony_ci 1101cb93a386Sopenharmony_ciCLANG_OPTIONS = 1102cb93a386Sopenharmony_ci 1103cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 1104cb93a386Sopenharmony_ci# Configuration options related to the alphabetical class index 1105cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 1106cb93a386Sopenharmony_ci 1107cb93a386Sopenharmony_ci# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1108cb93a386Sopenharmony_ci# compounds will be generated. Enable this if the project contains a lot of 1109cb93a386Sopenharmony_ci# classes, structs, unions or interfaces. 1110cb93a386Sopenharmony_ci# The default value is: YES. 1111cb93a386Sopenharmony_ci 1112cb93a386Sopenharmony_ciALPHABETICAL_INDEX = YES 1113cb93a386Sopenharmony_ci 1114cb93a386Sopenharmony_ci# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1115cb93a386Sopenharmony_ci# which the alphabetical index list will be split. 1116cb93a386Sopenharmony_ci# Minimum value: 1, maximum value: 20, default value: 5. 1117cb93a386Sopenharmony_ci# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1118cb93a386Sopenharmony_ci 1119cb93a386Sopenharmony_ciCOLS_IN_ALPHA_INDEX = 5 1120cb93a386Sopenharmony_ci 1121cb93a386Sopenharmony_ci# In case all classes in a project start with a common prefix, all classes will 1122cb93a386Sopenharmony_ci# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1123cb93a386Sopenharmony_ci# can be used to specify a prefix (or a list of prefixes) that should be ignored 1124cb93a386Sopenharmony_ci# while generating the index headers. 1125cb93a386Sopenharmony_ci# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1126cb93a386Sopenharmony_ci 1127cb93a386Sopenharmony_ciIGNORE_PREFIX = 1128cb93a386Sopenharmony_ci 1129cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 1130cb93a386Sopenharmony_ci# Configuration options related to the HTML output 1131cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 1132cb93a386Sopenharmony_ci 1133cb93a386Sopenharmony_ci# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1134cb93a386Sopenharmony_ci# The default value is: YES. 1135cb93a386Sopenharmony_ci 1136cb93a386Sopenharmony_ciGENERATE_HTML = YES 1137cb93a386Sopenharmony_ci 1138cb93a386Sopenharmony_ci# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1139cb93a386Sopenharmony_ci# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1140cb93a386Sopenharmony_ci# it. 1141cb93a386Sopenharmony_ci# The default directory is: html. 1142cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1143cb93a386Sopenharmony_ci 1144cb93a386Sopenharmony_ciHTML_OUTPUT = html 1145cb93a386Sopenharmony_ci 1146cb93a386Sopenharmony_ci# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1147cb93a386Sopenharmony_ci# generated HTML page (for example: .htm, .php, .asp). 1148cb93a386Sopenharmony_ci# The default value is: .html. 1149cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1150cb93a386Sopenharmony_ci 1151cb93a386Sopenharmony_ciHTML_FILE_EXTENSION = .html 1152cb93a386Sopenharmony_ci 1153cb93a386Sopenharmony_ci# The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1154cb93a386Sopenharmony_ci# each generated HTML page. If the tag is left blank doxygen will generate a 1155cb93a386Sopenharmony_ci# standard header. 1156cb93a386Sopenharmony_ci# 1157cb93a386Sopenharmony_ci# To get valid HTML the header file that includes any scripts and style sheets 1158cb93a386Sopenharmony_ci# that doxygen needs, which is dependent on the configuration options used (e.g. 1159cb93a386Sopenharmony_ci# the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1160cb93a386Sopenharmony_ci# default header using 1161cb93a386Sopenharmony_ci# doxygen -w html new_header.html new_footer.html new_stylesheet.css 1162cb93a386Sopenharmony_ci# YourConfigFile 1163cb93a386Sopenharmony_ci# and then modify the file new_header.html. See also section "Doxygen usage" 1164cb93a386Sopenharmony_ci# for information on how to generate the default header that doxygen normally 1165cb93a386Sopenharmony_ci# uses. 1166cb93a386Sopenharmony_ci# Note: The header is subject to change so you typically have to regenerate the 1167cb93a386Sopenharmony_ci# default header when upgrading to a newer version of doxygen. For a description 1168cb93a386Sopenharmony_ci# of the possible markers and block names see the documentation. 1169cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1170cb93a386Sopenharmony_ci 1171cb93a386Sopenharmony_ciHTML_HEADER = 1172cb93a386Sopenharmony_ci 1173cb93a386Sopenharmony_ci# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1174cb93a386Sopenharmony_ci# generated HTML page. If the tag is left blank doxygen will generate a standard 1175cb93a386Sopenharmony_ci# footer. See HTML_HEADER for more information on how to generate a default 1176cb93a386Sopenharmony_ci# footer and what special commands can be used inside the footer. See also 1177cb93a386Sopenharmony_ci# section "Doxygen usage" for information on how to generate the default footer 1178cb93a386Sopenharmony_ci# that doxygen normally uses. 1179cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1180cb93a386Sopenharmony_ci 1181cb93a386Sopenharmony_ciHTML_FOOTER = ./footer.html 1182cb93a386Sopenharmony_ci 1183cb93a386Sopenharmony_ci# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1184cb93a386Sopenharmony_ci# sheet that is used by each HTML page. It can be used to fine-tune the look of 1185cb93a386Sopenharmony_ci# the HTML output. If left blank doxygen will generate a default style sheet. 1186cb93a386Sopenharmony_ci# See also section "Doxygen usage" for information on how to generate the style 1187cb93a386Sopenharmony_ci# sheet that doxygen normally uses. 1188cb93a386Sopenharmony_ci# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1189cb93a386Sopenharmony_ci# it is more robust and this tag (HTML_STYLESHEET) will in the future become 1190cb93a386Sopenharmony_ci# obsolete. 1191cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1192cb93a386Sopenharmony_ci 1193cb93a386Sopenharmony_ciHTML_STYLESHEET = 1194cb93a386Sopenharmony_ci 1195cb93a386Sopenharmony_ci# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1196cb93a386Sopenharmony_ci# cascading style sheets that are included after the standard style sheets 1197cb93a386Sopenharmony_ci# created by doxygen. Using this option one can overrule certain style aspects. 1198cb93a386Sopenharmony_ci# This is preferred over using HTML_STYLESHEET since it does not replace the 1199cb93a386Sopenharmony_ci# standard style sheet and is therefore more robust against future updates. 1200cb93a386Sopenharmony_ci# Doxygen will copy the style sheet files to the output directory. 1201cb93a386Sopenharmony_ci# Note: The order of the extra style sheet files is of importance (e.g. the last 1202cb93a386Sopenharmony_ci# style sheet in the list overrules the setting of the previous ones in the 1203cb93a386Sopenharmony_ci# list). For an example see the documentation. 1204cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1205cb93a386Sopenharmony_ci 1206cb93a386Sopenharmony_ciHTML_EXTRA_STYLESHEET = ./customdoxygen.css 1207cb93a386Sopenharmony_ci 1208cb93a386Sopenharmony_ci# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1209cb93a386Sopenharmony_ci# other source files which should be copied to the HTML output directory. Note 1210cb93a386Sopenharmony_ci# that these files will be copied to the base HTML output directory. Use the 1211cb93a386Sopenharmony_ci# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1212cb93a386Sopenharmony_ci# files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1213cb93a386Sopenharmony_ci# files will be copied as-is; there are no commands or markers available. 1214cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1215cb93a386Sopenharmony_ci 1216cb93a386Sopenharmony_ciHTML_EXTRA_FILES = 1217cb93a386Sopenharmony_ci 1218cb93a386Sopenharmony_ci# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1219cb93a386Sopenharmony_ci# will adjust the colors in the style sheet and background images according to 1220cb93a386Sopenharmony_ci# this color. Hue is specified as an angle on a colorwheel, see 1221cb93a386Sopenharmony_ci# http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1222cb93a386Sopenharmony_ci# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1223cb93a386Sopenharmony_ci# purple, and 360 is red again. 1224cb93a386Sopenharmony_ci# Minimum value: 0, maximum value: 359, default value: 220. 1225cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1226cb93a386Sopenharmony_ci 1227cb93a386Sopenharmony_ciHTML_COLORSTYLE_HUE = 220 1228cb93a386Sopenharmony_ci 1229cb93a386Sopenharmony_ci# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1230cb93a386Sopenharmony_ci# in the HTML output. For a value of 0 the output will use grayscales only. A 1231cb93a386Sopenharmony_ci# value of 255 will produce the most vivid colors. 1232cb93a386Sopenharmony_ci# Minimum value: 0, maximum value: 255, default value: 100. 1233cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1234cb93a386Sopenharmony_ci 1235cb93a386Sopenharmony_ciHTML_COLORSTYLE_SAT = 100 1236cb93a386Sopenharmony_ci 1237cb93a386Sopenharmony_ci# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1238cb93a386Sopenharmony_ci# luminance component of the colors in the HTML output. Values below 100 1239cb93a386Sopenharmony_ci# gradually make the output lighter, whereas values above 100 make the output 1240cb93a386Sopenharmony_ci# darker. The value divided by 100 is the actual gamma applied, so 80 represents 1241cb93a386Sopenharmony_ci# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1242cb93a386Sopenharmony_ci# change the gamma. 1243cb93a386Sopenharmony_ci# Minimum value: 40, maximum value: 240, default value: 80. 1244cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1245cb93a386Sopenharmony_ci 1246cb93a386Sopenharmony_ciHTML_COLORSTYLE_GAMMA = 80 1247cb93a386Sopenharmony_ci 1248cb93a386Sopenharmony_ci# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1249cb93a386Sopenharmony_ci# page will contain the date and time when the page was generated. Setting this 1250cb93a386Sopenharmony_ci# to YES can help to show when doxygen was last run and thus if the 1251cb93a386Sopenharmony_ci# documentation is up to date. 1252cb93a386Sopenharmony_ci# The default value is: NO. 1253cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1254cb93a386Sopenharmony_ci 1255cb93a386Sopenharmony_ciHTML_TIMESTAMP = NO 1256cb93a386Sopenharmony_ci 1257cb93a386Sopenharmony_ci# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1258cb93a386Sopenharmony_ci# documentation will contain sections that can be hidden and shown after the 1259cb93a386Sopenharmony_ci# page has loaded. 1260cb93a386Sopenharmony_ci# The default value is: NO. 1261cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1262cb93a386Sopenharmony_ci 1263cb93a386Sopenharmony_ciHTML_DYNAMIC_SECTIONS = NO 1264cb93a386Sopenharmony_ci 1265cb93a386Sopenharmony_ci# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1266cb93a386Sopenharmony_ci# shown in the various tree structured indices initially; the user can expand 1267cb93a386Sopenharmony_ci# and collapse entries dynamically later on. Doxygen will expand the tree to 1268cb93a386Sopenharmony_ci# such a level that at most the specified number of entries are visible (unless 1269cb93a386Sopenharmony_ci# a fully collapsed tree already exceeds this amount). So setting the number of 1270cb93a386Sopenharmony_ci# entries 1 will produce a full collapsed tree by default. 0 is a special value 1271cb93a386Sopenharmony_ci# representing an infinite number of entries and will result in a full expanded 1272cb93a386Sopenharmony_ci# tree by default. 1273cb93a386Sopenharmony_ci# Minimum value: 0, maximum value: 9999, default value: 100. 1274cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1275cb93a386Sopenharmony_ci 1276cb93a386Sopenharmony_ciHTML_INDEX_NUM_ENTRIES = 100 1277cb93a386Sopenharmony_ci 1278cb93a386Sopenharmony_ci# If the GENERATE_DOCSET tag is set to YES, additional index files will be 1279cb93a386Sopenharmony_ci# generated that can be used as input for Apple's Xcode 3 integrated development 1280cb93a386Sopenharmony_ci# environment (see: http://developer.apple.com/tools/xcode/), introduced with 1281cb93a386Sopenharmony_ci# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1282cb93a386Sopenharmony_ci# Makefile in the HTML output directory. Running make will produce the docset in 1283cb93a386Sopenharmony_ci# that directory and running make install will install the docset in 1284cb93a386Sopenharmony_ci# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1285cb93a386Sopenharmony_ci# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1286cb93a386Sopenharmony_ci# for more information. 1287cb93a386Sopenharmony_ci# The default value is: NO. 1288cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1289cb93a386Sopenharmony_ci 1290cb93a386Sopenharmony_ciGENERATE_DOCSET = NO 1291cb93a386Sopenharmony_ci 1292cb93a386Sopenharmony_ci# This tag determines the name of the docset feed. A documentation feed provides 1293cb93a386Sopenharmony_ci# an umbrella under which multiple documentation sets from a single provider 1294cb93a386Sopenharmony_ci# (such as a company or product suite) can be grouped. 1295cb93a386Sopenharmony_ci# The default value is: Doxygen generated docs. 1296cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_DOCSET is set to YES. 1297cb93a386Sopenharmony_ci 1298cb93a386Sopenharmony_ciDOCSET_FEEDNAME = "Doxygen generated docs" 1299cb93a386Sopenharmony_ci 1300cb93a386Sopenharmony_ci# This tag specifies a string that should uniquely identify the documentation 1301cb93a386Sopenharmony_ci# set bundle. This should be a reverse domain-name style string, e.g. 1302cb93a386Sopenharmony_ci# com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1303cb93a386Sopenharmony_ci# The default value is: org.doxygen.Project. 1304cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_DOCSET is set to YES. 1305cb93a386Sopenharmony_ci 1306cb93a386Sopenharmony_ciDOCSET_BUNDLE_ID = org.doxygen.Project 1307cb93a386Sopenharmony_ci 1308cb93a386Sopenharmony_ci# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1309cb93a386Sopenharmony_ci# the documentation publisher. This should be a reverse domain-name style 1310cb93a386Sopenharmony_ci# string, e.g. com.mycompany.MyDocSet.documentation. 1311cb93a386Sopenharmony_ci# The default value is: org.doxygen.Publisher. 1312cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_DOCSET is set to YES. 1313cb93a386Sopenharmony_ci 1314cb93a386Sopenharmony_ciDOCSET_PUBLISHER_ID = org.doxygen.Publisher 1315cb93a386Sopenharmony_ci 1316cb93a386Sopenharmony_ci# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1317cb93a386Sopenharmony_ci# The default value is: Publisher. 1318cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_DOCSET is set to YES. 1319cb93a386Sopenharmony_ci 1320cb93a386Sopenharmony_ciDOCSET_PUBLISHER_NAME = Publisher 1321cb93a386Sopenharmony_ci 1322cb93a386Sopenharmony_ci# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1323cb93a386Sopenharmony_ci# additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1324cb93a386Sopenharmony_ci# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1325cb93a386Sopenharmony_ci# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1326cb93a386Sopenharmony_ci# Windows. 1327cb93a386Sopenharmony_ci# 1328cb93a386Sopenharmony_ci# The HTML Help Workshop contains a compiler that can convert all HTML output 1329cb93a386Sopenharmony_ci# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1330cb93a386Sopenharmony_ci# files are now used as the Windows 98 help format, and will replace the old 1331cb93a386Sopenharmony_ci# Windows help format (.hlp) on all Windows platforms in the future. Compressed 1332cb93a386Sopenharmony_ci# HTML files also contain an index, a table of contents, and you can search for 1333cb93a386Sopenharmony_ci# words in the documentation. The HTML workshop also contains a viewer for 1334cb93a386Sopenharmony_ci# compressed HTML files. 1335cb93a386Sopenharmony_ci# The default value is: NO. 1336cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1337cb93a386Sopenharmony_ci 1338cb93a386Sopenharmony_ciGENERATE_HTMLHELP = NO 1339cb93a386Sopenharmony_ci 1340cb93a386Sopenharmony_ci# The CHM_FILE tag can be used to specify the file name of the resulting .chm 1341cb93a386Sopenharmony_ci# file. You can add a path in front of the file if the result should not be 1342cb93a386Sopenharmony_ci# written to the html output directory. 1343cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1344cb93a386Sopenharmony_ci 1345cb93a386Sopenharmony_ciCHM_FILE = 1346cb93a386Sopenharmony_ci 1347cb93a386Sopenharmony_ci# The HHC_LOCATION tag can be used to specify the location (absolute path 1348cb93a386Sopenharmony_ci# including file name) of the HTML help compiler (hhc.exe). If non-empty, 1349cb93a386Sopenharmony_ci# doxygen will try to run the HTML help compiler on the generated index.hhp. 1350cb93a386Sopenharmony_ci# The file has to be specified with full path. 1351cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1352cb93a386Sopenharmony_ci 1353cb93a386Sopenharmony_ciHHC_LOCATION = 1354cb93a386Sopenharmony_ci 1355cb93a386Sopenharmony_ci# The GENERATE_CHI flag controls if a separate .chi index file is generated 1356cb93a386Sopenharmony_ci# (YES) or that it should be included in the main .chm file (NO). 1357cb93a386Sopenharmony_ci# The default value is: NO. 1358cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1359cb93a386Sopenharmony_ci 1360cb93a386Sopenharmony_ciGENERATE_CHI = NO 1361cb93a386Sopenharmony_ci 1362cb93a386Sopenharmony_ci# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1363cb93a386Sopenharmony_ci# and project file content. 1364cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1365cb93a386Sopenharmony_ci 1366cb93a386Sopenharmony_ciCHM_INDEX_ENCODING = 1367cb93a386Sopenharmony_ci 1368cb93a386Sopenharmony_ci# The BINARY_TOC flag controls whether a binary table of contents is generated 1369cb93a386Sopenharmony_ci# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1370cb93a386Sopenharmony_ci# enables the Previous and Next buttons. 1371cb93a386Sopenharmony_ci# The default value is: NO. 1372cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1373cb93a386Sopenharmony_ci 1374cb93a386Sopenharmony_ciBINARY_TOC = NO 1375cb93a386Sopenharmony_ci 1376cb93a386Sopenharmony_ci# The TOC_EXPAND flag can be set to YES to add extra items for group members to 1377cb93a386Sopenharmony_ci# the table of contents of the HTML help documentation and to the tree view. 1378cb93a386Sopenharmony_ci# The default value is: NO. 1379cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1380cb93a386Sopenharmony_ci 1381cb93a386Sopenharmony_ciTOC_EXPAND = NO 1382cb93a386Sopenharmony_ci 1383cb93a386Sopenharmony_ci# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1384cb93a386Sopenharmony_ci# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1385cb93a386Sopenharmony_ci# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1386cb93a386Sopenharmony_ci# (.qch) of the generated HTML documentation. 1387cb93a386Sopenharmony_ci# The default value is: NO. 1388cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1389cb93a386Sopenharmony_ci 1390cb93a386Sopenharmony_ciGENERATE_QHP = NO 1391cb93a386Sopenharmony_ci 1392cb93a386Sopenharmony_ci# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1393cb93a386Sopenharmony_ci# the file name of the resulting .qch file. The path specified is relative to 1394cb93a386Sopenharmony_ci# the HTML output folder. 1395cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_QHP is set to YES. 1396cb93a386Sopenharmony_ci 1397cb93a386Sopenharmony_ciQCH_FILE = 1398cb93a386Sopenharmony_ci 1399cb93a386Sopenharmony_ci# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1400cb93a386Sopenharmony_ci# Project output. For more information please see Qt Help Project / Namespace 1401cb93a386Sopenharmony_ci# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1402cb93a386Sopenharmony_ci# The default value is: org.doxygen.Project. 1403cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_QHP is set to YES. 1404cb93a386Sopenharmony_ci 1405cb93a386Sopenharmony_ciQHP_NAMESPACE = org.doxygen.Project 1406cb93a386Sopenharmony_ci 1407cb93a386Sopenharmony_ci# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1408cb93a386Sopenharmony_ci# Help Project output. For more information please see Qt Help Project / Virtual 1409cb93a386Sopenharmony_ci# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1410cb93a386Sopenharmony_ci# folders). 1411cb93a386Sopenharmony_ci# The default value is: doc. 1412cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_QHP is set to YES. 1413cb93a386Sopenharmony_ci 1414cb93a386Sopenharmony_ciQHP_VIRTUAL_FOLDER = doc 1415cb93a386Sopenharmony_ci 1416cb93a386Sopenharmony_ci# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1417cb93a386Sopenharmony_ci# filter to add. For more information please see Qt Help Project / Custom 1418cb93a386Sopenharmony_ci# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1419cb93a386Sopenharmony_ci# filters). 1420cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_QHP is set to YES. 1421cb93a386Sopenharmony_ci 1422cb93a386Sopenharmony_ciQHP_CUST_FILTER_NAME = 1423cb93a386Sopenharmony_ci 1424cb93a386Sopenharmony_ci# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1425cb93a386Sopenharmony_ci# custom filter to add. For more information please see Qt Help Project / Custom 1426cb93a386Sopenharmony_ci# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1427cb93a386Sopenharmony_ci# filters). 1428cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_QHP is set to YES. 1429cb93a386Sopenharmony_ci 1430cb93a386Sopenharmony_ciQHP_CUST_FILTER_ATTRS = 1431cb93a386Sopenharmony_ci 1432cb93a386Sopenharmony_ci# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1433cb93a386Sopenharmony_ci# project's filter section matches. Qt Help Project / Filter Attributes (see: 1434cb93a386Sopenharmony_ci# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1435cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_QHP is set to YES. 1436cb93a386Sopenharmony_ci 1437cb93a386Sopenharmony_ciQHP_SECT_FILTER_ATTRS = 1438cb93a386Sopenharmony_ci 1439cb93a386Sopenharmony_ci# The QHG_LOCATION tag can be used to specify the location of Qt's 1440cb93a386Sopenharmony_ci# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1441cb93a386Sopenharmony_ci# generated .qhp file. 1442cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_QHP is set to YES. 1443cb93a386Sopenharmony_ci 1444cb93a386Sopenharmony_ciQHG_LOCATION = 1445cb93a386Sopenharmony_ci 1446cb93a386Sopenharmony_ci# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1447cb93a386Sopenharmony_ci# generated, together with the HTML files, they form an Eclipse help plugin. To 1448cb93a386Sopenharmony_ci# install this plugin and make it available under the help contents menu in 1449cb93a386Sopenharmony_ci# Eclipse, the contents of the directory containing the HTML and XML files needs 1450cb93a386Sopenharmony_ci# to be copied into the plugins directory of eclipse. The name of the directory 1451cb93a386Sopenharmony_ci# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1452cb93a386Sopenharmony_ci# After copying Eclipse needs to be restarted before the help appears. 1453cb93a386Sopenharmony_ci# The default value is: NO. 1454cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1455cb93a386Sopenharmony_ci 1456cb93a386Sopenharmony_ciGENERATE_ECLIPSEHELP = NO 1457cb93a386Sopenharmony_ci 1458cb93a386Sopenharmony_ci# A unique identifier for the Eclipse help plugin. When installing the plugin 1459cb93a386Sopenharmony_ci# the directory name containing the HTML and XML files should also have this 1460cb93a386Sopenharmony_ci# name. Each documentation set should have its own identifier. 1461cb93a386Sopenharmony_ci# The default value is: org.doxygen.Project. 1462cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1463cb93a386Sopenharmony_ci 1464cb93a386Sopenharmony_ciECLIPSE_DOC_ID = org.doxygen.Project 1465cb93a386Sopenharmony_ci 1466cb93a386Sopenharmony_ci# If you want full control over the layout of the generated HTML pages it might 1467cb93a386Sopenharmony_ci# be necessary to disable the index and replace it with your own. The 1468cb93a386Sopenharmony_ci# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1469cb93a386Sopenharmony_ci# of each HTML page. A value of NO enables the index and the value YES disables 1470cb93a386Sopenharmony_ci# it. Since the tabs in the index contain the same information as the navigation 1471cb93a386Sopenharmony_ci# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1472cb93a386Sopenharmony_ci# The default value is: NO. 1473cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1474cb93a386Sopenharmony_ci 1475cb93a386Sopenharmony_ciDISABLE_INDEX = NO 1476cb93a386Sopenharmony_ci 1477cb93a386Sopenharmony_ci# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1478cb93a386Sopenharmony_ci# structure should be generated to display hierarchical information. If the tag 1479cb93a386Sopenharmony_ci# value is set to YES, a side panel will be generated containing a tree-like 1480cb93a386Sopenharmony_ci# index structure (just like the one that is generated for HTML Help). For this 1481cb93a386Sopenharmony_ci# to work a browser that supports JavaScript, DHTML, CSS and frames is required 1482cb93a386Sopenharmony_ci# (i.e. any modern browser). Windows users are probably better off using the 1483cb93a386Sopenharmony_ci# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1484cb93a386Sopenharmony_ci# further fine-tune the look of the index. As an example, the default style 1485cb93a386Sopenharmony_ci# sheet generated by doxygen has an example that shows how to put an image at 1486cb93a386Sopenharmony_ci# the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1487cb93a386Sopenharmony_ci# the same information as the tab index, you could consider setting 1488cb93a386Sopenharmony_ci# DISABLE_INDEX to YES when enabling this option. 1489cb93a386Sopenharmony_ci# The default value is: NO. 1490cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1491cb93a386Sopenharmony_ci 1492cb93a386Sopenharmony_ciGENERATE_TREEVIEW = YES 1493cb93a386Sopenharmony_ci 1494cb93a386Sopenharmony_ci# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1495cb93a386Sopenharmony_ci# doxygen will group on one line in the generated HTML documentation. 1496cb93a386Sopenharmony_ci# 1497cb93a386Sopenharmony_ci# Note that a value of 0 will completely suppress the enum values from appearing 1498cb93a386Sopenharmony_ci# in the overview section. 1499cb93a386Sopenharmony_ci# Minimum value: 0, maximum value: 20, default value: 4. 1500cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1501cb93a386Sopenharmony_ci 1502cb93a386Sopenharmony_ciENUM_VALUES_PER_LINE = 4 1503cb93a386Sopenharmony_ci 1504cb93a386Sopenharmony_ci# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1505cb93a386Sopenharmony_ci# to set the initial width (in pixels) of the frame in which the tree is shown. 1506cb93a386Sopenharmony_ci# Minimum value: 0, maximum value: 1500, default value: 250. 1507cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1508cb93a386Sopenharmony_ci 1509cb93a386Sopenharmony_ciTREEVIEW_WIDTH = 250 1510cb93a386Sopenharmony_ci 1511cb93a386Sopenharmony_ci# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1512cb93a386Sopenharmony_ci# external symbols imported via tag files in a separate window. 1513cb93a386Sopenharmony_ci# The default value is: NO. 1514cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1515cb93a386Sopenharmony_ci 1516cb93a386Sopenharmony_ciEXT_LINKS_IN_WINDOW = NO 1517cb93a386Sopenharmony_ci 1518cb93a386Sopenharmony_ci# Use this tag to change the font size of LaTeX formulas included as images in 1519cb93a386Sopenharmony_ci# the HTML documentation. When you change the font size after a successful 1520cb93a386Sopenharmony_ci# doxygen run you need to manually remove any form_*.png images from the HTML 1521cb93a386Sopenharmony_ci# output directory to force them to be regenerated. 1522cb93a386Sopenharmony_ci# Minimum value: 8, maximum value: 50, default value: 10. 1523cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1524cb93a386Sopenharmony_ci 1525cb93a386Sopenharmony_ciFORMULA_FONTSIZE = 10 1526cb93a386Sopenharmony_ci 1527cb93a386Sopenharmony_ci# Use the FORMULA_TRANPARENT tag to determine whether or not the images 1528cb93a386Sopenharmony_ci# generated for formulas are transparent PNGs. Transparent PNGs are not 1529cb93a386Sopenharmony_ci# supported properly for IE 6.0, but are supported on all modern browsers. 1530cb93a386Sopenharmony_ci# 1531cb93a386Sopenharmony_ci# Note that when changing this option you need to delete any form_*.png files in 1532cb93a386Sopenharmony_ci# the HTML output directory before the changes have effect. 1533cb93a386Sopenharmony_ci# The default value is: YES. 1534cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1535cb93a386Sopenharmony_ci 1536cb93a386Sopenharmony_ciFORMULA_TRANSPARENT = YES 1537cb93a386Sopenharmony_ci 1538cb93a386Sopenharmony_ci# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1539cb93a386Sopenharmony_ci# http://www.mathjax.org) which uses client side Javascript for the rendering 1540cb93a386Sopenharmony_ci# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1541cb93a386Sopenharmony_ci# installed or if you want to formulas look prettier in the HTML output. When 1542cb93a386Sopenharmony_ci# enabled you may also need to install MathJax separately and configure the path 1543cb93a386Sopenharmony_ci# to it using the MATHJAX_RELPATH option. 1544cb93a386Sopenharmony_ci# The default value is: NO. 1545cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1546cb93a386Sopenharmony_ci 1547cb93a386Sopenharmony_ciUSE_MATHJAX = NO 1548cb93a386Sopenharmony_ci 1549cb93a386Sopenharmony_ci# When MathJax is enabled you can set the default output format to be used for 1550cb93a386Sopenharmony_ci# the MathJax output. See the MathJax site (see: 1551cb93a386Sopenharmony_ci# http://docs.mathjax.org/en/latest/output.html) for more details. 1552cb93a386Sopenharmony_ci# Possible values are: HTML-CSS (which is slower, but has the best 1553cb93a386Sopenharmony_ci# compatibility), NativeMML (i.e. MathML) and SVG. 1554cb93a386Sopenharmony_ci# The default value is: HTML-CSS. 1555cb93a386Sopenharmony_ci# This tag requires that the tag USE_MATHJAX is set to YES. 1556cb93a386Sopenharmony_ci 1557cb93a386Sopenharmony_ciMATHJAX_FORMAT = HTML-CSS 1558cb93a386Sopenharmony_ci 1559cb93a386Sopenharmony_ci# When MathJax is enabled you need to specify the location relative to the HTML 1560cb93a386Sopenharmony_ci# output directory using the MATHJAX_RELPATH option. The destination directory 1561cb93a386Sopenharmony_ci# should contain the MathJax.js script. For instance, if the mathjax directory 1562cb93a386Sopenharmony_ci# is located at the same level as the HTML output directory, then 1563cb93a386Sopenharmony_ci# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1564cb93a386Sopenharmony_ci# Content Delivery Network so you can quickly see the result without installing 1565cb93a386Sopenharmony_ci# MathJax. However, it is strongly recommended to install a local copy of 1566cb93a386Sopenharmony_ci# MathJax from http://www.mathjax.org before deployment. 1567cb93a386Sopenharmony_ci# The default value is: http://cdn.mathjax.org/mathjax/latest. 1568cb93a386Sopenharmony_ci# This tag requires that the tag USE_MATHJAX is set to YES. 1569cb93a386Sopenharmony_ci 1570cb93a386Sopenharmony_ciMATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1571cb93a386Sopenharmony_ci 1572cb93a386Sopenharmony_ci# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1573cb93a386Sopenharmony_ci# extension names that should be enabled during MathJax rendering. For example 1574cb93a386Sopenharmony_ci# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1575cb93a386Sopenharmony_ci# This tag requires that the tag USE_MATHJAX is set to YES. 1576cb93a386Sopenharmony_ci 1577cb93a386Sopenharmony_ciMATHJAX_EXTENSIONS = 1578cb93a386Sopenharmony_ci 1579cb93a386Sopenharmony_ci# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1580cb93a386Sopenharmony_ci# of code that will be used on startup of the MathJax code. See the MathJax site 1581cb93a386Sopenharmony_ci# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1582cb93a386Sopenharmony_ci# example see the documentation. 1583cb93a386Sopenharmony_ci# This tag requires that the tag USE_MATHJAX is set to YES. 1584cb93a386Sopenharmony_ci 1585cb93a386Sopenharmony_ciMATHJAX_CODEFILE = 1586cb93a386Sopenharmony_ci 1587cb93a386Sopenharmony_ci# When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1588cb93a386Sopenharmony_ci# the HTML output. The underlying search engine uses javascript and DHTML and 1589cb93a386Sopenharmony_ci# should work on any modern browser. Note that when using HTML help 1590cb93a386Sopenharmony_ci# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1591cb93a386Sopenharmony_ci# there is already a search function so this one should typically be disabled. 1592cb93a386Sopenharmony_ci# For large projects the javascript based search engine can be slow, then 1593cb93a386Sopenharmony_ci# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1594cb93a386Sopenharmony_ci# search using the keyboard; to jump to the search box use <access key> + S 1595cb93a386Sopenharmony_ci# (what the <access key> is depends on the OS and browser, but it is typically 1596cb93a386Sopenharmony_ci# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down 1597cb93a386Sopenharmony_ci# key> to jump into the search results window, the results can be navigated 1598cb93a386Sopenharmony_ci# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel 1599cb93a386Sopenharmony_ci# the search. The filter options can be selected when the cursor is inside the 1600cb93a386Sopenharmony_ci# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> 1601cb93a386Sopenharmony_ci# to select a filter and <Enter> or <escape> to activate or cancel the filter 1602cb93a386Sopenharmony_ci# option. 1603cb93a386Sopenharmony_ci# The default value is: YES. 1604cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1605cb93a386Sopenharmony_ci 1606cb93a386Sopenharmony_ciSEARCHENGINE = YES 1607cb93a386Sopenharmony_ci 1608cb93a386Sopenharmony_ci# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1609cb93a386Sopenharmony_ci# implemented using a web server instead of a web client using Javascript. There 1610cb93a386Sopenharmony_ci# are two flavors of web server based searching depending on the EXTERNAL_SEARCH 1611cb93a386Sopenharmony_ci# setting. When disabled, doxygen will generate a PHP script for searching and 1612cb93a386Sopenharmony_ci# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing 1613cb93a386Sopenharmony_ci# and searching needs to be provided by external tools. See the section 1614cb93a386Sopenharmony_ci# "External Indexing and Searching" for details. 1615cb93a386Sopenharmony_ci# The default value is: NO. 1616cb93a386Sopenharmony_ci# This tag requires that the tag SEARCHENGINE is set to YES. 1617cb93a386Sopenharmony_ci 1618cb93a386Sopenharmony_ciSERVER_BASED_SEARCH = NO 1619cb93a386Sopenharmony_ci 1620cb93a386Sopenharmony_ci# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP 1621cb93a386Sopenharmony_ci# script for searching. Instead the search results are written to an XML file 1622cb93a386Sopenharmony_ci# which needs to be processed by an external indexer. Doxygen will invoke an 1623cb93a386Sopenharmony_ci# external search engine pointed to by the SEARCHENGINE_URL option to obtain the 1624cb93a386Sopenharmony_ci# search results. 1625cb93a386Sopenharmony_ci# 1626cb93a386Sopenharmony_ci# Doxygen ships with an example indexer (doxyindexer) and search engine 1627cb93a386Sopenharmony_ci# (doxysearch.cgi) which are based on the open source search engine library 1628cb93a386Sopenharmony_ci# Xapian (see: http://xapian.org/). 1629cb93a386Sopenharmony_ci# 1630cb93a386Sopenharmony_ci# See the section "External Indexing and Searching" for details. 1631cb93a386Sopenharmony_ci# The default value is: NO. 1632cb93a386Sopenharmony_ci# This tag requires that the tag SEARCHENGINE is set to YES. 1633cb93a386Sopenharmony_ci 1634cb93a386Sopenharmony_ciEXTERNAL_SEARCH = NO 1635cb93a386Sopenharmony_ci 1636cb93a386Sopenharmony_ci# The SEARCHENGINE_URL should point to a search engine hosted by a web server 1637cb93a386Sopenharmony_ci# which will return the search results when EXTERNAL_SEARCH is enabled. 1638cb93a386Sopenharmony_ci# 1639cb93a386Sopenharmony_ci# Doxygen ships with an example indexer (doxyindexer) and search engine 1640cb93a386Sopenharmony_ci# (doxysearch.cgi) which are based on the open source search engine library 1641cb93a386Sopenharmony_ci# Xapian (see: http://xapian.org/). See the section "External Indexing and 1642cb93a386Sopenharmony_ci# Searching" for details. 1643cb93a386Sopenharmony_ci# This tag requires that the tag SEARCHENGINE is set to YES. 1644cb93a386Sopenharmony_ci 1645cb93a386Sopenharmony_ciSEARCHENGINE_URL = 1646cb93a386Sopenharmony_ci 1647cb93a386Sopenharmony_ci# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed 1648cb93a386Sopenharmony_ci# search data is written to a file for indexing by an external tool. With the 1649cb93a386Sopenharmony_ci# SEARCHDATA_FILE tag the name of this file can be specified. 1650cb93a386Sopenharmony_ci# The default file is: searchdata.xml. 1651cb93a386Sopenharmony_ci# This tag requires that the tag SEARCHENGINE is set to YES. 1652cb93a386Sopenharmony_ci 1653cb93a386Sopenharmony_ciSEARCHDATA_FILE = searchdata.xml 1654cb93a386Sopenharmony_ci 1655cb93a386Sopenharmony_ci# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the 1656cb93a386Sopenharmony_ci# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is 1657cb93a386Sopenharmony_ci# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple 1658cb93a386Sopenharmony_ci# projects and redirect the results back to the right project. 1659cb93a386Sopenharmony_ci# This tag requires that the tag SEARCHENGINE is set to YES. 1660cb93a386Sopenharmony_ci 1661cb93a386Sopenharmony_ciEXTERNAL_SEARCH_ID = 1662cb93a386Sopenharmony_ci 1663cb93a386Sopenharmony_ci# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen 1664cb93a386Sopenharmony_ci# projects other than the one defined by this configuration file, but that are 1665cb93a386Sopenharmony_ci# all added to the same external search index. Each project needs to have a 1666cb93a386Sopenharmony_ci# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of 1667cb93a386Sopenharmony_ci# to a relative location where the documentation can be found. The format is: 1668cb93a386Sopenharmony_ci# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... 1669cb93a386Sopenharmony_ci# This tag requires that the tag SEARCHENGINE is set to YES. 1670cb93a386Sopenharmony_ci 1671cb93a386Sopenharmony_ciEXTRA_SEARCH_MAPPINGS = 1672cb93a386Sopenharmony_ci 1673cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 1674cb93a386Sopenharmony_ci# Configuration options related to the LaTeX output 1675cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 1676cb93a386Sopenharmony_ci 1677cb93a386Sopenharmony_ci# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. 1678cb93a386Sopenharmony_ci# The default value is: YES. 1679cb93a386Sopenharmony_ci 1680cb93a386Sopenharmony_ciGENERATE_LATEX = NO 1681cb93a386Sopenharmony_ci 1682cb93a386Sopenharmony_ci# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a 1683cb93a386Sopenharmony_ci# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1684cb93a386Sopenharmony_ci# it. 1685cb93a386Sopenharmony_ci# The default directory is: latex. 1686cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1687cb93a386Sopenharmony_ci 1688cb93a386Sopenharmony_ciLATEX_OUTPUT = latex 1689cb93a386Sopenharmony_ci 1690cb93a386Sopenharmony_ci# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1691cb93a386Sopenharmony_ci# invoked. 1692cb93a386Sopenharmony_ci# 1693cb93a386Sopenharmony_ci# Note that when enabling USE_PDFLATEX this option is only used for generating 1694cb93a386Sopenharmony_ci# bitmaps for formulas in the HTML output, but not in the Makefile that is 1695cb93a386Sopenharmony_ci# written to the output directory. 1696cb93a386Sopenharmony_ci# The default file is: latex. 1697cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1698cb93a386Sopenharmony_ci 1699cb93a386Sopenharmony_ciLATEX_CMD_NAME = latex 1700cb93a386Sopenharmony_ci 1701cb93a386Sopenharmony_ci# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate 1702cb93a386Sopenharmony_ci# index for LaTeX. 1703cb93a386Sopenharmony_ci# The default file is: makeindex. 1704cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1705cb93a386Sopenharmony_ci 1706cb93a386Sopenharmony_ciMAKEINDEX_CMD_NAME = makeindex 1707cb93a386Sopenharmony_ci 1708cb93a386Sopenharmony_ci# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX 1709cb93a386Sopenharmony_ci# documents. This may be useful for small projects and may help to save some 1710cb93a386Sopenharmony_ci# trees in general. 1711cb93a386Sopenharmony_ci# The default value is: NO. 1712cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1713cb93a386Sopenharmony_ci 1714cb93a386Sopenharmony_ciCOMPACT_LATEX = NO 1715cb93a386Sopenharmony_ci 1716cb93a386Sopenharmony_ci# The PAPER_TYPE tag can be used to set the paper type that is used by the 1717cb93a386Sopenharmony_ci# printer. 1718cb93a386Sopenharmony_ci# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x 1719cb93a386Sopenharmony_ci# 14 inches) and executive (7.25 x 10.5 inches). 1720cb93a386Sopenharmony_ci# The default value is: a4. 1721cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1722cb93a386Sopenharmony_ci 1723cb93a386Sopenharmony_ciPAPER_TYPE = a4 1724cb93a386Sopenharmony_ci 1725cb93a386Sopenharmony_ci# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names 1726cb93a386Sopenharmony_ci# that should be included in the LaTeX output. The package can be specified just 1727cb93a386Sopenharmony_ci# by its name or with the correct syntax as to be used with the LaTeX 1728cb93a386Sopenharmony_ci# \usepackage command. To get the times font for instance you can specify : 1729cb93a386Sopenharmony_ci# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} 1730cb93a386Sopenharmony_ci# To use the option intlimits with the amsmath package you can specify: 1731cb93a386Sopenharmony_ci# EXTRA_PACKAGES=[intlimits]{amsmath} 1732cb93a386Sopenharmony_ci# If left blank no extra packages will be included. 1733cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1734cb93a386Sopenharmony_ci 1735cb93a386Sopenharmony_ciEXTRA_PACKAGES = 1736cb93a386Sopenharmony_ci 1737cb93a386Sopenharmony_ci# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the 1738cb93a386Sopenharmony_ci# generated LaTeX document. The header should contain everything until the first 1739cb93a386Sopenharmony_ci# chapter. If it is left blank doxygen will generate a standard header. See 1740cb93a386Sopenharmony_ci# section "Doxygen usage" for information on how to let doxygen write the 1741cb93a386Sopenharmony_ci# default header to a separate file. 1742cb93a386Sopenharmony_ci# 1743cb93a386Sopenharmony_ci# Note: Only use a user-defined header if you know what you are doing! The 1744cb93a386Sopenharmony_ci# following commands have a special meaning inside the header: $title, 1745cb93a386Sopenharmony_ci# $datetime, $date, $doxygenversion, $projectname, $projectnumber, 1746cb93a386Sopenharmony_ci# $projectbrief, $projectlogo. Doxygen will replace $title with the empty 1747cb93a386Sopenharmony_ci# string, for the replacement values of the other commands the user is referred 1748cb93a386Sopenharmony_ci# to HTML_HEADER. 1749cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1750cb93a386Sopenharmony_ci 1751cb93a386Sopenharmony_ciLATEX_HEADER = 1752cb93a386Sopenharmony_ci 1753cb93a386Sopenharmony_ci# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the 1754cb93a386Sopenharmony_ci# generated LaTeX document. The footer should contain everything after the last 1755cb93a386Sopenharmony_ci# chapter. If it is left blank doxygen will generate a standard footer. See 1756cb93a386Sopenharmony_ci# LATEX_HEADER for more information on how to generate a default footer and what 1757cb93a386Sopenharmony_ci# special commands can be used inside the footer. 1758cb93a386Sopenharmony_ci# 1759cb93a386Sopenharmony_ci# Note: Only use a user-defined footer if you know what you are doing! 1760cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1761cb93a386Sopenharmony_ci 1762cb93a386Sopenharmony_ciLATEX_FOOTER = 1763cb93a386Sopenharmony_ci 1764cb93a386Sopenharmony_ci# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1765cb93a386Sopenharmony_ci# LaTeX style sheets that are included after the standard style sheets created 1766cb93a386Sopenharmony_ci# by doxygen. Using this option one can overrule certain style aspects. Doxygen 1767cb93a386Sopenharmony_ci# will copy the style sheet files to the output directory. 1768cb93a386Sopenharmony_ci# Note: The order of the extra style sheet files is of importance (e.g. the last 1769cb93a386Sopenharmony_ci# style sheet in the list overrules the setting of the previous ones in the 1770cb93a386Sopenharmony_ci# list). 1771cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1772cb93a386Sopenharmony_ci 1773cb93a386Sopenharmony_ciLATEX_EXTRA_STYLESHEET = 1774cb93a386Sopenharmony_ci 1775cb93a386Sopenharmony_ci# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or 1776cb93a386Sopenharmony_ci# other source files which should be copied to the LATEX_OUTPUT output 1777cb93a386Sopenharmony_ci# directory. Note that the files will be copied as-is; there are no commands or 1778cb93a386Sopenharmony_ci# markers available. 1779cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1780cb93a386Sopenharmony_ci 1781cb93a386Sopenharmony_ciLATEX_EXTRA_FILES = 1782cb93a386Sopenharmony_ci 1783cb93a386Sopenharmony_ci# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is 1784cb93a386Sopenharmony_ci# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will 1785cb93a386Sopenharmony_ci# contain links (just like the HTML output) instead of page references. This 1786cb93a386Sopenharmony_ci# makes the output suitable for online browsing using a PDF viewer. 1787cb93a386Sopenharmony_ci# The default value is: YES. 1788cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1789cb93a386Sopenharmony_ci 1790cb93a386Sopenharmony_ciPDF_HYPERLINKS = YES 1791cb93a386Sopenharmony_ci 1792cb93a386Sopenharmony_ci# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate 1793cb93a386Sopenharmony_ci# the PDF file directly from the LaTeX files. Set this option to YES, to get a 1794cb93a386Sopenharmony_ci# higher quality PDF documentation. 1795cb93a386Sopenharmony_ci# The default value is: YES. 1796cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1797cb93a386Sopenharmony_ci 1798cb93a386Sopenharmony_ciUSE_PDFLATEX = YES 1799cb93a386Sopenharmony_ci 1800cb93a386Sopenharmony_ci# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode 1801cb93a386Sopenharmony_ci# command to the generated LaTeX files. This will instruct LaTeX to keep running 1802cb93a386Sopenharmony_ci# if errors occur, instead of asking the user for help. This option is also used 1803cb93a386Sopenharmony_ci# when generating formulas in HTML. 1804cb93a386Sopenharmony_ci# The default value is: NO. 1805cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1806cb93a386Sopenharmony_ci 1807cb93a386Sopenharmony_ciLATEX_BATCHMODE = NO 1808cb93a386Sopenharmony_ci 1809cb93a386Sopenharmony_ci# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the 1810cb93a386Sopenharmony_ci# index chapters (such as File Index, Compound Index, etc.) in the output. 1811cb93a386Sopenharmony_ci# The default value is: NO. 1812cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1813cb93a386Sopenharmony_ci 1814cb93a386Sopenharmony_ciLATEX_HIDE_INDICES = NO 1815cb93a386Sopenharmony_ci 1816cb93a386Sopenharmony_ci# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source 1817cb93a386Sopenharmony_ci# code with syntax highlighting in the LaTeX output. 1818cb93a386Sopenharmony_ci# 1819cb93a386Sopenharmony_ci# Note that which sources are shown also depends on other settings such as 1820cb93a386Sopenharmony_ci# SOURCE_BROWSER. 1821cb93a386Sopenharmony_ci# The default value is: NO. 1822cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1823cb93a386Sopenharmony_ci 1824cb93a386Sopenharmony_ciLATEX_SOURCE_CODE = NO 1825cb93a386Sopenharmony_ci 1826cb93a386Sopenharmony_ci# The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1827cb93a386Sopenharmony_ci# bibliography, e.g. plainnat, or ieeetr. See 1828cb93a386Sopenharmony_ci# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. 1829cb93a386Sopenharmony_ci# The default value is: plain. 1830cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1831cb93a386Sopenharmony_ci 1832cb93a386Sopenharmony_ciLATEX_BIB_STYLE = plain 1833cb93a386Sopenharmony_ci 1834cb93a386Sopenharmony_ci# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated 1835cb93a386Sopenharmony_ci# page will contain the date and time when the page was generated. Setting this 1836cb93a386Sopenharmony_ci# to NO can help when comparing the output of multiple runs. 1837cb93a386Sopenharmony_ci# The default value is: NO. 1838cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1839cb93a386Sopenharmony_ci 1840cb93a386Sopenharmony_ciLATEX_TIMESTAMP = NO 1841cb93a386Sopenharmony_ci 1842cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 1843cb93a386Sopenharmony_ci# Configuration options related to the RTF output 1844cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 1845cb93a386Sopenharmony_ci 1846cb93a386Sopenharmony_ci# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The 1847cb93a386Sopenharmony_ci# RTF output is optimized for Word 97 and may not look too pretty with other RTF 1848cb93a386Sopenharmony_ci# readers/editors. 1849cb93a386Sopenharmony_ci# The default value is: NO. 1850cb93a386Sopenharmony_ci 1851cb93a386Sopenharmony_ciGENERATE_RTF = NO 1852cb93a386Sopenharmony_ci 1853cb93a386Sopenharmony_ci# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a 1854cb93a386Sopenharmony_ci# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1855cb93a386Sopenharmony_ci# it. 1856cb93a386Sopenharmony_ci# The default directory is: rtf. 1857cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_RTF is set to YES. 1858cb93a386Sopenharmony_ci 1859cb93a386Sopenharmony_ciRTF_OUTPUT = rtf 1860cb93a386Sopenharmony_ci 1861cb93a386Sopenharmony_ci# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF 1862cb93a386Sopenharmony_ci# documents. This may be useful for small projects and may help to save some 1863cb93a386Sopenharmony_ci# trees in general. 1864cb93a386Sopenharmony_ci# The default value is: NO. 1865cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_RTF is set to YES. 1866cb93a386Sopenharmony_ci 1867cb93a386Sopenharmony_ciCOMPACT_RTF = NO 1868cb93a386Sopenharmony_ci 1869cb93a386Sopenharmony_ci# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will 1870cb93a386Sopenharmony_ci# contain hyperlink fields. The RTF file will contain links (just like the HTML 1871cb93a386Sopenharmony_ci# output) instead of page references. This makes the output suitable for online 1872cb93a386Sopenharmony_ci# browsing using Word or some other Word compatible readers that support those 1873cb93a386Sopenharmony_ci# fields. 1874cb93a386Sopenharmony_ci# 1875cb93a386Sopenharmony_ci# Note: WordPad (write) and others do not support links. 1876cb93a386Sopenharmony_ci# The default value is: NO. 1877cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_RTF is set to YES. 1878cb93a386Sopenharmony_ci 1879cb93a386Sopenharmony_ciRTF_HYPERLINKS = NO 1880cb93a386Sopenharmony_ci 1881cb93a386Sopenharmony_ci# Load stylesheet definitions from file. Syntax is similar to doxygen's config 1882cb93a386Sopenharmony_ci# file, i.e. a series of assignments. You only have to provide replacements, 1883cb93a386Sopenharmony_ci# missing definitions are set to their default value. 1884cb93a386Sopenharmony_ci# 1885cb93a386Sopenharmony_ci# See also section "Doxygen usage" for information on how to generate the 1886cb93a386Sopenharmony_ci# default style sheet that doxygen normally uses. 1887cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_RTF is set to YES. 1888cb93a386Sopenharmony_ci 1889cb93a386Sopenharmony_ciRTF_STYLESHEET_FILE = 1890cb93a386Sopenharmony_ci 1891cb93a386Sopenharmony_ci# Set optional variables used in the generation of an RTF document. Syntax is 1892cb93a386Sopenharmony_ci# similar to doxygen's config file. A template extensions file can be generated 1893cb93a386Sopenharmony_ci# using doxygen -e rtf extensionFile. 1894cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_RTF is set to YES. 1895cb93a386Sopenharmony_ci 1896cb93a386Sopenharmony_ciRTF_EXTENSIONS_FILE = 1897cb93a386Sopenharmony_ci 1898cb93a386Sopenharmony_ci# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code 1899cb93a386Sopenharmony_ci# with syntax highlighting in the RTF output. 1900cb93a386Sopenharmony_ci# 1901cb93a386Sopenharmony_ci# Note that which sources are shown also depends on other settings such as 1902cb93a386Sopenharmony_ci# SOURCE_BROWSER. 1903cb93a386Sopenharmony_ci# The default value is: NO. 1904cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_RTF is set to YES. 1905cb93a386Sopenharmony_ci 1906cb93a386Sopenharmony_ciRTF_SOURCE_CODE = NO 1907cb93a386Sopenharmony_ci 1908cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 1909cb93a386Sopenharmony_ci# Configuration options related to the man page output 1910cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 1911cb93a386Sopenharmony_ci 1912cb93a386Sopenharmony_ci# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for 1913cb93a386Sopenharmony_ci# classes and files. 1914cb93a386Sopenharmony_ci# The default value is: NO. 1915cb93a386Sopenharmony_ci 1916cb93a386Sopenharmony_ciGENERATE_MAN = NO 1917cb93a386Sopenharmony_ci 1918cb93a386Sopenharmony_ci# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a 1919cb93a386Sopenharmony_ci# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1920cb93a386Sopenharmony_ci# it. A directory man3 will be created inside the directory specified by 1921cb93a386Sopenharmony_ci# MAN_OUTPUT. 1922cb93a386Sopenharmony_ci# The default directory is: man. 1923cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_MAN is set to YES. 1924cb93a386Sopenharmony_ci 1925cb93a386Sopenharmony_ciMAN_OUTPUT = man 1926cb93a386Sopenharmony_ci 1927cb93a386Sopenharmony_ci# The MAN_EXTENSION tag determines the extension that is added to the generated 1928cb93a386Sopenharmony_ci# man pages. In case the manual section does not start with a number, the number 1929cb93a386Sopenharmony_ci# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is 1930cb93a386Sopenharmony_ci# optional. 1931cb93a386Sopenharmony_ci# The default value is: .3. 1932cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_MAN is set to YES. 1933cb93a386Sopenharmony_ci 1934cb93a386Sopenharmony_ciMAN_EXTENSION = .3 1935cb93a386Sopenharmony_ci 1936cb93a386Sopenharmony_ci# The MAN_SUBDIR tag determines the name of the directory created within 1937cb93a386Sopenharmony_ci# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by 1938cb93a386Sopenharmony_ci# MAN_EXTENSION with the initial . removed. 1939cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_MAN is set to YES. 1940cb93a386Sopenharmony_ci 1941cb93a386Sopenharmony_ciMAN_SUBDIR = 1942cb93a386Sopenharmony_ci 1943cb93a386Sopenharmony_ci# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it 1944cb93a386Sopenharmony_ci# will generate one additional man file for each entity documented in the real 1945cb93a386Sopenharmony_ci# man page(s). These additional files only source the real man page, but without 1946cb93a386Sopenharmony_ci# them the man command would be unable to find the correct page. 1947cb93a386Sopenharmony_ci# The default value is: NO. 1948cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_MAN is set to YES. 1949cb93a386Sopenharmony_ci 1950cb93a386Sopenharmony_ciMAN_LINKS = NO 1951cb93a386Sopenharmony_ci 1952cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 1953cb93a386Sopenharmony_ci# Configuration options related to the XML output 1954cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 1955cb93a386Sopenharmony_ci 1956cb93a386Sopenharmony_ci# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that 1957cb93a386Sopenharmony_ci# captures the structure of the code including all documentation. 1958cb93a386Sopenharmony_ci# The default value is: NO. 1959cb93a386Sopenharmony_ci 1960cb93a386Sopenharmony_ciGENERATE_XML = NO 1961cb93a386Sopenharmony_ci 1962cb93a386Sopenharmony_ci# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a 1963cb93a386Sopenharmony_ci# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1964cb93a386Sopenharmony_ci# it. 1965cb93a386Sopenharmony_ci# The default directory is: xml. 1966cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_XML is set to YES. 1967cb93a386Sopenharmony_ci 1968cb93a386Sopenharmony_ciXML_OUTPUT = xml 1969cb93a386Sopenharmony_ci 1970cb93a386Sopenharmony_ci# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program 1971cb93a386Sopenharmony_ci# listings (including syntax highlighting and cross-referencing information) to 1972cb93a386Sopenharmony_ci# the XML output. Note that enabling this will significantly increase the size 1973cb93a386Sopenharmony_ci# of the XML output. 1974cb93a386Sopenharmony_ci# The default value is: YES. 1975cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_XML is set to YES. 1976cb93a386Sopenharmony_ci 1977cb93a386Sopenharmony_ciXML_PROGRAMLISTING = YES 1978cb93a386Sopenharmony_ci 1979cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 1980cb93a386Sopenharmony_ci# Configuration options related to the DOCBOOK output 1981cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 1982cb93a386Sopenharmony_ci 1983cb93a386Sopenharmony_ci# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files 1984cb93a386Sopenharmony_ci# that can be used to generate PDF. 1985cb93a386Sopenharmony_ci# The default value is: NO. 1986cb93a386Sopenharmony_ci 1987cb93a386Sopenharmony_ciGENERATE_DOCBOOK = NO 1988cb93a386Sopenharmony_ci 1989cb93a386Sopenharmony_ci# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. 1990cb93a386Sopenharmony_ci# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in 1991cb93a386Sopenharmony_ci# front of it. 1992cb93a386Sopenharmony_ci# The default directory is: docbook. 1993cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_DOCBOOK is set to YES. 1994cb93a386Sopenharmony_ci 1995cb93a386Sopenharmony_ciDOCBOOK_OUTPUT = docbook 1996cb93a386Sopenharmony_ci 1997cb93a386Sopenharmony_ci# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the 1998cb93a386Sopenharmony_ci# program listings (including syntax highlighting and cross-referencing 1999cb93a386Sopenharmony_ci# information) to the DOCBOOK output. Note that enabling this will significantly 2000cb93a386Sopenharmony_ci# increase the size of the DOCBOOK output. 2001cb93a386Sopenharmony_ci# The default value is: NO. 2002cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_DOCBOOK is set to YES. 2003cb93a386Sopenharmony_ci 2004cb93a386Sopenharmony_ciDOCBOOK_PROGRAMLISTING = NO 2005cb93a386Sopenharmony_ci 2006cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 2007cb93a386Sopenharmony_ci# Configuration options for the AutoGen Definitions output 2008cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 2009cb93a386Sopenharmony_ci 2010cb93a386Sopenharmony_ci# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an 2011cb93a386Sopenharmony_ci# AutoGen Definitions (see http://autogen.sf.net) file that captures the 2012cb93a386Sopenharmony_ci# structure of the code including all documentation. Note that this feature is 2013cb93a386Sopenharmony_ci# still experimental and incomplete at the moment. 2014cb93a386Sopenharmony_ci# The default value is: NO. 2015cb93a386Sopenharmony_ci 2016cb93a386Sopenharmony_ciGENERATE_AUTOGEN_DEF = NO 2017cb93a386Sopenharmony_ci 2018cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 2019cb93a386Sopenharmony_ci# Configuration options related to the Perl module output 2020cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 2021cb93a386Sopenharmony_ci 2022cb93a386Sopenharmony_ci# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module 2023cb93a386Sopenharmony_ci# file that captures the structure of the code including all documentation. 2024cb93a386Sopenharmony_ci# 2025cb93a386Sopenharmony_ci# Note that this feature is still experimental and incomplete at the moment. 2026cb93a386Sopenharmony_ci# The default value is: NO. 2027cb93a386Sopenharmony_ci 2028cb93a386Sopenharmony_ciGENERATE_PERLMOD = NO 2029cb93a386Sopenharmony_ci 2030cb93a386Sopenharmony_ci# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary 2031cb93a386Sopenharmony_ci# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI 2032cb93a386Sopenharmony_ci# output from the Perl module output. 2033cb93a386Sopenharmony_ci# The default value is: NO. 2034cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_PERLMOD is set to YES. 2035cb93a386Sopenharmony_ci 2036cb93a386Sopenharmony_ciPERLMOD_LATEX = NO 2037cb93a386Sopenharmony_ci 2038cb93a386Sopenharmony_ci# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely 2039cb93a386Sopenharmony_ci# formatted so it can be parsed by a human reader. This is useful if you want to 2040cb93a386Sopenharmony_ci# understand what is going on. On the other hand, if this tag is set to NO, the 2041cb93a386Sopenharmony_ci# size of the Perl module output will be much smaller and Perl will parse it 2042cb93a386Sopenharmony_ci# just the same. 2043cb93a386Sopenharmony_ci# The default value is: YES. 2044cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_PERLMOD is set to YES. 2045cb93a386Sopenharmony_ci 2046cb93a386Sopenharmony_ciPERLMOD_PRETTY = YES 2047cb93a386Sopenharmony_ci 2048cb93a386Sopenharmony_ci# The names of the make variables in the generated doxyrules.make file are 2049cb93a386Sopenharmony_ci# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful 2050cb93a386Sopenharmony_ci# so different doxyrules.make files included by the same Makefile don't 2051cb93a386Sopenharmony_ci# overwrite each other's variables. 2052cb93a386Sopenharmony_ci# This tag requires that the tag GENERATE_PERLMOD is set to YES. 2053cb93a386Sopenharmony_ci 2054cb93a386Sopenharmony_ciPERLMOD_MAKEVAR_PREFIX = 2055cb93a386Sopenharmony_ci 2056cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 2057cb93a386Sopenharmony_ci# Configuration options related to the preprocessor 2058cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 2059cb93a386Sopenharmony_ci 2060cb93a386Sopenharmony_ci# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all 2061cb93a386Sopenharmony_ci# C-preprocessor directives found in the sources and include files. 2062cb93a386Sopenharmony_ci# The default value is: YES. 2063cb93a386Sopenharmony_ci 2064cb93a386Sopenharmony_ciENABLE_PREPROCESSING = YES 2065cb93a386Sopenharmony_ci 2066cb93a386Sopenharmony_ci# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names 2067cb93a386Sopenharmony_ci# in the source code. If set to NO, only conditional compilation will be 2068cb93a386Sopenharmony_ci# performed. Macro expansion can be done in a controlled way by setting 2069cb93a386Sopenharmony_ci# EXPAND_ONLY_PREDEF to YES. 2070cb93a386Sopenharmony_ci# The default value is: NO. 2071cb93a386Sopenharmony_ci# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2072cb93a386Sopenharmony_ci 2073cb93a386Sopenharmony_ciMACRO_EXPANSION = YES 2074cb93a386Sopenharmony_ci 2075cb93a386Sopenharmony_ci# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then 2076cb93a386Sopenharmony_ci# the macro expansion is limited to the macros specified with the PREDEFINED and 2077cb93a386Sopenharmony_ci# EXPAND_AS_DEFINED tags. 2078cb93a386Sopenharmony_ci# The default value is: NO. 2079cb93a386Sopenharmony_ci# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2080cb93a386Sopenharmony_ci 2081cb93a386Sopenharmony_ciEXPAND_ONLY_PREDEF = YES 2082cb93a386Sopenharmony_ci 2083cb93a386Sopenharmony_ci# If the SEARCH_INCLUDES tag is set to YES, the include files in the 2084cb93a386Sopenharmony_ci# INCLUDE_PATH will be searched if a #include is found. 2085cb93a386Sopenharmony_ci# The default value is: YES. 2086cb93a386Sopenharmony_ci# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2087cb93a386Sopenharmony_ci 2088cb93a386Sopenharmony_ciSEARCH_INCLUDES = YES 2089cb93a386Sopenharmony_ci 2090cb93a386Sopenharmony_ci# The INCLUDE_PATH tag can be used to specify one or more directories that 2091cb93a386Sopenharmony_ci# contain include files that are not input files but should be processed by the 2092cb93a386Sopenharmony_ci# preprocessor. 2093cb93a386Sopenharmony_ci# This tag requires that the tag SEARCH_INCLUDES is set to YES. 2094cb93a386Sopenharmony_ci 2095cb93a386Sopenharmony_ciINCLUDE_PATH = 2096cb93a386Sopenharmony_ci 2097cb93a386Sopenharmony_ci# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 2098cb93a386Sopenharmony_ci# patterns (like *.h and *.hpp) to filter out the header-files in the 2099cb93a386Sopenharmony_ci# directories. If left blank, the patterns specified with FILE_PATTERNS will be 2100cb93a386Sopenharmony_ci# used. 2101cb93a386Sopenharmony_ci# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2102cb93a386Sopenharmony_ci 2103cb93a386Sopenharmony_ciINCLUDE_FILE_PATTERNS = 2104cb93a386Sopenharmony_ci 2105cb93a386Sopenharmony_ci# The PREDEFINED tag can be used to specify one or more macro names that are 2106cb93a386Sopenharmony_ci# defined before the preprocessor is started (similar to the -D option of e.g. 2107cb93a386Sopenharmony_ci# gcc). The argument of the tag is a list of macros of the form: name or 2108cb93a386Sopenharmony_ci# name=definition (no spaces). If the definition and the "=" are omitted, "=1" 2109cb93a386Sopenharmony_ci# is assumed. To prevent a macro definition from being undefined via #undef or 2110cb93a386Sopenharmony_ci# recursively expanded use the := operator instead of the = operator. 2111cb93a386Sopenharmony_ci# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2112cb93a386Sopenharmony_ci 2113cb93a386Sopenharmony_ciPREDEFINED = 2114cb93a386Sopenharmony_ci 2115cb93a386Sopenharmony_ci# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this 2116cb93a386Sopenharmony_ci# tag can be used to specify a list of macro names that should be expanded. The 2117cb93a386Sopenharmony_ci# macro definition that is found in the sources will be used. Use the PREDEFINED 2118cb93a386Sopenharmony_ci# tag if you want to use a different macro definition that overrules the 2119cb93a386Sopenharmony_ci# definition found in the source code. 2120cb93a386Sopenharmony_ci# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2121cb93a386Sopenharmony_ci 2122cb93a386Sopenharmony_ciEXPAND_AS_DEFINED = SkDEBUGCODE 2123cb93a386Sopenharmony_ci 2124cb93a386Sopenharmony_ci# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will 2125cb93a386Sopenharmony_ci# remove all references to function-like macros that are alone on a line, have 2126cb93a386Sopenharmony_ci# an all uppercase name, and do not end with a semicolon. Such function macros 2127cb93a386Sopenharmony_ci# are typically used for boiler-plate code, and will confuse the parser if not 2128cb93a386Sopenharmony_ci# removed. 2129cb93a386Sopenharmony_ci# The default value is: YES. 2130cb93a386Sopenharmony_ci# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2131cb93a386Sopenharmony_ci 2132cb93a386Sopenharmony_ciSKIP_FUNCTION_MACROS = YES 2133cb93a386Sopenharmony_ci 2134cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 2135cb93a386Sopenharmony_ci# Configuration options related to external references 2136cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 2137cb93a386Sopenharmony_ci 2138cb93a386Sopenharmony_ci# The TAGFILES tag can be used to specify one or more tag files. For each tag 2139cb93a386Sopenharmony_ci# file the location of the external documentation should be added. The format of 2140cb93a386Sopenharmony_ci# a tag file without this location is as follows: 2141cb93a386Sopenharmony_ci# TAGFILES = file1 file2 ... 2142cb93a386Sopenharmony_ci# Adding location for the tag files is done as follows: 2143cb93a386Sopenharmony_ci# TAGFILES = file1=loc1 "file2 = loc2" ... 2144cb93a386Sopenharmony_ci# where loc1 and loc2 can be relative or absolute paths or URLs. See the 2145cb93a386Sopenharmony_ci# section "Linking to external documentation" for more information about the use 2146cb93a386Sopenharmony_ci# of tag files. 2147cb93a386Sopenharmony_ci# Note: Each tag file must have a unique name (where the name does NOT include 2148cb93a386Sopenharmony_ci# the path). If a tag file is not located in the directory in which doxygen is 2149cb93a386Sopenharmony_ci# run, you must also specify the path to the tagfile here. 2150cb93a386Sopenharmony_ci 2151cb93a386Sopenharmony_ciTAGFILES = 2152cb93a386Sopenharmony_ci 2153cb93a386Sopenharmony_ci# When a file name is specified after GENERATE_TAGFILE, doxygen will create a 2154cb93a386Sopenharmony_ci# tag file that is based on the input files it reads. See section "Linking to 2155cb93a386Sopenharmony_ci# external documentation" for more information about the usage of tag files. 2156cb93a386Sopenharmony_ci 2157cb93a386Sopenharmony_ciGENERATE_TAGFILE = 2158cb93a386Sopenharmony_ci 2159cb93a386Sopenharmony_ci# If the ALLEXTERNALS tag is set to YES, all external class will be listed in 2160cb93a386Sopenharmony_ci# the class index. If set to NO, only the inherited external classes will be 2161cb93a386Sopenharmony_ci# listed. 2162cb93a386Sopenharmony_ci# The default value is: NO. 2163cb93a386Sopenharmony_ci 2164cb93a386Sopenharmony_ciALLEXTERNALS = NO 2165cb93a386Sopenharmony_ci 2166cb93a386Sopenharmony_ci# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed 2167cb93a386Sopenharmony_ci# in the modules index. If set to NO, only the current project's groups will be 2168cb93a386Sopenharmony_ci# listed. 2169cb93a386Sopenharmony_ci# The default value is: YES. 2170cb93a386Sopenharmony_ci 2171cb93a386Sopenharmony_ciEXTERNAL_GROUPS = YES 2172cb93a386Sopenharmony_ci 2173cb93a386Sopenharmony_ci# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in 2174cb93a386Sopenharmony_ci# the related pages index. If set to NO, only the current project's pages will 2175cb93a386Sopenharmony_ci# be listed. 2176cb93a386Sopenharmony_ci# The default value is: YES. 2177cb93a386Sopenharmony_ci 2178cb93a386Sopenharmony_ciEXTERNAL_PAGES = YES 2179cb93a386Sopenharmony_ci 2180cb93a386Sopenharmony_ci# The PERL_PATH should be the absolute path and name of the perl script 2181cb93a386Sopenharmony_ci# interpreter (i.e. the result of 'which perl'). 2182cb93a386Sopenharmony_ci# The default file (with absolute path) is: /usr/bin/perl. 2183cb93a386Sopenharmony_ci 2184cb93a386Sopenharmony_ciPERL_PATH = /usr/bin/perl 2185cb93a386Sopenharmony_ci 2186cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 2187cb93a386Sopenharmony_ci# Configuration options related to the dot tool 2188cb93a386Sopenharmony_ci#--------------------------------------------------------------------------- 2189cb93a386Sopenharmony_ci 2190cb93a386Sopenharmony_ci# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram 2191cb93a386Sopenharmony_ci# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to 2192cb93a386Sopenharmony_ci# NO turns the diagrams off. Note that this option also works with HAVE_DOT 2193cb93a386Sopenharmony_ci# disabled, but it is recommended to install and use dot, since it yields more 2194cb93a386Sopenharmony_ci# powerful graphs. 2195cb93a386Sopenharmony_ci# The default value is: YES. 2196cb93a386Sopenharmony_ci 2197cb93a386Sopenharmony_ciCLASS_DIAGRAMS = YES 2198cb93a386Sopenharmony_ci 2199cb93a386Sopenharmony_ci# You can define message sequence charts within doxygen comments using the \msc 2200cb93a386Sopenharmony_ci# command. Doxygen will then run the mscgen tool (see: 2201cb93a386Sopenharmony_ci# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the 2202cb93a386Sopenharmony_ci# documentation. The MSCGEN_PATH tag allows you to specify the directory where 2203cb93a386Sopenharmony_ci# the mscgen tool resides. If left empty the tool is assumed to be found in the 2204cb93a386Sopenharmony_ci# default search path. 2205cb93a386Sopenharmony_ci 2206cb93a386Sopenharmony_ciMSCGEN_PATH = 2207cb93a386Sopenharmony_ci 2208cb93a386Sopenharmony_ci# You can include diagrams made with dia in doxygen documentation. Doxygen will 2209cb93a386Sopenharmony_ci# then run dia to produce the diagram and insert it in the documentation. The 2210cb93a386Sopenharmony_ci# DIA_PATH tag allows you to specify the directory where the dia binary resides. 2211cb93a386Sopenharmony_ci# If left empty dia is assumed to be found in the default search path. 2212cb93a386Sopenharmony_ci 2213cb93a386Sopenharmony_ciDIA_PATH = 2214cb93a386Sopenharmony_ci 2215cb93a386Sopenharmony_ci# If set to YES the inheritance and collaboration graphs will hide inheritance 2216cb93a386Sopenharmony_ci# and usage relations if the target is undocumented or is not a class. 2217cb93a386Sopenharmony_ci# The default value is: YES. 2218cb93a386Sopenharmony_ci 2219cb93a386Sopenharmony_ciHIDE_UNDOC_RELATIONS = YES 2220cb93a386Sopenharmony_ci 2221cb93a386Sopenharmony_ci# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 2222cb93a386Sopenharmony_ci# available from the path. This tool is part of Graphviz (see: 2223cb93a386Sopenharmony_ci# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent 2224cb93a386Sopenharmony_ci# Bell Labs. The other options in this section have no effect if this option is 2225cb93a386Sopenharmony_ci# set to NO 2226cb93a386Sopenharmony_ci# The default value is: YES. 2227cb93a386Sopenharmony_ci 2228cb93a386Sopenharmony_ciHAVE_DOT = YES 2229cb93a386Sopenharmony_ci 2230cb93a386Sopenharmony_ci# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed 2231cb93a386Sopenharmony_ci# to run in parallel. When set to 0 doxygen will base this on the number of 2232cb93a386Sopenharmony_ci# processors available in the system. You can set it explicitly to a value 2233cb93a386Sopenharmony_ci# larger than 0 to get control over the balance between CPU load and processing 2234cb93a386Sopenharmony_ci# speed. 2235cb93a386Sopenharmony_ci# Minimum value: 0, maximum value: 32, default value: 0. 2236cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2237cb93a386Sopenharmony_ci 2238cb93a386Sopenharmony_ciDOT_NUM_THREADS = 0 2239cb93a386Sopenharmony_ci 2240cb93a386Sopenharmony_ci# When you want a differently looking font in the dot files that doxygen 2241cb93a386Sopenharmony_ci# generates you can specify the font name using DOT_FONTNAME. You need to make 2242cb93a386Sopenharmony_ci# sure dot is able to find the font, which can be done by putting it in a 2243cb93a386Sopenharmony_ci# standard location or by setting the DOTFONTPATH environment variable or by 2244cb93a386Sopenharmony_ci# setting DOT_FONTPATH to the directory containing the font. 2245cb93a386Sopenharmony_ci# The default value is: Helvetica. 2246cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2247cb93a386Sopenharmony_ci 2248cb93a386Sopenharmony_ciDOT_FONTNAME = Helvetica 2249cb93a386Sopenharmony_ci 2250cb93a386Sopenharmony_ci# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of 2251cb93a386Sopenharmony_ci# dot graphs. 2252cb93a386Sopenharmony_ci# Minimum value: 4, maximum value: 24, default value: 10. 2253cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2254cb93a386Sopenharmony_ci 2255cb93a386Sopenharmony_ciDOT_FONTSIZE = 10 2256cb93a386Sopenharmony_ci 2257cb93a386Sopenharmony_ci# By default doxygen will tell dot to use the default font as specified with 2258cb93a386Sopenharmony_ci# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set 2259cb93a386Sopenharmony_ci# the path where dot can find it using this tag. 2260cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2261cb93a386Sopenharmony_ci 2262cb93a386Sopenharmony_ciDOT_FONTPATH = 2263cb93a386Sopenharmony_ci 2264cb93a386Sopenharmony_ci# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for 2265cb93a386Sopenharmony_ci# each documented class showing the direct and indirect inheritance relations. 2266cb93a386Sopenharmony_ci# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. 2267cb93a386Sopenharmony_ci# The default value is: YES. 2268cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2269cb93a386Sopenharmony_ci 2270cb93a386Sopenharmony_ciCLASS_GRAPH = YES 2271cb93a386Sopenharmony_ci 2272cb93a386Sopenharmony_ci# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a 2273cb93a386Sopenharmony_ci# graph for each documented class showing the direct and indirect implementation 2274cb93a386Sopenharmony_ci# dependencies (inheritance, containment, and class references variables) of the 2275cb93a386Sopenharmony_ci# class with other documented classes. 2276cb93a386Sopenharmony_ci# The default value is: YES. 2277cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2278cb93a386Sopenharmony_ci 2279cb93a386Sopenharmony_ciCOLLABORATION_GRAPH = NO 2280cb93a386Sopenharmony_ci 2281cb93a386Sopenharmony_ci# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for 2282cb93a386Sopenharmony_ci# groups, showing the direct groups dependencies. 2283cb93a386Sopenharmony_ci# The default value is: YES. 2284cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2285cb93a386Sopenharmony_ci 2286cb93a386Sopenharmony_ciGROUP_GRAPHS = YES 2287cb93a386Sopenharmony_ci 2288cb93a386Sopenharmony_ci# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and 2289cb93a386Sopenharmony_ci# collaboration diagrams in a style similar to the OMG's Unified Modeling 2290cb93a386Sopenharmony_ci# Language. 2291cb93a386Sopenharmony_ci# The default value is: NO. 2292cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2293cb93a386Sopenharmony_ci 2294cb93a386Sopenharmony_ciUML_LOOK = NO 2295cb93a386Sopenharmony_ci 2296cb93a386Sopenharmony_ci# If the UML_LOOK tag is enabled, the fields and methods are shown inside the 2297cb93a386Sopenharmony_ci# class node. If there are many fields or methods and many nodes the graph may 2298cb93a386Sopenharmony_ci# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the 2299cb93a386Sopenharmony_ci# number of items for each type to make the size more manageable. Set this to 0 2300cb93a386Sopenharmony_ci# for no limit. Note that the threshold may be exceeded by 50% before the limit 2301cb93a386Sopenharmony_ci# is enforced. So when you set the threshold to 10, up to 15 fields may appear, 2302cb93a386Sopenharmony_ci# but if the number exceeds 15, the total amount of fields shown is limited to 2303cb93a386Sopenharmony_ci# 10. 2304cb93a386Sopenharmony_ci# Minimum value: 0, maximum value: 100, default value: 10. 2305cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2306cb93a386Sopenharmony_ci 2307cb93a386Sopenharmony_ciUML_LIMIT_NUM_FIELDS = 10 2308cb93a386Sopenharmony_ci 2309cb93a386Sopenharmony_ci# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and 2310cb93a386Sopenharmony_ci# collaboration graphs will show the relations between templates and their 2311cb93a386Sopenharmony_ci# instances. 2312cb93a386Sopenharmony_ci# The default value is: NO. 2313cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2314cb93a386Sopenharmony_ci 2315cb93a386Sopenharmony_ciTEMPLATE_RELATIONS = NO 2316cb93a386Sopenharmony_ci 2317cb93a386Sopenharmony_ci# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to 2318cb93a386Sopenharmony_ci# YES then doxygen will generate a graph for each documented file showing the 2319cb93a386Sopenharmony_ci# direct and indirect include dependencies of the file with other documented 2320cb93a386Sopenharmony_ci# files. 2321cb93a386Sopenharmony_ci# The default value is: YES. 2322cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2323cb93a386Sopenharmony_ci 2324cb93a386Sopenharmony_ciINCLUDE_GRAPH = YES 2325cb93a386Sopenharmony_ci 2326cb93a386Sopenharmony_ci# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are 2327cb93a386Sopenharmony_ci# set to YES then doxygen will generate a graph for each documented file showing 2328cb93a386Sopenharmony_ci# the direct and indirect include dependencies of the file with other documented 2329cb93a386Sopenharmony_ci# files. 2330cb93a386Sopenharmony_ci# The default value is: YES. 2331cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2332cb93a386Sopenharmony_ci 2333cb93a386Sopenharmony_ciINCLUDED_BY_GRAPH = YES 2334cb93a386Sopenharmony_ci 2335cb93a386Sopenharmony_ci# If the CALL_GRAPH tag is set to YES then doxygen will generate a call 2336cb93a386Sopenharmony_ci# dependency graph for every global function or class method. 2337cb93a386Sopenharmony_ci# 2338cb93a386Sopenharmony_ci# Note that enabling this option will significantly increase the time of a run. 2339cb93a386Sopenharmony_ci# So in most cases it will be better to enable call graphs for selected 2340cb93a386Sopenharmony_ci# functions only using the \callgraph command. Disabling a call graph can be 2341cb93a386Sopenharmony_ci# accomplished by means of the command \hidecallgraph. 2342cb93a386Sopenharmony_ci# The default value is: NO. 2343cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2344cb93a386Sopenharmony_ci 2345cb93a386Sopenharmony_ciCALL_GRAPH = NO 2346cb93a386Sopenharmony_ci 2347cb93a386Sopenharmony_ci# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller 2348cb93a386Sopenharmony_ci# dependency graph for every global function or class method. 2349cb93a386Sopenharmony_ci# 2350cb93a386Sopenharmony_ci# Note that enabling this option will significantly increase the time of a run. 2351cb93a386Sopenharmony_ci# So in most cases it will be better to enable caller graphs for selected 2352cb93a386Sopenharmony_ci# functions only using the \callergraph command. Disabling a caller graph can be 2353cb93a386Sopenharmony_ci# accomplished by means of the command \hidecallergraph. 2354cb93a386Sopenharmony_ci# The default value is: NO. 2355cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2356cb93a386Sopenharmony_ci 2357cb93a386Sopenharmony_ciCALLER_GRAPH = NO 2358cb93a386Sopenharmony_ci 2359cb93a386Sopenharmony_ci# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical 2360cb93a386Sopenharmony_ci# hierarchy of all classes instead of a textual one. 2361cb93a386Sopenharmony_ci# The default value is: YES. 2362cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2363cb93a386Sopenharmony_ci 2364cb93a386Sopenharmony_ciGRAPHICAL_HIERARCHY = YES 2365cb93a386Sopenharmony_ci 2366cb93a386Sopenharmony_ci# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the 2367cb93a386Sopenharmony_ci# dependencies a directory has on other directories in a graphical way. The 2368cb93a386Sopenharmony_ci# dependency relations are determined by the #include relations between the 2369cb93a386Sopenharmony_ci# files in the directories. 2370cb93a386Sopenharmony_ci# The default value is: YES. 2371cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2372cb93a386Sopenharmony_ci 2373cb93a386Sopenharmony_ciDIRECTORY_GRAPH = YES 2374cb93a386Sopenharmony_ci 2375cb93a386Sopenharmony_ci# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 2376cb93a386Sopenharmony_ci# generated by dot. For an explanation of the image formats see the section 2377cb93a386Sopenharmony_ci# output formats in the documentation of the dot tool (Graphviz (see: 2378cb93a386Sopenharmony_ci# http://www.graphviz.org/)). 2379cb93a386Sopenharmony_ci# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order 2380cb93a386Sopenharmony_ci# to make the SVG files visible in IE 9+ (other browsers do not have this 2381cb93a386Sopenharmony_ci# requirement). 2382cb93a386Sopenharmony_ci# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd, 2383cb93a386Sopenharmony_ci# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo, 2384cb93a386Sopenharmony_ci# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo, 2385cb93a386Sopenharmony_ci# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and 2386cb93a386Sopenharmony_ci# png:gdiplus:gdiplus. 2387cb93a386Sopenharmony_ci# The default value is: png. 2388cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2389cb93a386Sopenharmony_ci 2390cb93a386Sopenharmony_ciDOT_IMAGE_FORMAT = png 2391cb93a386Sopenharmony_ci 2392cb93a386Sopenharmony_ci# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 2393cb93a386Sopenharmony_ci# enable generation of interactive SVG images that allow zooming and panning. 2394cb93a386Sopenharmony_ci# 2395cb93a386Sopenharmony_ci# Note that this requires a modern browser other than Internet Explorer. Tested 2396cb93a386Sopenharmony_ci# and working are Firefox, Chrome, Safari, and Opera. 2397cb93a386Sopenharmony_ci# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make 2398cb93a386Sopenharmony_ci# the SVG files visible. Older versions of IE do not have SVG support. 2399cb93a386Sopenharmony_ci# The default value is: NO. 2400cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2401cb93a386Sopenharmony_ci 2402cb93a386Sopenharmony_ciINTERACTIVE_SVG = NO 2403cb93a386Sopenharmony_ci 2404cb93a386Sopenharmony_ci# The DOT_PATH tag can be used to specify the path where the dot tool can be 2405cb93a386Sopenharmony_ci# found. If left blank, it is assumed the dot tool can be found in the path. 2406cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2407cb93a386Sopenharmony_ci 2408cb93a386Sopenharmony_ciDOT_PATH = 2409cb93a386Sopenharmony_ci 2410cb93a386Sopenharmony_ci# The DOTFILE_DIRS tag can be used to specify one or more directories that 2411cb93a386Sopenharmony_ci# contain dot files that are included in the documentation (see the \dotfile 2412cb93a386Sopenharmony_ci# command). 2413cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2414cb93a386Sopenharmony_ci 2415cb93a386Sopenharmony_ciDOTFILE_DIRS = 2416cb93a386Sopenharmony_ci 2417cb93a386Sopenharmony_ci# The MSCFILE_DIRS tag can be used to specify one or more directories that 2418cb93a386Sopenharmony_ci# contain msc files that are included in the documentation (see the \mscfile 2419cb93a386Sopenharmony_ci# command). 2420cb93a386Sopenharmony_ci 2421cb93a386Sopenharmony_ciMSCFILE_DIRS = 2422cb93a386Sopenharmony_ci 2423cb93a386Sopenharmony_ci# The DIAFILE_DIRS tag can be used to specify one or more directories that 2424cb93a386Sopenharmony_ci# contain dia files that are included in the documentation (see the \diafile 2425cb93a386Sopenharmony_ci# command). 2426cb93a386Sopenharmony_ci 2427cb93a386Sopenharmony_ciDIAFILE_DIRS = 2428cb93a386Sopenharmony_ci 2429cb93a386Sopenharmony_ci# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the 2430cb93a386Sopenharmony_ci# path where java can find the plantuml.jar file. If left blank, it is assumed 2431cb93a386Sopenharmony_ci# PlantUML is not used or called during a preprocessing step. Doxygen will 2432cb93a386Sopenharmony_ci# generate a warning when it encounters a \startuml command in this case and 2433cb93a386Sopenharmony_ci# will not generate output for the diagram. 2434cb93a386Sopenharmony_ci 2435cb93a386Sopenharmony_ciPLANTUML_JAR_PATH = 2436cb93a386Sopenharmony_ci 2437cb93a386Sopenharmony_ci# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a 2438cb93a386Sopenharmony_ci# configuration file for plantuml. 2439cb93a386Sopenharmony_ci 2440cb93a386Sopenharmony_ciPLANTUML_CFG_FILE = 2441cb93a386Sopenharmony_ci 2442cb93a386Sopenharmony_ci# When using plantuml, the specified paths are searched for files specified by 2443cb93a386Sopenharmony_ci# the !include statement in a plantuml block. 2444cb93a386Sopenharmony_ci 2445cb93a386Sopenharmony_ciPLANTUML_INCLUDE_PATH = 2446cb93a386Sopenharmony_ci 2447cb93a386Sopenharmony_ci# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes 2448cb93a386Sopenharmony_ci# that will be shown in the graph. If the number of nodes in a graph becomes 2449cb93a386Sopenharmony_ci# larger than this value, doxygen will truncate the graph, which is visualized 2450cb93a386Sopenharmony_ci# by representing a node as a red box. Note that doxygen if the number of direct 2451cb93a386Sopenharmony_ci# children of the root node in a graph is already larger than 2452cb93a386Sopenharmony_ci# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that 2453cb93a386Sopenharmony_ci# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 2454cb93a386Sopenharmony_ci# Minimum value: 0, maximum value: 10000, default value: 50. 2455cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2456cb93a386Sopenharmony_ci 2457cb93a386Sopenharmony_ciDOT_GRAPH_MAX_NODES = 50 2458cb93a386Sopenharmony_ci 2459cb93a386Sopenharmony_ci# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs 2460cb93a386Sopenharmony_ci# generated by dot. A depth value of 3 means that only nodes reachable from the 2461cb93a386Sopenharmony_ci# root by following a path via at most 3 edges will be shown. Nodes that lay 2462cb93a386Sopenharmony_ci# further from the root node will be omitted. Note that setting this option to 1 2463cb93a386Sopenharmony_ci# or 2 may greatly reduce the computation time needed for large code bases. Also 2464cb93a386Sopenharmony_ci# note that the size of a graph can be further restricted by 2465cb93a386Sopenharmony_ci# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 2466cb93a386Sopenharmony_ci# Minimum value: 0, maximum value: 1000, default value: 0. 2467cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2468cb93a386Sopenharmony_ci 2469cb93a386Sopenharmony_ciMAX_DOT_GRAPH_DEPTH = 0 2470cb93a386Sopenharmony_ci 2471cb93a386Sopenharmony_ci# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 2472cb93a386Sopenharmony_ci# background. This is disabled by default, because dot on Windows does not seem 2473cb93a386Sopenharmony_ci# to support this out of the box. 2474cb93a386Sopenharmony_ci# 2475cb93a386Sopenharmony_ci# Warning: Depending on the platform used, enabling this option may lead to 2476cb93a386Sopenharmony_ci# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 2477cb93a386Sopenharmony_ci# read). 2478cb93a386Sopenharmony_ci# The default value is: NO. 2479cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2480cb93a386Sopenharmony_ci 2481cb93a386Sopenharmony_ciDOT_TRANSPARENT = NO 2482cb93a386Sopenharmony_ci 2483cb93a386Sopenharmony_ci# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output 2484cb93a386Sopenharmony_ci# files in one run (i.e. multiple -o and -T options on the command line). This 2485cb93a386Sopenharmony_ci# makes dot run faster, but since only newer versions of dot (>1.8.10) support 2486cb93a386Sopenharmony_ci# this, this feature is disabled by default. 2487cb93a386Sopenharmony_ci# The default value is: NO. 2488cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2489cb93a386Sopenharmony_ci 2490cb93a386Sopenharmony_ciDOT_MULTI_TARGETS = NO 2491cb93a386Sopenharmony_ci 2492cb93a386Sopenharmony_ci# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page 2493cb93a386Sopenharmony_ci# explaining the meaning of the various boxes and arrows in the dot generated 2494cb93a386Sopenharmony_ci# graphs. 2495cb93a386Sopenharmony_ci# The default value is: YES. 2496cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2497cb93a386Sopenharmony_ci 2498cb93a386Sopenharmony_ciGENERATE_LEGEND = YES 2499cb93a386Sopenharmony_ci 2500cb93a386Sopenharmony_ci# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot 2501cb93a386Sopenharmony_ci# files that are used to generate the various graphs. 2502cb93a386Sopenharmony_ci# The default value is: YES. 2503cb93a386Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2504cb93a386Sopenharmony_ci 2505cb93a386Sopenharmony_ciDOT_CLEANUP = YES 2506cb93a386Sopenharmony_ci 2507