1195972f6Sopenharmony_ci# Doxyfile 1.8.13 2195972f6Sopenharmony_ci 3195972f6Sopenharmony_ci# This file describes the settings to be used by the documentation system 4195972f6Sopenharmony_ci# doxygen (www.doxygen.org) for a project. 5195972f6Sopenharmony_ci# 6195972f6Sopenharmony_ci# All text after a double hash (##) is considered a comment and is placed in 7195972f6Sopenharmony_ci# front of the TAG it is preceding. 8195972f6Sopenharmony_ci# 9195972f6Sopenharmony_ci# All text after a single hash (#) is considered a comment and will be ignored. 10195972f6Sopenharmony_ci# The format is: 11195972f6Sopenharmony_ci# TAG = value [value, ...] 12195972f6Sopenharmony_ci# For lists, items can also be appended using: 13195972f6Sopenharmony_ci# TAG += value [value, ...] 14195972f6Sopenharmony_ci# Values that contain spaces should be placed between quotes (\" \"). 15195972f6Sopenharmony_ci 16195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 17195972f6Sopenharmony_ci# Project related configuration options 18195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 19195972f6Sopenharmony_ci 20195972f6Sopenharmony_ci# This tag specifies the encoding used for all characters in the config file 21195972f6Sopenharmony_ci# that follow. The default is UTF-8 which is also the encoding used for all text 22195972f6Sopenharmony_ci# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 23195972f6Sopenharmony_ci# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 24195972f6Sopenharmony_ci# for the list of possible encodings. 25195972f6Sopenharmony_ci# The default value is: UTF-8. 26195972f6Sopenharmony_ci 27195972f6Sopenharmony_ciDOXYFILE_ENCODING = UTF-8 28195972f6Sopenharmony_ci 29195972f6Sopenharmony_ci# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 30195972f6Sopenharmony_ci# double-quotes, unless you are using Doxywizard) that should identify the 31195972f6Sopenharmony_ci# project for which the documentation is generated. This name is used in the 32195972f6Sopenharmony_ci# title of most generated pages and in a few other places. 33195972f6Sopenharmony_ci# The default value is: My Project. 34195972f6Sopenharmony_ci 35195972f6Sopenharmony_ciPROJECT_NAME = "lwIP" 36195972f6Sopenharmony_ci 37195972f6Sopenharmony_ci# The PROJECT_NUMBER tag can be used to enter a project or revision number. This 38195972f6Sopenharmony_ci# could be handy for archiving the generated documentation or if some version 39195972f6Sopenharmony_ci# control system is used. 40195972f6Sopenharmony_ci 41195972f6Sopenharmony_ciPROJECT_NUMBER = "${LWIP_VERSION_STRING}" 42195972f6Sopenharmony_ci 43195972f6Sopenharmony_ci# Using the PROJECT_BRIEF tag one can provide an optional one line description 44195972f6Sopenharmony_ci# for a project that appears at the top of each page and should give viewer a 45195972f6Sopenharmony_ci# quick idea about the purpose of the project. Keep the description short. 46195972f6Sopenharmony_ci 47195972f6Sopenharmony_ciPROJECT_BRIEF = "Lightweight IP stack" 48195972f6Sopenharmony_ci 49195972f6Sopenharmony_ci# With the PROJECT_LOGO tag one can specify a logo or an icon that is included 50195972f6Sopenharmony_ci# in the documentation. The maximum height of the logo should not exceed 55 51195972f6Sopenharmony_ci# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 52195972f6Sopenharmony_ci# the logo to the output directory. 53195972f6Sopenharmony_ci 54195972f6Sopenharmony_ciPROJECT_LOGO = 55195972f6Sopenharmony_ci 56195972f6Sopenharmony_ci# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57195972f6Sopenharmony_ci# into which the generated documentation will be written. If a relative path is 58195972f6Sopenharmony_ci# entered, it will be relative to the location where doxygen was started. If 59195972f6Sopenharmony_ci# left blank the current directory will be used. 60195972f6Sopenharmony_ci 61195972f6Sopenharmony_ciOUTPUT_DIRECTORY = "${DOXYGEN_OUTPUT_DIR}" 62195972f6Sopenharmony_ci 63195972f6Sopenharmony_ci# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- 64195972f6Sopenharmony_ci# directories (in 2 levels) under the output directory of each output format and 65195972f6Sopenharmony_ci# will distribute the generated files over these directories. Enabling this 66195972f6Sopenharmony_ci# option can be useful when feeding doxygen a huge amount of source files, where 67195972f6Sopenharmony_ci# putting all generated files in the same directory would otherwise causes 68195972f6Sopenharmony_ci# performance problems for the file system. 69195972f6Sopenharmony_ci# The default value is: NO. 70195972f6Sopenharmony_ci 71195972f6Sopenharmony_ciCREATE_SUBDIRS = NO 72195972f6Sopenharmony_ci 73195972f6Sopenharmony_ci# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74195972f6Sopenharmony_ci# characters to appear in the names of generated files. If set to NO, non-ASCII 75195972f6Sopenharmony_ci# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76195972f6Sopenharmony_ci# U+3044. 77195972f6Sopenharmony_ci# The default value is: NO. 78195972f6Sopenharmony_ci 79195972f6Sopenharmony_ciALLOW_UNICODE_NAMES = NO 80195972f6Sopenharmony_ci 81195972f6Sopenharmony_ci# The OUTPUT_LANGUAGE tag is used to specify the language in which all 82195972f6Sopenharmony_ci# documentation generated by doxygen is written. Doxygen will use this 83195972f6Sopenharmony_ci# information to generate all constant output in the proper language. 84195972f6Sopenharmony_ci# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 85195972f6Sopenharmony_ci# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 86195972f6Sopenharmony_ci# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 87195972f6Sopenharmony_ci# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 88195972f6Sopenharmony_ci# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 89195972f6Sopenharmony_ci# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 90195972f6Sopenharmony_ci# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 91195972f6Sopenharmony_ci# Ukrainian and Vietnamese. 92195972f6Sopenharmony_ci# The default value is: English. 93195972f6Sopenharmony_ci 94195972f6Sopenharmony_ciOUTPUT_LANGUAGE = English 95195972f6Sopenharmony_ci 96195972f6Sopenharmony_ci# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 97195972f6Sopenharmony_ci# descriptions after the members that are listed in the file and class 98195972f6Sopenharmony_ci# documentation (similar to Javadoc). Set to NO to disable this. 99195972f6Sopenharmony_ci# The default value is: YES. 100195972f6Sopenharmony_ci 101195972f6Sopenharmony_ciBRIEF_MEMBER_DESC = YES 102195972f6Sopenharmony_ci 103195972f6Sopenharmony_ci# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 104195972f6Sopenharmony_ci# description of a member or function before the detailed description 105195972f6Sopenharmony_ci# 106195972f6Sopenharmony_ci# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 107195972f6Sopenharmony_ci# brief descriptions will be completely suppressed. 108195972f6Sopenharmony_ci# The default value is: YES. 109195972f6Sopenharmony_ci 110195972f6Sopenharmony_ciREPEAT_BRIEF = YES 111195972f6Sopenharmony_ci 112195972f6Sopenharmony_ci# This tag implements a quasi-intelligent brief description abbreviator that is 113195972f6Sopenharmony_ci# used to form the text in various listings. Each string in this list, if found 114195972f6Sopenharmony_ci# as the leading text of the brief description, will be stripped from the text 115195972f6Sopenharmony_ci# and the result, after processing the whole list, is used as the annotated 116195972f6Sopenharmony_ci# text. Otherwise, the brief description is used as-is. If left blank, the 117195972f6Sopenharmony_ci# following values are used ($name is automatically replaced with the name of 118195972f6Sopenharmony_ci# the entity):The $name class, The $name widget, The $name file, is, provides, 119195972f6Sopenharmony_ci# specifies, contains, represents, a, an and the. 120195972f6Sopenharmony_ci 121195972f6Sopenharmony_ciABBREVIATE_BRIEF = "The $name class " \ 122195972f6Sopenharmony_ci "The $name widget " \ 123195972f6Sopenharmony_ci "The $name file " \ 124195972f6Sopenharmony_ci is \ 125195972f6Sopenharmony_ci provides \ 126195972f6Sopenharmony_ci specifies \ 127195972f6Sopenharmony_ci contains \ 128195972f6Sopenharmony_ci represents \ 129195972f6Sopenharmony_ci a \ 130195972f6Sopenharmony_ci an \ 131195972f6Sopenharmony_ci the 132195972f6Sopenharmony_ci 133195972f6Sopenharmony_ci# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 134195972f6Sopenharmony_ci# doxygen will generate a detailed section even if there is only a brief 135195972f6Sopenharmony_ci# description. 136195972f6Sopenharmony_ci# The default value is: NO. 137195972f6Sopenharmony_ci 138195972f6Sopenharmony_ciALWAYS_DETAILED_SEC = NO 139195972f6Sopenharmony_ci 140195972f6Sopenharmony_ci# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 141195972f6Sopenharmony_ci# inherited members of a class in the documentation of that class as if those 142195972f6Sopenharmony_ci# members were ordinary class members. Constructors, destructors and assignment 143195972f6Sopenharmony_ci# operators of the base classes will not be shown. 144195972f6Sopenharmony_ci# The default value is: NO. 145195972f6Sopenharmony_ci 146195972f6Sopenharmony_ciINLINE_INHERITED_MEMB = NO 147195972f6Sopenharmony_ci 148195972f6Sopenharmony_ci# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 149195972f6Sopenharmony_ci# before files name in the file list and in the header files. If set to NO the 150195972f6Sopenharmony_ci# shortest path that makes the file name unique will be used 151195972f6Sopenharmony_ci# The default value is: YES. 152195972f6Sopenharmony_ci 153195972f6Sopenharmony_ciFULL_PATH_NAMES = YES 154195972f6Sopenharmony_ci 155195972f6Sopenharmony_ci# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 156195972f6Sopenharmony_ci# Stripping is only done if one of the specified strings matches the left-hand 157195972f6Sopenharmony_ci# part of the path. The tag can be used to show relative paths in the file list. 158195972f6Sopenharmony_ci# If left blank the directory from which doxygen is run is used as the path to 159195972f6Sopenharmony_ci# strip. 160195972f6Sopenharmony_ci# 161195972f6Sopenharmony_ci# Note that you can specify absolute paths here, but also relative paths, which 162195972f6Sopenharmony_ci# will be relative from the directory where doxygen is started. 163195972f6Sopenharmony_ci# This tag requires that the tag FULL_PATH_NAMES is set to YES. 164195972f6Sopenharmony_ci 165195972f6Sopenharmony_ciSTRIP_FROM_PATH = ../../ 166195972f6Sopenharmony_ci 167195972f6Sopenharmony_ci# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 168195972f6Sopenharmony_ci# path mentioned in the documentation of a class, which tells the reader which 169195972f6Sopenharmony_ci# header file to include in order to use a class. If left blank only the name of 170195972f6Sopenharmony_ci# the header file containing the class definition is used. Otherwise one should 171195972f6Sopenharmony_ci# specify the list of include paths that are normally passed to the compiler 172195972f6Sopenharmony_ci# using the -I flag. 173195972f6Sopenharmony_ci 174195972f6Sopenharmony_ciSTRIP_FROM_INC_PATH = 175195972f6Sopenharmony_ci 176195972f6Sopenharmony_ci# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 177195972f6Sopenharmony_ci# less readable) file names. This can be useful is your file systems doesn't 178195972f6Sopenharmony_ci# support long names like on DOS, Mac, or CD-ROM. 179195972f6Sopenharmony_ci# The default value is: NO. 180195972f6Sopenharmony_ci 181195972f6Sopenharmony_ciSHORT_NAMES = NO 182195972f6Sopenharmony_ci 183195972f6Sopenharmony_ci# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 184195972f6Sopenharmony_ci# first line (until the first dot) of a Javadoc-style comment as the brief 185195972f6Sopenharmony_ci# description. If set to NO, the Javadoc-style will behave just like regular Qt- 186195972f6Sopenharmony_ci# style comments (thus requiring an explicit @brief command for a brief 187195972f6Sopenharmony_ci# description.) 188195972f6Sopenharmony_ci# The default value is: NO. 189195972f6Sopenharmony_ci 190195972f6Sopenharmony_ciJAVADOC_AUTOBRIEF = NO 191195972f6Sopenharmony_ci 192195972f6Sopenharmony_ci# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 193195972f6Sopenharmony_ci# line (until the first dot) of a Qt-style comment as the brief description. If 194195972f6Sopenharmony_ci# set to NO, the Qt-style will behave just like regular Qt-style comments (thus 195195972f6Sopenharmony_ci# requiring an explicit \brief command for a brief description.) 196195972f6Sopenharmony_ci# The default value is: NO. 197195972f6Sopenharmony_ci 198195972f6Sopenharmony_ciQT_AUTOBRIEF = NO 199195972f6Sopenharmony_ci 200195972f6Sopenharmony_ci# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 201195972f6Sopenharmony_ci# multi-line C++ special comment block (i.e. a block of //! or /// comments) as 202195972f6Sopenharmony_ci# a brief description. This used to be the default behavior. The new default is 203195972f6Sopenharmony_ci# to treat a multi-line C++ comment block as a detailed description. Set this 204195972f6Sopenharmony_ci# tag to YES if you prefer the old behavior instead. 205195972f6Sopenharmony_ci# 206195972f6Sopenharmony_ci# Note that setting this tag to YES also means that rational rose comments are 207195972f6Sopenharmony_ci# not recognized any more. 208195972f6Sopenharmony_ci# The default value is: NO. 209195972f6Sopenharmony_ci 210195972f6Sopenharmony_ciMULTILINE_CPP_IS_BRIEF = NO 211195972f6Sopenharmony_ci 212195972f6Sopenharmony_ci# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 213195972f6Sopenharmony_ci# documentation from any documented member that it re-implements. 214195972f6Sopenharmony_ci# The default value is: YES. 215195972f6Sopenharmony_ci 216195972f6Sopenharmony_ciINHERIT_DOCS = YES 217195972f6Sopenharmony_ci 218195972f6Sopenharmony_ci# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 219195972f6Sopenharmony_ci# page for each member. If set to NO, the documentation of a member will be part 220195972f6Sopenharmony_ci# of the file/class/namespace that contains it. 221195972f6Sopenharmony_ci# The default value is: NO. 222195972f6Sopenharmony_ci 223195972f6Sopenharmony_ciSEPARATE_MEMBER_PAGES = NO 224195972f6Sopenharmony_ci 225195972f6Sopenharmony_ci# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 226195972f6Sopenharmony_ci# uses this value to replace tabs by spaces in code fragments. 227195972f6Sopenharmony_ci# Minimum value: 1, maximum value: 16, default value: 4. 228195972f6Sopenharmony_ci 229195972f6Sopenharmony_ciTAB_SIZE = 8 230195972f6Sopenharmony_ci 231195972f6Sopenharmony_ci# This tag can be used to specify a number of aliases that act as commands in 232195972f6Sopenharmony_ci# the documentation. An alias has the form: 233195972f6Sopenharmony_ci# name=value 234195972f6Sopenharmony_ci# For example adding 235195972f6Sopenharmony_ci# "sideeffect=@par Side Effects:\n" 236195972f6Sopenharmony_ci# will allow you to put the command \sideeffect (or @sideeffect) in the 237195972f6Sopenharmony_ci# documentation, which will result in a user-defined paragraph with heading 238195972f6Sopenharmony_ci# "Side Effects:". You can put \n's in the value part of an alias to insert 239195972f6Sopenharmony_ci# newlines. 240195972f6Sopenharmony_ci 241195972f6Sopenharmony_ciALIASES = 242195972f6Sopenharmony_ci 243195972f6Sopenharmony_ci# This tag can be used to specify a number of word-keyword mappings (TCL only). 244195972f6Sopenharmony_ci# A mapping has the form "name=value". For example adding "class=itcl::class" 245195972f6Sopenharmony_ci# will allow you to use the command class in the itcl::class meaning. 246195972f6Sopenharmony_ci 247195972f6Sopenharmony_ciTCL_SUBST = 248195972f6Sopenharmony_ci 249195972f6Sopenharmony_ci# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 250195972f6Sopenharmony_ci# only. Doxygen will then generate output that is more tailored for C. For 251195972f6Sopenharmony_ci# instance, some of the names that are used will be different. The list of all 252195972f6Sopenharmony_ci# members will be omitted, etc. 253195972f6Sopenharmony_ci# The default value is: NO. 254195972f6Sopenharmony_ci 255195972f6Sopenharmony_ciOPTIMIZE_OUTPUT_FOR_C = YES 256195972f6Sopenharmony_ci 257195972f6Sopenharmony_ci# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 258195972f6Sopenharmony_ci# Python sources only. Doxygen will then generate output that is more tailored 259195972f6Sopenharmony_ci# for that language. For instance, namespaces will be presented as packages, 260195972f6Sopenharmony_ci# qualified scopes will look different, etc. 261195972f6Sopenharmony_ci# The default value is: NO. 262195972f6Sopenharmony_ci 263195972f6Sopenharmony_ciOPTIMIZE_OUTPUT_JAVA = NO 264195972f6Sopenharmony_ci 265195972f6Sopenharmony_ci# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 266195972f6Sopenharmony_ci# sources. Doxygen will then generate output that is tailored for Fortran. 267195972f6Sopenharmony_ci# The default value is: NO. 268195972f6Sopenharmony_ci 269195972f6Sopenharmony_ciOPTIMIZE_FOR_FORTRAN = NO 270195972f6Sopenharmony_ci 271195972f6Sopenharmony_ci# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 272195972f6Sopenharmony_ci# sources. Doxygen will then generate output that is tailored for VHDL. 273195972f6Sopenharmony_ci# The default value is: NO. 274195972f6Sopenharmony_ci 275195972f6Sopenharmony_ciOPTIMIZE_OUTPUT_VHDL = NO 276195972f6Sopenharmony_ci 277195972f6Sopenharmony_ci# Doxygen selects the parser to use depending on the extension of the files it 278195972f6Sopenharmony_ci# parses. With this tag you can assign which parser to use for a given 279195972f6Sopenharmony_ci# extension. Doxygen has a built-in mapping, but you can override or extend it 280195972f6Sopenharmony_ci# using this tag. The format is ext=language, where ext is a file extension, and 281195972f6Sopenharmony_ci# language is one of the parsers supported by doxygen: IDL, Java, Javascript, 282195972f6Sopenharmony_ci# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 283195972f6Sopenharmony_ci# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 284195972f6Sopenharmony_ci# Fortran. In the later case the parser tries to guess whether the code is fixed 285195972f6Sopenharmony_ci# or free formatted code, this is the default for Fortran type files), VHDL. For 286195972f6Sopenharmony_ci# instance to make doxygen treat .inc files as Fortran files (default is PHP), 287195972f6Sopenharmony_ci# and .f files as C (default is Fortran), use: inc=Fortran f=C. 288195972f6Sopenharmony_ci# 289195972f6Sopenharmony_ci# Note: For files without extension you can use no_extension as a placeholder. 290195972f6Sopenharmony_ci# 291195972f6Sopenharmony_ci# Note that for custom extensions you also need to set FILE_PATTERNS otherwise 292195972f6Sopenharmony_ci# the files are not read by doxygen. 293195972f6Sopenharmony_ci 294195972f6Sopenharmony_ciEXTENSION_MAPPING = 295195972f6Sopenharmony_ci 296195972f6Sopenharmony_ci# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 297195972f6Sopenharmony_ci# according to the Markdown format, which allows for more readable 298195972f6Sopenharmony_ci# documentation. See http://daringfireball.net/projects/markdown/ for details. 299195972f6Sopenharmony_ci# The output of markdown processing is further processed by doxygen, so you can 300195972f6Sopenharmony_ci# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 301195972f6Sopenharmony_ci# case of backward compatibilities issues. 302195972f6Sopenharmony_ci# The default value is: YES. 303195972f6Sopenharmony_ci 304195972f6Sopenharmony_ciMARKDOWN_SUPPORT = YES 305195972f6Sopenharmony_ci 306195972f6Sopenharmony_ci# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 307195972f6Sopenharmony_ci# to that level are automatically included in the table of contents, even if 308195972f6Sopenharmony_ci# they do not have an id attribute. 309195972f6Sopenharmony_ci# Note: This feature currently applies only to Markdown headings. 310195972f6Sopenharmony_ci# Minimum value: 0, maximum value: 99, default value: 0. 311195972f6Sopenharmony_ci# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 312195972f6Sopenharmony_ci 313195972f6Sopenharmony_ciTOC_INCLUDE_HEADINGS = 0 314195972f6Sopenharmony_ci 315195972f6Sopenharmony_ci# When enabled doxygen tries to link words that correspond to documented 316195972f6Sopenharmony_ci# classes, or namespaces to their corresponding documentation. Such a link can 317195972f6Sopenharmony_ci# be prevented in individual cases by putting a % sign in front of the word or 318195972f6Sopenharmony_ci# globally by setting AUTOLINK_SUPPORT to NO. 319195972f6Sopenharmony_ci# The default value is: YES. 320195972f6Sopenharmony_ci 321195972f6Sopenharmony_ciAUTOLINK_SUPPORT = YES 322195972f6Sopenharmony_ci 323195972f6Sopenharmony_ci# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 324195972f6Sopenharmony_ci# to include (a tag file for) the STL sources as input, then you should set this 325195972f6Sopenharmony_ci# tag to YES in order to let doxygen match functions declarations and 326195972f6Sopenharmony_ci# definitions whose arguments contain STL classes (e.g. func(std::string); 327195972f6Sopenharmony_ci# versus func(std::string) {}). This also make the inheritance and collaboration 328195972f6Sopenharmony_ci# diagrams that involve STL classes more complete and accurate. 329195972f6Sopenharmony_ci# The default value is: NO. 330195972f6Sopenharmony_ci 331195972f6Sopenharmony_ciBUILTIN_STL_SUPPORT = NO 332195972f6Sopenharmony_ci 333195972f6Sopenharmony_ci# If you use Microsoft's C++/CLI language, you should set this option to YES to 334195972f6Sopenharmony_ci# enable parsing support. 335195972f6Sopenharmony_ci# The default value is: NO. 336195972f6Sopenharmony_ci 337195972f6Sopenharmony_ciCPP_CLI_SUPPORT = NO 338195972f6Sopenharmony_ci 339195972f6Sopenharmony_ci# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 340195972f6Sopenharmony_ci# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 341195972f6Sopenharmony_ci# will parse them like normal C++ but will assume all classes use public instead 342195972f6Sopenharmony_ci# of private inheritance when no explicit protection keyword is present. 343195972f6Sopenharmony_ci# The default value is: NO. 344195972f6Sopenharmony_ci 345195972f6Sopenharmony_ciSIP_SUPPORT = NO 346195972f6Sopenharmony_ci 347195972f6Sopenharmony_ci# For Microsoft's IDL there are propget and propput attributes to indicate 348195972f6Sopenharmony_ci# getter and setter methods for a property. Setting this option to YES will make 349195972f6Sopenharmony_ci# doxygen to replace the get and set methods by a property in the documentation. 350195972f6Sopenharmony_ci# This will only work if the methods are indeed getting or setting a simple 351195972f6Sopenharmony_ci# type. If this is not the case, or you want to show the methods anyway, you 352195972f6Sopenharmony_ci# should set this option to NO. 353195972f6Sopenharmony_ci# The default value is: YES. 354195972f6Sopenharmony_ci 355195972f6Sopenharmony_ciIDL_PROPERTY_SUPPORT = YES 356195972f6Sopenharmony_ci 357195972f6Sopenharmony_ci# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 358195972f6Sopenharmony_ci# tag is set to YES then doxygen will reuse the documentation of the first 359195972f6Sopenharmony_ci# member in the group (if any) for the other members of the group. By default 360195972f6Sopenharmony_ci# all members of a group must be documented explicitly. 361195972f6Sopenharmony_ci# The default value is: NO. 362195972f6Sopenharmony_ci 363195972f6Sopenharmony_ciDISTRIBUTE_GROUP_DOC = NO 364195972f6Sopenharmony_ci 365195972f6Sopenharmony_ci# If one adds a struct or class to a group and this option is enabled, then also 366195972f6Sopenharmony_ci# any nested class or struct is added to the same group. By default this option 367195972f6Sopenharmony_ci# is disabled and one has to add nested compounds explicitly via \ingroup. 368195972f6Sopenharmony_ci# The default value is: NO. 369195972f6Sopenharmony_ci 370195972f6Sopenharmony_ciGROUP_NESTED_COMPOUNDS = NO 371195972f6Sopenharmony_ci 372195972f6Sopenharmony_ci# Set the SUBGROUPING tag to YES to allow class member groups of the same type 373195972f6Sopenharmony_ci# (for instance a group of public functions) to be put as a subgroup of that 374195972f6Sopenharmony_ci# type (e.g. under the Public Functions section). Set it to NO to prevent 375195972f6Sopenharmony_ci# subgrouping. Alternatively, this can be done per class using the 376195972f6Sopenharmony_ci# \nosubgrouping command. 377195972f6Sopenharmony_ci# The default value is: YES. 378195972f6Sopenharmony_ci 379195972f6Sopenharmony_ciSUBGROUPING = YES 380195972f6Sopenharmony_ci 381195972f6Sopenharmony_ci# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 382195972f6Sopenharmony_ci# are shown inside the group in which they are included (e.g. using \ingroup) 383195972f6Sopenharmony_ci# instead of on a separate page (for HTML and Man pages) or section (for LaTeX 384195972f6Sopenharmony_ci# and RTF). 385195972f6Sopenharmony_ci# 386195972f6Sopenharmony_ci# Note that this feature does not work in combination with 387195972f6Sopenharmony_ci# SEPARATE_MEMBER_PAGES. 388195972f6Sopenharmony_ci# The default value is: NO. 389195972f6Sopenharmony_ci 390195972f6Sopenharmony_ciINLINE_GROUPED_CLASSES = NO 391195972f6Sopenharmony_ci 392195972f6Sopenharmony_ci# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 393195972f6Sopenharmony_ci# with only public data fields or simple typedef fields will be shown inline in 394195972f6Sopenharmony_ci# the documentation of the scope in which they are defined (i.e. file, 395195972f6Sopenharmony_ci# namespace, or group documentation), provided this scope is documented. If set 396195972f6Sopenharmony_ci# to NO, structs, classes, and unions are shown on a separate page (for HTML and 397195972f6Sopenharmony_ci# Man pages) or section (for LaTeX and RTF). 398195972f6Sopenharmony_ci# The default value is: NO. 399195972f6Sopenharmony_ci 400195972f6Sopenharmony_ciINLINE_SIMPLE_STRUCTS = NO 401195972f6Sopenharmony_ci 402195972f6Sopenharmony_ci# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 403195972f6Sopenharmony_ci# enum is documented as struct, union, or enum with the name of the typedef. So 404195972f6Sopenharmony_ci# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 405195972f6Sopenharmony_ci# with name TypeT. When disabled the typedef will appear as a member of a file, 406195972f6Sopenharmony_ci# namespace, or class. And the struct will be named TypeS. This can typically be 407195972f6Sopenharmony_ci# useful for C code in case the coding convention dictates that all compound 408195972f6Sopenharmony_ci# types are typedef'ed and only the typedef is referenced, never the tag name. 409195972f6Sopenharmony_ci# The default value is: NO. 410195972f6Sopenharmony_ci 411195972f6Sopenharmony_ciTYPEDEF_HIDES_STRUCT = NO 412195972f6Sopenharmony_ci 413195972f6Sopenharmony_ci# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 414195972f6Sopenharmony_ci# cache is used to resolve symbols given their name and scope. Since this can be 415195972f6Sopenharmony_ci# an expensive process and often the same symbol appears multiple times in the 416195972f6Sopenharmony_ci# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 417195972f6Sopenharmony_ci# doxygen will become slower. If the cache is too large, memory is wasted. The 418195972f6Sopenharmony_ci# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 419195972f6Sopenharmony_ci# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 420195972f6Sopenharmony_ci# symbols. At the end of a run doxygen will report the cache usage and suggest 421195972f6Sopenharmony_ci# the optimal cache size from a speed point of view. 422195972f6Sopenharmony_ci# Minimum value: 0, maximum value: 9, default value: 0. 423195972f6Sopenharmony_ci 424195972f6Sopenharmony_ciLOOKUP_CACHE_SIZE = 0 425195972f6Sopenharmony_ci 426195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 427195972f6Sopenharmony_ci# Build related configuration options 428195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 429195972f6Sopenharmony_ci 430195972f6Sopenharmony_ci# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 431195972f6Sopenharmony_ci# documentation are documented, even if no documentation was available. Private 432195972f6Sopenharmony_ci# class members and static file members will be hidden unless the 433195972f6Sopenharmony_ci# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 434195972f6Sopenharmony_ci# Note: This will also disable the warnings about undocumented members that are 435195972f6Sopenharmony_ci# normally produced when WARNINGS is set to YES. 436195972f6Sopenharmony_ci# The default value is: NO. 437195972f6Sopenharmony_ci 438195972f6Sopenharmony_ciEXTRACT_ALL = NO 439195972f6Sopenharmony_ci 440195972f6Sopenharmony_ci# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 441195972f6Sopenharmony_ci# be included in the documentation. 442195972f6Sopenharmony_ci# The default value is: NO. 443195972f6Sopenharmony_ci 444195972f6Sopenharmony_ciEXTRACT_PRIVATE = NO 445195972f6Sopenharmony_ci 446195972f6Sopenharmony_ci# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 447195972f6Sopenharmony_ci# scope will be included in the documentation. 448195972f6Sopenharmony_ci# The default value is: NO. 449195972f6Sopenharmony_ci 450195972f6Sopenharmony_ciEXTRACT_PACKAGE = NO 451195972f6Sopenharmony_ci 452195972f6Sopenharmony_ci# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 453195972f6Sopenharmony_ci# included in the documentation. 454195972f6Sopenharmony_ci# The default value is: NO. 455195972f6Sopenharmony_ci 456195972f6Sopenharmony_ciEXTRACT_STATIC = NO 457195972f6Sopenharmony_ci 458195972f6Sopenharmony_ci# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 459195972f6Sopenharmony_ci# locally in source files will be included in the documentation. If set to NO, 460195972f6Sopenharmony_ci# only classes defined in header files are included. Does not have any effect 461195972f6Sopenharmony_ci# for Java sources. 462195972f6Sopenharmony_ci# The default value is: YES. 463195972f6Sopenharmony_ci 464195972f6Sopenharmony_ciEXTRACT_LOCAL_CLASSES = YES 465195972f6Sopenharmony_ci 466195972f6Sopenharmony_ci# This flag is only useful for Objective-C code. If set to YES, local methods, 467195972f6Sopenharmony_ci# which are defined in the implementation section but not in the interface are 468195972f6Sopenharmony_ci# included in the documentation. If set to NO, only methods in the interface are 469195972f6Sopenharmony_ci# included. 470195972f6Sopenharmony_ci# The default value is: NO. 471195972f6Sopenharmony_ci 472195972f6Sopenharmony_ciEXTRACT_LOCAL_METHODS = NO 473195972f6Sopenharmony_ci 474195972f6Sopenharmony_ci# If this flag is set to YES, the members of anonymous namespaces will be 475195972f6Sopenharmony_ci# extracted and appear in the documentation as a namespace called 476195972f6Sopenharmony_ci# 'anonymous_namespace{file}', where file will be replaced with the base name of 477195972f6Sopenharmony_ci# the file that contains the anonymous namespace. By default anonymous namespace 478195972f6Sopenharmony_ci# are hidden. 479195972f6Sopenharmony_ci# The default value is: NO. 480195972f6Sopenharmony_ci 481195972f6Sopenharmony_ciEXTRACT_ANON_NSPACES = NO 482195972f6Sopenharmony_ci 483195972f6Sopenharmony_ci# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 484195972f6Sopenharmony_ci# undocumented members inside documented classes or files. If set to NO these 485195972f6Sopenharmony_ci# members will be included in the various overviews, but no documentation 486195972f6Sopenharmony_ci# section is generated. This option has no effect if EXTRACT_ALL is enabled. 487195972f6Sopenharmony_ci# The default value is: NO. 488195972f6Sopenharmony_ci 489195972f6Sopenharmony_ciHIDE_UNDOC_MEMBERS = YES 490195972f6Sopenharmony_ci 491195972f6Sopenharmony_ci# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 492195972f6Sopenharmony_ci# undocumented classes that are normally visible in the class hierarchy. If set 493195972f6Sopenharmony_ci# to NO, these classes will be included in the various overviews. This option 494195972f6Sopenharmony_ci# has no effect if EXTRACT_ALL is enabled. 495195972f6Sopenharmony_ci# The default value is: NO. 496195972f6Sopenharmony_ci 497195972f6Sopenharmony_ciHIDE_UNDOC_CLASSES = YES 498195972f6Sopenharmony_ci 499195972f6Sopenharmony_ci# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 500195972f6Sopenharmony_ci# (class|struct|union) declarations. If set to NO, these declarations will be 501195972f6Sopenharmony_ci# included in the documentation. 502195972f6Sopenharmony_ci# The default value is: NO. 503195972f6Sopenharmony_ci 504195972f6Sopenharmony_ciHIDE_FRIEND_COMPOUNDS = NO 505195972f6Sopenharmony_ci 506195972f6Sopenharmony_ci# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 507195972f6Sopenharmony_ci# documentation blocks found inside the body of a function. If set to NO, these 508195972f6Sopenharmony_ci# blocks will be appended to the function's detailed documentation block. 509195972f6Sopenharmony_ci# The default value is: NO. 510195972f6Sopenharmony_ci 511195972f6Sopenharmony_ciHIDE_IN_BODY_DOCS = NO 512195972f6Sopenharmony_ci 513195972f6Sopenharmony_ci# The INTERNAL_DOCS tag determines if documentation that is typed after a 514195972f6Sopenharmony_ci# \internal command is included. If the tag is set to NO then the documentation 515195972f6Sopenharmony_ci# will be excluded. Set it to YES to include the internal documentation. 516195972f6Sopenharmony_ci# The default value is: NO. 517195972f6Sopenharmony_ci 518195972f6Sopenharmony_ciINTERNAL_DOCS = NO 519195972f6Sopenharmony_ci 520195972f6Sopenharmony_ci# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 521195972f6Sopenharmony_ci# names in lower-case letters. If set to YES, upper-case letters are also 522195972f6Sopenharmony_ci# allowed. This is useful if you have classes or files whose names only differ 523195972f6Sopenharmony_ci# in case and if your file system supports case sensitive file names. Windows 524195972f6Sopenharmony_ci# and Mac users are advised to set this option to NO. 525195972f6Sopenharmony_ci# The default value is: system dependent. 526195972f6Sopenharmony_ci 527195972f6Sopenharmony_ciCASE_SENSE_NAMES = NO 528195972f6Sopenharmony_ci 529195972f6Sopenharmony_ci# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 530195972f6Sopenharmony_ci# their full class and namespace scopes in the documentation. If set to YES, the 531195972f6Sopenharmony_ci# scope will be hidden. 532195972f6Sopenharmony_ci# The default value is: NO. 533195972f6Sopenharmony_ci 534195972f6Sopenharmony_ciHIDE_SCOPE_NAMES = NO 535195972f6Sopenharmony_ci 536195972f6Sopenharmony_ci# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 537195972f6Sopenharmony_ci# append additional text to a page's title, such as Class Reference. If set to 538195972f6Sopenharmony_ci# YES the compound reference will be hidden. 539195972f6Sopenharmony_ci# The default value is: NO. 540195972f6Sopenharmony_ci 541195972f6Sopenharmony_ciHIDE_COMPOUND_REFERENCE= NO 542195972f6Sopenharmony_ci 543195972f6Sopenharmony_ci# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 544195972f6Sopenharmony_ci# the files that are included by a file in the documentation of that file. 545195972f6Sopenharmony_ci# The default value is: YES. 546195972f6Sopenharmony_ci 547195972f6Sopenharmony_ciSHOW_INCLUDE_FILES = YES 548195972f6Sopenharmony_ci 549195972f6Sopenharmony_ci# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 550195972f6Sopenharmony_ci# grouped member an include statement to the documentation, telling the reader 551195972f6Sopenharmony_ci# which file to include in order to use the member. 552195972f6Sopenharmony_ci# The default value is: NO. 553195972f6Sopenharmony_ci 554195972f6Sopenharmony_ciSHOW_GROUPED_MEMB_INC = NO 555195972f6Sopenharmony_ci 556195972f6Sopenharmony_ci# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 557195972f6Sopenharmony_ci# files with double quotes in the documentation rather than with sharp brackets. 558195972f6Sopenharmony_ci# The default value is: NO. 559195972f6Sopenharmony_ci 560195972f6Sopenharmony_ciFORCE_LOCAL_INCLUDES = NO 561195972f6Sopenharmony_ci 562195972f6Sopenharmony_ci# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 563195972f6Sopenharmony_ci# documentation for inline members. 564195972f6Sopenharmony_ci# The default value is: YES. 565195972f6Sopenharmony_ci 566195972f6Sopenharmony_ciINLINE_INFO = YES 567195972f6Sopenharmony_ci 568195972f6Sopenharmony_ci# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 569195972f6Sopenharmony_ci# (detailed) documentation of file and class members alphabetically by member 570195972f6Sopenharmony_ci# name. If set to NO, the members will appear in declaration order. 571195972f6Sopenharmony_ci# The default value is: YES. 572195972f6Sopenharmony_ci 573195972f6Sopenharmony_ciSORT_MEMBER_DOCS = YES 574195972f6Sopenharmony_ci 575195972f6Sopenharmony_ci# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 576195972f6Sopenharmony_ci# descriptions of file, namespace and class members alphabetically by member 577195972f6Sopenharmony_ci# name. If set to NO, the members will appear in declaration order. Note that 578195972f6Sopenharmony_ci# this will also influence the order of the classes in the class list. 579195972f6Sopenharmony_ci# The default value is: NO. 580195972f6Sopenharmony_ci 581195972f6Sopenharmony_ciSORT_BRIEF_DOCS = NO 582195972f6Sopenharmony_ci 583195972f6Sopenharmony_ci# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 584195972f6Sopenharmony_ci# (brief and detailed) documentation of class members so that constructors and 585195972f6Sopenharmony_ci# destructors are listed first. If set to NO the constructors will appear in the 586195972f6Sopenharmony_ci# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 587195972f6Sopenharmony_ci# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 588195972f6Sopenharmony_ci# member documentation. 589195972f6Sopenharmony_ci# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 590195972f6Sopenharmony_ci# detailed member documentation. 591195972f6Sopenharmony_ci# The default value is: NO. 592195972f6Sopenharmony_ci 593195972f6Sopenharmony_ciSORT_MEMBERS_CTORS_1ST = NO 594195972f6Sopenharmony_ci 595195972f6Sopenharmony_ci# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 596195972f6Sopenharmony_ci# of group names into alphabetical order. If set to NO the group names will 597195972f6Sopenharmony_ci# appear in their defined order. 598195972f6Sopenharmony_ci# The default value is: NO. 599195972f6Sopenharmony_ci 600195972f6Sopenharmony_ciSORT_GROUP_NAMES = NO 601195972f6Sopenharmony_ci 602195972f6Sopenharmony_ci# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 603195972f6Sopenharmony_ci# fully-qualified names, including namespaces. If set to NO, the class list will 604195972f6Sopenharmony_ci# be sorted only by class name, not including the namespace part. 605195972f6Sopenharmony_ci# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 606195972f6Sopenharmony_ci# Note: This option applies only to the class list, not to the alphabetical 607195972f6Sopenharmony_ci# list. 608195972f6Sopenharmony_ci# The default value is: NO. 609195972f6Sopenharmony_ci 610195972f6Sopenharmony_ciSORT_BY_SCOPE_NAME = NO 611195972f6Sopenharmony_ci 612195972f6Sopenharmony_ci# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 613195972f6Sopenharmony_ci# type resolution of all parameters of a function it will reject a match between 614195972f6Sopenharmony_ci# the prototype and the implementation of a member function even if there is 615195972f6Sopenharmony_ci# only one candidate or it is obvious which candidate to choose by doing a 616195972f6Sopenharmony_ci# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 617195972f6Sopenharmony_ci# accept a match between prototype and implementation in such cases. 618195972f6Sopenharmony_ci# The default value is: NO. 619195972f6Sopenharmony_ci 620195972f6Sopenharmony_ciSTRICT_PROTO_MATCHING = NO 621195972f6Sopenharmony_ci 622195972f6Sopenharmony_ci# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 623195972f6Sopenharmony_ci# list. This list is created by putting \todo commands in the documentation. 624195972f6Sopenharmony_ci# The default value is: YES. 625195972f6Sopenharmony_ci 626195972f6Sopenharmony_ciGENERATE_TODOLIST = NO 627195972f6Sopenharmony_ci 628195972f6Sopenharmony_ci# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 629195972f6Sopenharmony_ci# list. This list is created by putting \test commands in the documentation. 630195972f6Sopenharmony_ci# The default value is: YES. 631195972f6Sopenharmony_ci 632195972f6Sopenharmony_ciGENERATE_TESTLIST = YES 633195972f6Sopenharmony_ci 634195972f6Sopenharmony_ci# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 635195972f6Sopenharmony_ci# list. This list is created by putting \bug commands in the documentation. 636195972f6Sopenharmony_ci# The default value is: YES. 637195972f6Sopenharmony_ci 638195972f6Sopenharmony_ciGENERATE_BUGLIST = YES 639195972f6Sopenharmony_ci 640195972f6Sopenharmony_ci# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 641195972f6Sopenharmony_ci# the deprecated list. This list is created by putting \deprecated commands in 642195972f6Sopenharmony_ci# the documentation. 643195972f6Sopenharmony_ci# The default value is: YES. 644195972f6Sopenharmony_ci 645195972f6Sopenharmony_ciGENERATE_DEPRECATEDLIST= YES 646195972f6Sopenharmony_ci 647195972f6Sopenharmony_ci# The ENABLED_SECTIONS tag can be used to enable conditional documentation 648195972f6Sopenharmony_ci# sections, marked by \if <section_label> ... \endif and \cond <section_label> 649195972f6Sopenharmony_ci# ... \endcond blocks. 650195972f6Sopenharmony_ci 651195972f6Sopenharmony_ciENABLED_SECTIONS = 652195972f6Sopenharmony_ci 653195972f6Sopenharmony_ci# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 654195972f6Sopenharmony_ci# initial value of a variable or macro / define can have for it to appear in the 655195972f6Sopenharmony_ci# documentation. If the initializer consists of more lines than specified here 656195972f6Sopenharmony_ci# it will be hidden. Use a value of 0 to hide initializers completely. The 657195972f6Sopenharmony_ci# appearance of the value of individual variables and macros / defines can be 658195972f6Sopenharmony_ci# controlled using \showinitializer or \hideinitializer command in the 659195972f6Sopenharmony_ci# documentation regardless of this setting. 660195972f6Sopenharmony_ci# Minimum value: 0, maximum value: 10000, default value: 30. 661195972f6Sopenharmony_ci 662195972f6Sopenharmony_ciMAX_INITIALIZER_LINES = 30 663195972f6Sopenharmony_ci 664195972f6Sopenharmony_ci# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 665195972f6Sopenharmony_ci# the bottom of the documentation of classes and structs. If set to YES, the 666195972f6Sopenharmony_ci# list will mention the files that were used to generate the documentation. 667195972f6Sopenharmony_ci# The default value is: YES. 668195972f6Sopenharmony_ci 669195972f6Sopenharmony_ciSHOW_USED_FILES = YES 670195972f6Sopenharmony_ci 671195972f6Sopenharmony_ci# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 672195972f6Sopenharmony_ci# will remove the Files entry from the Quick Index and from the Folder Tree View 673195972f6Sopenharmony_ci# (if specified). 674195972f6Sopenharmony_ci# The default value is: YES. 675195972f6Sopenharmony_ci 676195972f6Sopenharmony_ciSHOW_FILES = YES 677195972f6Sopenharmony_ci 678195972f6Sopenharmony_ci# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 679195972f6Sopenharmony_ci# page. This will remove the Namespaces entry from the Quick Index and from the 680195972f6Sopenharmony_ci# Folder Tree View (if specified). 681195972f6Sopenharmony_ci# The default value is: YES. 682195972f6Sopenharmony_ci 683195972f6Sopenharmony_ciSHOW_NAMESPACES = YES 684195972f6Sopenharmony_ci 685195972f6Sopenharmony_ci# The FILE_VERSION_FILTER tag can be used to specify a program or script that 686195972f6Sopenharmony_ci# doxygen should invoke to get the current version for each file (typically from 687195972f6Sopenharmony_ci# the version control system). Doxygen will invoke the program by executing (via 688195972f6Sopenharmony_ci# popen()) the command command input-file, where command is the value of the 689195972f6Sopenharmony_ci# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 690195972f6Sopenharmony_ci# by doxygen. Whatever the program writes to standard output is used as the file 691195972f6Sopenharmony_ci# version. For an example see the documentation. 692195972f6Sopenharmony_ci 693195972f6Sopenharmony_ciFILE_VERSION_FILTER = 694195972f6Sopenharmony_ci 695195972f6Sopenharmony_ci# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 696195972f6Sopenharmony_ci# by doxygen. The layout file controls the global structure of the generated 697195972f6Sopenharmony_ci# output files in an output format independent way. To create the layout file 698195972f6Sopenharmony_ci# that represents doxygen's defaults, run doxygen with the -l option. You can 699195972f6Sopenharmony_ci# optionally specify a file name after the option, if omitted DoxygenLayout.xml 700195972f6Sopenharmony_ci# will be used as the name of the layout file. 701195972f6Sopenharmony_ci# 702195972f6Sopenharmony_ci# Note that if you run doxygen from a directory containing a file called 703195972f6Sopenharmony_ci# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 704195972f6Sopenharmony_ci# tag is left empty. 705195972f6Sopenharmony_ci 706195972f6Sopenharmony_ciLAYOUT_FILE = 707195972f6Sopenharmony_ci 708195972f6Sopenharmony_ci# The CITE_BIB_FILES tag can be used to specify one or more bib files containing 709195972f6Sopenharmony_ci# the reference definitions. This must be a list of .bib files. The .bib 710195972f6Sopenharmony_ci# extension is automatically appended if omitted. This requires the bibtex tool 711195972f6Sopenharmony_ci# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 712195972f6Sopenharmony_ci# For LaTeX the style of the bibliography can be controlled using 713195972f6Sopenharmony_ci# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 714195972f6Sopenharmony_ci# search path. See also \cite for info how to create references. 715195972f6Sopenharmony_ci 716195972f6Sopenharmony_ciCITE_BIB_FILES = 717195972f6Sopenharmony_ci 718195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 719195972f6Sopenharmony_ci# Configuration options related to warning and progress messages 720195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 721195972f6Sopenharmony_ci 722195972f6Sopenharmony_ci# The QUIET tag can be used to turn on/off the messages that are generated to 723195972f6Sopenharmony_ci# standard output by doxygen. If QUIET is set to YES this implies that the 724195972f6Sopenharmony_ci# messages are off. 725195972f6Sopenharmony_ci# The default value is: NO. 726195972f6Sopenharmony_ci 727195972f6Sopenharmony_ciQUIET = NO 728195972f6Sopenharmony_ci 729195972f6Sopenharmony_ci# The WARNINGS tag can be used to turn on/off the warning messages that are 730195972f6Sopenharmony_ci# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 731195972f6Sopenharmony_ci# this implies that the warnings are on. 732195972f6Sopenharmony_ci# 733195972f6Sopenharmony_ci# Tip: Turn warnings on while writing the documentation. 734195972f6Sopenharmony_ci# The default value is: YES. 735195972f6Sopenharmony_ci 736195972f6Sopenharmony_ciWARNINGS = YES 737195972f6Sopenharmony_ci 738195972f6Sopenharmony_ci# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 739195972f6Sopenharmony_ci# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 740195972f6Sopenharmony_ci# will automatically be disabled. 741195972f6Sopenharmony_ci# The default value is: YES. 742195972f6Sopenharmony_ci 743195972f6Sopenharmony_ciWARN_IF_UNDOCUMENTED = YES 744195972f6Sopenharmony_ci 745195972f6Sopenharmony_ci# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 746195972f6Sopenharmony_ci# potential errors in the documentation, such as not documenting some parameters 747195972f6Sopenharmony_ci# in a documented function, or documenting parameters that don't exist or using 748195972f6Sopenharmony_ci# markup commands wrongly. 749195972f6Sopenharmony_ci# The default value is: YES. 750195972f6Sopenharmony_ci 751195972f6Sopenharmony_ciWARN_IF_DOC_ERROR = YES 752195972f6Sopenharmony_ci 753195972f6Sopenharmony_ci# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 754195972f6Sopenharmony_ci# are documented, but have no documentation for their parameters or return 755195972f6Sopenharmony_ci# value. If set to NO, doxygen will only warn about wrong or incomplete 756195972f6Sopenharmony_ci# parameter documentation, but not about the absence of documentation. 757195972f6Sopenharmony_ci# The default value is: NO. 758195972f6Sopenharmony_ci 759195972f6Sopenharmony_ciWARN_NO_PARAMDOC = NO 760195972f6Sopenharmony_ci 761195972f6Sopenharmony_ci# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 762195972f6Sopenharmony_ci# a warning is encountered. 763195972f6Sopenharmony_ci# The default value is: NO. 764195972f6Sopenharmony_ci 765195972f6Sopenharmony_ciWARN_AS_ERROR = NO 766195972f6Sopenharmony_ci 767195972f6Sopenharmony_ci# The WARN_FORMAT tag determines the format of the warning messages that doxygen 768195972f6Sopenharmony_ci# can produce. The string should contain the $file, $line, and $text tags, which 769195972f6Sopenharmony_ci# will be replaced by the file and line number from which the warning originated 770195972f6Sopenharmony_ci# and the warning text. Optionally the format may contain $version, which will 771195972f6Sopenharmony_ci# be replaced by the version of the file (if it could be obtained via 772195972f6Sopenharmony_ci# FILE_VERSION_FILTER) 773195972f6Sopenharmony_ci# The default value is: $file:$line: $text. 774195972f6Sopenharmony_ci 775195972f6Sopenharmony_ciWARN_FORMAT = "$file:$line: $text " 776195972f6Sopenharmony_ci 777195972f6Sopenharmony_ci# The WARN_LOGFILE tag can be used to specify a file to which warning and error 778195972f6Sopenharmony_ci# messages should be written. If left blank the output is written to standard 779195972f6Sopenharmony_ci# error (stderr). 780195972f6Sopenharmony_ci 781195972f6Sopenharmony_ciWARN_LOGFILE = 782195972f6Sopenharmony_ci 783195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 784195972f6Sopenharmony_ci# Configuration options related to the input files 785195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 786195972f6Sopenharmony_ci 787195972f6Sopenharmony_ci# The INPUT tag is used to specify the files and/or directories that contain 788195972f6Sopenharmony_ci# documented source files. You may enter file names like myfile.cpp or 789195972f6Sopenharmony_ci# directories like /usr/src/myproject. Separate the files or directories with 790195972f6Sopenharmony_ci# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 791195972f6Sopenharmony_ci# Note: If this tag is empty the current directory is searched. 792195972f6Sopenharmony_ci 793195972f6Sopenharmony_ciINPUT = main_page.h \ 794195972f6Sopenharmony_ci ../../src 795195972f6Sopenharmony_ci 796195972f6Sopenharmony_ci# This tag can be used to specify the character encoding of the source files 797195972f6Sopenharmony_ci# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 798195972f6Sopenharmony_ci# libiconv (or the iconv built into libc) for the transcoding. See the libiconv 799195972f6Sopenharmony_ci# documentation (see: http://www.gnu.org/software/libiconv) for the list of 800195972f6Sopenharmony_ci# possible encodings. 801195972f6Sopenharmony_ci# The default value is: UTF-8. 802195972f6Sopenharmony_ci 803195972f6Sopenharmony_ciINPUT_ENCODING = UTF-8 804195972f6Sopenharmony_ci 805195972f6Sopenharmony_ci# If the value of the INPUT tag contains directories, you can use the 806195972f6Sopenharmony_ci# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 807195972f6Sopenharmony_ci# *.h) to filter out the source-files in the directories. 808195972f6Sopenharmony_ci# 809195972f6Sopenharmony_ci# Note that for custom extensions or not directly supported extensions you also 810195972f6Sopenharmony_ci# need to set EXTENSION_MAPPING for the extension otherwise the files are not 811195972f6Sopenharmony_ci# read by doxygen. 812195972f6Sopenharmony_ci# 813195972f6Sopenharmony_ci# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 814195972f6Sopenharmony_ci# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 815195972f6Sopenharmony_ci# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 816195972f6Sopenharmony_ci# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, 817195972f6Sopenharmony_ci# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. 818195972f6Sopenharmony_ci 819195972f6Sopenharmony_ciFILE_PATTERNS = *.c \ 820195972f6Sopenharmony_ci *.cc \ 821195972f6Sopenharmony_ci *.cxx \ 822195972f6Sopenharmony_ci *.cpp \ 823195972f6Sopenharmony_ci *.c++ \ 824195972f6Sopenharmony_ci *.java \ 825195972f6Sopenharmony_ci *.ii \ 826195972f6Sopenharmony_ci *.ixx \ 827195972f6Sopenharmony_ci *.ipp \ 828195972f6Sopenharmony_ci *.i++ \ 829195972f6Sopenharmony_ci *.inl \ 830195972f6Sopenharmony_ci *.h \ 831195972f6Sopenharmony_ci *.hh \ 832195972f6Sopenharmony_ci *.hxx \ 833195972f6Sopenharmony_ci *.hpp \ 834195972f6Sopenharmony_ci *.h++ \ 835195972f6Sopenharmony_ci *.idl \ 836195972f6Sopenharmony_ci *.odl \ 837195972f6Sopenharmony_ci *.inc \ 838195972f6Sopenharmony_ci *.m \ 839195972f6Sopenharmony_ci *.mm \ 840195972f6Sopenharmony_ci *.dox 841195972f6Sopenharmony_ci 842195972f6Sopenharmony_ci# The RECURSIVE tag can be used to specify whether or not subdirectories should 843195972f6Sopenharmony_ci# be searched for input files as well. 844195972f6Sopenharmony_ci# The default value is: NO. 845195972f6Sopenharmony_ci 846195972f6Sopenharmony_ciRECURSIVE = YES 847195972f6Sopenharmony_ci 848195972f6Sopenharmony_ci# The EXCLUDE tag can be used to specify files and/or directories that should be 849195972f6Sopenharmony_ci# excluded from the INPUT source files. This way you can easily exclude a 850195972f6Sopenharmony_ci# subdirectory from a directory tree whose root is specified with the INPUT tag. 851195972f6Sopenharmony_ci# 852195972f6Sopenharmony_ci# Note that relative paths are relative to the directory from which doxygen is 853195972f6Sopenharmony_ci# run. 854195972f6Sopenharmony_ci 855195972f6Sopenharmony_ciEXCLUDE = ../../src/include/netif/ppp/polarssl 856195972f6Sopenharmony_ci 857195972f6Sopenharmony_ci# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 858195972f6Sopenharmony_ci# directories that are symbolic links (a Unix file system feature) are excluded 859195972f6Sopenharmony_ci# from the input. 860195972f6Sopenharmony_ci# The default value is: NO. 861195972f6Sopenharmony_ci 862195972f6Sopenharmony_ciEXCLUDE_SYMLINKS = NO 863195972f6Sopenharmony_ci 864195972f6Sopenharmony_ci# If the value of the INPUT tag contains directories, you can use the 865195972f6Sopenharmony_ci# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 866195972f6Sopenharmony_ci# certain files from those directories. 867195972f6Sopenharmony_ci# 868195972f6Sopenharmony_ci# Note that the wildcards are matched against the file with absolute path, so to 869195972f6Sopenharmony_ci# exclude all test directories for example use the pattern */test/* 870195972f6Sopenharmony_ci 871195972f6Sopenharmony_ciEXCLUDE_PATTERNS = 872195972f6Sopenharmony_ci 873195972f6Sopenharmony_ci# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 874195972f6Sopenharmony_ci# (namespaces, classes, functions, etc.) that should be excluded from the 875195972f6Sopenharmony_ci# output. The symbol name can be a fully qualified name, a word, or if the 876195972f6Sopenharmony_ci# wildcard * is used, a substring. Examples: ANamespace, AClass, 877195972f6Sopenharmony_ci# AClass::ANamespace, ANamespace::*Test 878195972f6Sopenharmony_ci# 879195972f6Sopenharmony_ci# Note that the wildcards are matched against the file with absolute path, so to 880195972f6Sopenharmony_ci# exclude all test directories use the pattern */test/* 881195972f6Sopenharmony_ci 882195972f6Sopenharmony_ciEXCLUDE_SYMBOLS = 883195972f6Sopenharmony_ci 884195972f6Sopenharmony_ci# The EXAMPLE_PATH tag can be used to specify one or more files or directories 885195972f6Sopenharmony_ci# that contain example code fragments that are included (see the \include 886195972f6Sopenharmony_ci# command). 887195972f6Sopenharmony_ci 888195972f6Sopenharmony_ciEXAMPLE_PATH = ../ \ 889195972f6Sopenharmony_ci ../../ 890195972f6Sopenharmony_ci 891195972f6Sopenharmony_ci# If the value of the EXAMPLE_PATH tag contains directories, you can use the 892195972f6Sopenharmony_ci# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 893195972f6Sopenharmony_ci# *.h) to filter out the source-files in the directories. If left blank all 894195972f6Sopenharmony_ci# files are included. 895195972f6Sopenharmony_ci 896195972f6Sopenharmony_ciEXAMPLE_PATTERNS = * 897195972f6Sopenharmony_ci 898195972f6Sopenharmony_ci# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 899195972f6Sopenharmony_ci# searched for input files to be used with the \include or \dontinclude commands 900195972f6Sopenharmony_ci# irrespective of the value of the RECURSIVE tag. 901195972f6Sopenharmony_ci# The default value is: NO. 902195972f6Sopenharmony_ci 903195972f6Sopenharmony_ciEXAMPLE_RECURSIVE = NO 904195972f6Sopenharmony_ci 905195972f6Sopenharmony_ci# The IMAGE_PATH tag can be used to specify one or more files or directories 906195972f6Sopenharmony_ci# that contain images that are to be included in the documentation (see the 907195972f6Sopenharmony_ci# \image command). 908195972f6Sopenharmony_ci 909195972f6Sopenharmony_ciIMAGE_PATH = 910195972f6Sopenharmony_ci 911195972f6Sopenharmony_ci# The INPUT_FILTER tag can be used to specify a program that doxygen should 912195972f6Sopenharmony_ci# invoke to filter for each input file. Doxygen will invoke the filter program 913195972f6Sopenharmony_ci# by executing (via popen()) the command: 914195972f6Sopenharmony_ci# 915195972f6Sopenharmony_ci# <filter> <input-file> 916195972f6Sopenharmony_ci# 917195972f6Sopenharmony_ci# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the 918195972f6Sopenharmony_ci# name of an input file. Doxygen will then use the output that the filter 919195972f6Sopenharmony_ci# program writes to standard output. If FILTER_PATTERNS is specified, this tag 920195972f6Sopenharmony_ci# will be ignored. 921195972f6Sopenharmony_ci# 922195972f6Sopenharmony_ci# Note that the filter must not add or remove lines; it is applied before the 923195972f6Sopenharmony_ci# code is scanned, but not when the output code is generated. If lines are added 924195972f6Sopenharmony_ci# or removed, the anchors will not be placed correctly. 925195972f6Sopenharmony_ci# 926195972f6Sopenharmony_ci# Note that for custom extensions or not directly supported extensions you also 927195972f6Sopenharmony_ci# need to set EXTENSION_MAPPING for the extension otherwise the files are not 928195972f6Sopenharmony_ci# properly processed by doxygen. 929195972f6Sopenharmony_ci 930195972f6Sopenharmony_ciINPUT_FILTER = 931195972f6Sopenharmony_ci 932195972f6Sopenharmony_ci# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 933195972f6Sopenharmony_ci# basis. Doxygen will compare the file name with each pattern and apply the 934195972f6Sopenharmony_ci# filter if there is a match. The filters are a list of the form: pattern=filter 935195972f6Sopenharmony_ci# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 936195972f6Sopenharmony_ci# filters are used. If the FILTER_PATTERNS tag is empty or if none of the 937195972f6Sopenharmony_ci# patterns match the file name, INPUT_FILTER is applied. 938195972f6Sopenharmony_ci# 939195972f6Sopenharmony_ci# Note that for custom extensions or not directly supported extensions you also 940195972f6Sopenharmony_ci# need to set EXTENSION_MAPPING for the extension otherwise the files are not 941195972f6Sopenharmony_ci# properly processed by doxygen. 942195972f6Sopenharmony_ci 943195972f6Sopenharmony_ciFILTER_PATTERNS = 944195972f6Sopenharmony_ci 945195972f6Sopenharmony_ci# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 946195972f6Sopenharmony_ci# INPUT_FILTER) will also be used to filter the input files that are used for 947195972f6Sopenharmony_ci# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 948195972f6Sopenharmony_ci# The default value is: NO. 949195972f6Sopenharmony_ci 950195972f6Sopenharmony_ciFILTER_SOURCE_FILES = NO 951195972f6Sopenharmony_ci 952195972f6Sopenharmony_ci# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 953195972f6Sopenharmony_ci# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 954195972f6Sopenharmony_ci# it is also possible to disable source filtering for a specific pattern using 955195972f6Sopenharmony_ci# *.ext= (so without naming a filter). 956195972f6Sopenharmony_ci# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 957195972f6Sopenharmony_ci 958195972f6Sopenharmony_ciFILTER_SOURCE_PATTERNS = 959195972f6Sopenharmony_ci 960195972f6Sopenharmony_ci# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 961195972f6Sopenharmony_ci# is part of the input, its contents will be placed on the main page 962195972f6Sopenharmony_ci# (index.html). This can be useful if you have a project on for instance GitHub 963195972f6Sopenharmony_ci# and want to reuse the introduction page also for the doxygen output. 964195972f6Sopenharmony_ci 965195972f6Sopenharmony_ciUSE_MDFILE_AS_MAINPAGE = main_page.h 966195972f6Sopenharmony_ci 967195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 968195972f6Sopenharmony_ci# Configuration options related to source browsing 969195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 970195972f6Sopenharmony_ci 971195972f6Sopenharmony_ci# If the SOURCE_BROWSER tag is set to YES then a list of source files will be 972195972f6Sopenharmony_ci# generated. Documented entities will be cross-referenced with these sources. 973195972f6Sopenharmony_ci# 974195972f6Sopenharmony_ci# Note: To get rid of all source code in the generated output, make sure that 975195972f6Sopenharmony_ci# also VERBATIM_HEADERS is set to NO. 976195972f6Sopenharmony_ci# The default value is: NO. 977195972f6Sopenharmony_ci 978195972f6Sopenharmony_ciSOURCE_BROWSER = NO 979195972f6Sopenharmony_ci 980195972f6Sopenharmony_ci# Setting the INLINE_SOURCES tag to YES will include the body of functions, 981195972f6Sopenharmony_ci# classes and enums directly into the documentation. 982195972f6Sopenharmony_ci# The default value is: NO. 983195972f6Sopenharmony_ci 984195972f6Sopenharmony_ciINLINE_SOURCES = NO 985195972f6Sopenharmony_ci 986195972f6Sopenharmony_ci# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 987195972f6Sopenharmony_ci# special comment blocks from generated source code fragments. Normal C, C++ and 988195972f6Sopenharmony_ci# Fortran comments will always remain visible. 989195972f6Sopenharmony_ci# The default value is: YES. 990195972f6Sopenharmony_ci 991195972f6Sopenharmony_ciSTRIP_CODE_COMMENTS = YES 992195972f6Sopenharmony_ci 993195972f6Sopenharmony_ci# If the REFERENCED_BY_RELATION tag is set to YES then for each documented 994195972f6Sopenharmony_ci# function all documented functions referencing it will be listed. 995195972f6Sopenharmony_ci# The default value is: NO. 996195972f6Sopenharmony_ci 997195972f6Sopenharmony_ciREFERENCED_BY_RELATION = NO 998195972f6Sopenharmony_ci 999195972f6Sopenharmony_ci# If the REFERENCES_RELATION tag is set to YES then for each documented function 1000195972f6Sopenharmony_ci# all documented entities called/used by that function will be listed. 1001195972f6Sopenharmony_ci# The default value is: NO. 1002195972f6Sopenharmony_ci 1003195972f6Sopenharmony_ciREFERENCES_RELATION = NO 1004195972f6Sopenharmony_ci 1005195972f6Sopenharmony_ci# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1006195972f6Sopenharmony_ci# to YES then the hyperlinks from functions in REFERENCES_RELATION and 1007195972f6Sopenharmony_ci# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1008195972f6Sopenharmony_ci# link to the documentation. 1009195972f6Sopenharmony_ci# The default value is: YES. 1010195972f6Sopenharmony_ci 1011195972f6Sopenharmony_ciREFERENCES_LINK_SOURCE = YES 1012195972f6Sopenharmony_ci 1013195972f6Sopenharmony_ci# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1014195972f6Sopenharmony_ci# source code will show a tooltip with additional information such as prototype, 1015195972f6Sopenharmony_ci# brief description and links to the definition and documentation. Since this 1016195972f6Sopenharmony_ci# will make the HTML file larger and loading of large files a bit slower, you 1017195972f6Sopenharmony_ci# can opt to disable this feature. 1018195972f6Sopenharmony_ci# The default value is: YES. 1019195972f6Sopenharmony_ci# This tag requires that the tag SOURCE_BROWSER is set to YES. 1020195972f6Sopenharmony_ci 1021195972f6Sopenharmony_ciSOURCE_TOOLTIPS = YES 1022195972f6Sopenharmony_ci 1023195972f6Sopenharmony_ci# If the USE_HTAGS tag is set to YES then the references to source code will 1024195972f6Sopenharmony_ci# point to the HTML generated by the htags(1) tool instead of doxygen built-in 1025195972f6Sopenharmony_ci# source browser. The htags tool is part of GNU's global source tagging system 1026195972f6Sopenharmony_ci# (see http://www.gnu.org/software/global/global.html). You will need version 1027195972f6Sopenharmony_ci# 4.8.6 or higher. 1028195972f6Sopenharmony_ci# 1029195972f6Sopenharmony_ci# To use it do the following: 1030195972f6Sopenharmony_ci# - Install the latest version of global 1031195972f6Sopenharmony_ci# - Enable SOURCE_BROWSER and USE_HTAGS in the config file 1032195972f6Sopenharmony_ci# - Make sure the INPUT points to the root of the source tree 1033195972f6Sopenharmony_ci# - Run doxygen as normal 1034195972f6Sopenharmony_ci# 1035195972f6Sopenharmony_ci# Doxygen will invoke htags (and that will in turn invoke gtags), so these 1036195972f6Sopenharmony_ci# tools must be available from the command line (i.e. in the search path). 1037195972f6Sopenharmony_ci# 1038195972f6Sopenharmony_ci# The result: instead of the source browser generated by doxygen, the links to 1039195972f6Sopenharmony_ci# source code will now point to the output of htags. 1040195972f6Sopenharmony_ci# The default value is: NO. 1041195972f6Sopenharmony_ci# This tag requires that the tag SOURCE_BROWSER is set to YES. 1042195972f6Sopenharmony_ci 1043195972f6Sopenharmony_ciUSE_HTAGS = NO 1044195972f6Sopenharmony_ci 1045195972f6Sopenharmony_ci# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1046195972f6Sopenharmony_ci# verbatim copy of the header file for each class for which an include is 1047195972f6Sopenharmony_ci# specified. Set to NO to disable this. 1048195972f6Sopenharmony_ci# See also: Section \class. 1049195972f6Sopenharmony_ci# The default value is: YES. 1050195972f6Sopenharmony_ci 1051195972f6Sopenharmony_ciVERBATIM_HEADERS = NO 1052195972f6Sopenharmony_ci 1053195972f6Sopenharmony_ci# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the 1054195972f6Sopenharmony_ci# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the 1055195972f6Sopenharmony_ci# cost of reduced performance. This can be particularly helpful with template 1056195972f6Sopenharmony_ci# rich C++ code for which doxygen's built-in parser lacks the necessary type 1057195972f6Sopenharmony_ci# information. 1058195972f6Sopenharmony_ci# Note: The availability of this option depends on whether or not doxygen was 1059195972f6Sopenharmony_ci# generated with the -Duse-libclang=ON option for CMake. 1060195972f6Sopenharmony_ci# The default value is: NO. 1061195972f6Sopenharmony_ci 1062195972f6Sopenharmony_ciCLANG_ASSISTED_PARSING = NO 1063195972f6Sopenharmony_ci 1064195972f6Sopenharmony_ci# If clang assisted parsing is enabled you can provide the compiler with command 1065195972f6Sopenharmony_ci# line options that you would normally use when invoking the compiler. Note that 1066195972f6Sopenharmony_ci# the include paths will already be set by doxygen for the files and directories 1067195972f6Sopenharmony_ci# specified with INPUT and INCLUDE_PATH. 1068195972f6Sopenharmony_ci# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. 1069195972f6Sopenharmony_ci 1070195972f6Sopenharmony_ciCLANG_OPTIONS = 1071195972f6Sopenharmony_ci 1072195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 1073195972f6Sopenharmony_ci# Configuration options related to the alphabetical class index 1074195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 1075195972f6Sopenharmony_ci 1076195972f6Sopenharmony_ci# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1077195972f6Sopenharmony_ci# compounds will be generated. Enable this if the project contains a lot of 1078195972f6Sopenharmony_ci# classes, structs, unions or interfaces. 1079195972f6Sopenharmony_ci# The default value is: YES. 1080195972f6Sopenharmony_ci 1081195972f6Sopenharmony_ciALPHABETICAL_INDEX = NO 1082195972f6Sopenharmony_ci 1083195972f6Sopenharmony_ci# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1084195972f6Sopenharmony_ci# which the alphabetical index list will be split. 1085195972f6Sopenharmony_ci# Minimum value: 1, maximum value: 20, default value: 5. 1086195972f6Sopenharmony_ci# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1087195972f6Sopenharmony_ci 1088195972f6Sopenharmony_ciCOLS_IN_ALPHA_INDEX = 5 1089195972f6Sopenharmony_ci 1090195972f6Sopenharmony_ci# In case all classes in a project start with a common prefix, all classes will 1091195972f6Sopenharmony_ci# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1092195972f6Sopenharmony_ci# can be used to specify a prefix (or a list of prefixes) that should be ignored 1093195972f6Sopenharmony_ci# while generating the index headers. 1094195972f6Sopenharmony_ci# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1095195972f6Sopenharmony_ci 1096195972f6Sopenharmony_ciIGNORE_PREFIX = 1097195972f6Sopenharmony_ci 1098195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 1099195972f6Sopenharmony_ci# Configuration options related to the HTML output 1100195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 1101195972f6Sopenharmony_ci 1102195972f6Sopenharmony_ci# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1103195972f6Sopenharmony_ci# The default value is: YES. 1104195972f6Sopenharmony_ci 1105195972f6Sopenharmony_ciGENERATE_HTML = YES 1106195972f6Sopenharmony_ci 1107195972f6Sopenharmony_ci# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1108195972f6Sopenharmony_ci# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1109195972f6Sopenharmony_ci# it. 1110195972f6Sopenharmony_ci# The default directory is: html. 1111195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1112195972f6Sopenharmony_ci 1113195972f6Sopenharmony_ciHTML_OUTPUT = html 1114195972f6Sopenharmony_ci 1115195972f6Sopenharmony_ci# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1116195972f6Sopenharmony_ci# generated HTML page (for example: .htm, .php, .asp). 1117195972f6Sopenharmony_ci# The default value is: .html. 1118195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1119195972f6Sopenharmony_ci 1120195972f6Sopenharmony_ciHTML_FILE_EXTENSION = .html 1121195972f6Sopenharmony_ci 1122195972f6Sopenharmony_ci# The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1123195972f6Sopenharmony_ci# each generated HTML page. If the tag is left blank doxygen will generate a 1124195972f6Sopenharmony_ci# standard header. 1125195972f6Sopenharmony_ci# 1126195972f6Sopenharmony_ci# To get valid HTML the header file that includes any scripts and style sheets 1127195972f6Sopenharmony_ci# that doxygen needs, which is dependent on the configuration options used (e.g. 1128195972f6Sopenharmony_ci# the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1129195972f6Sopenharmony_ci# default header using 1130195972f6Sopenharmony_ci# doxygen -w html new_header.html new_footer.html new_stylesheet.css 1131195972f6Sopenharmony_ci# YourConfigFile 1132195972f6Sopenharmony_ci# and then modify the file new_header.html. See also section "Doxygen usage" 1133195972f6Sopenharmony_ci# for information on how to generate the default header that doxygen normally 1134195972f6Sopenharmony_ci# uses. 1135195972f6Sopenharmony_ci# Note: The header is subject to change so you typically have to regenerate the 1136195972f6Sopenharmony_ci# default header when upgrading to a newer version of doxygen. For a description 1137195972f6Sopenharmony_ci# of the possible markers and block names see the documentation. 1138195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1139195972f6Sopenharmony_ci 1140195972f6Sopenharmony_ciHTML_HEADER = 1141195972f6Sopenharmony_ci 1142195972f6Sopenharmony_ci# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1143195972f6Sopenharmony_ci# generated HTML page. If the tag is left blank doxygen will generate a standard 1144195972f6Sopenharmony_ci# footer. See HTML_HEADER for more information on how to generate a default 1145195972f6Sopenharmony_ci# footer and what special commands can be used inside the footer. See also 1146195972f6Sopenharmony_ci# section "Doxygen usage" for information on how to generate the default footer 1147195972f6Sopenharmony_ci# that doxygen normally uses. 1148195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1149195972f6Sopenharmony_ci 1150195972f6Sopenharmony_ciHTML_FOOTER = 1151195972f6Sopenharmony_ci 1152195972f6Sopenharmony_ci# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1153195972f6Sopenharmony_ci# sheet that is used by each HTML page. It can be used to fine-tune the look of 1154195972f6Sopenharmony_ci# the HTML output. If left blank doxygen will generate a default style sheet. 1155195972f6Sopenharmony_ci# See also section "Doxygen usage" for information on how to generate the style 1156195972f6Sopenharmony_ci# sheet that doxygen normally uses. 1157195972f6Sopenharmony_ci# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1158195972f6Sopenharmony_ci# it is more robust and this tag (HTML_STYLESHEET) will in the future become 1159195972f6Sopenharmony_ci# obsolete. 1160195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1161195972f6Sopenharmony_ci 1162195972f6Sopenharmony_ciHTML_STYLESHEET = 1163195972f6Sopenharmony_ci 1164195972f6Sopenharmony_ci# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1165195972f6Sopenharmony_ci# cascading style sheets that are included after the standard style sheets 1166195972f6Sopenharmony_ci# created by doxygen. Using this option one can overrule certain style aspects. 1167195972f6Sopenharmony_ci# This is preferred over using HTML_STYLESHEET since it does not replace the 1168195972f6Sopenharmony_ci# standard style sheet and is therefore more robust against future updates. 1169195972f6Sopenharmony_ci# Doxygen will copy the style sheet files to the output directory. 1170195972f6Sopenharmony_ci# Note: The order of the extra style sheet files is of importance (e.g. the last 1171195972f6Sopenharmony_ci# style sheet in the list overrules the setting of the previous ones in the 1172195972f6Sopenharmony_ci# list). For an example see the documentation. 1173195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1174195972f6Sopenharmony_ci 1175195972f6Sopenharmony_ciHTML_EXTRA_STYLESHEET = 1176195972f6Sopenharmony_ci 1177195972f6Sopenharmony_ci# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1178195972f6Sopenharmony_ci# other source files which should be copied to the HTML output directory. Note 1179195972f6Sopenharmony_ci# that these files will be copied to the base HTML output directory. Use the 1180195972f6Sopenharmony_ci# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1181195972f6Sopenharmony_ci# files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1182195972f6Sopenharmony_ci# files will be copied as-is; there are no commands or markers available. 1183195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1184195972f6Sopenharmony_ci 1185195972f6Sopenharmony_ciHTML_EXTRA_FILES = 1186195972f6Sopenharmony_ci 1187195972f6Sopenharmony_ci# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1188195972f6Sopenharmony_ci# will adjust the colors in the style sheet and background images according to 1189195972f6Sopenharmony_ci# this color. Hue is specified as an angle on a colorwheel, see 1190195972f6Sopenharmony_ci# http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1191195972f6Sopenharmony_ci# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1192195972f6Sopenharmony_ci# purple, and 360 is red again. 1193195972f6Sopenharmony_ci# Minimum value: 0, maximum value: 359, default value: 220. 1194195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1195195972f6Sopenharmony_ci 1196195972f6Sopenharmony_ciHTML_COLORSTYLE_HUE = 220 1197195972f6Sopenharmony_ci 1198195972f6Sopenharmony_ci# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1199195972f6Sopenharmony_ci# in the HTML output. For a value of 0 the output will use grayscales only. A 1200195972f6Sopenharmony_ci# value of 255 will produce the most vivid colors. 1201195972f6Sopenharmony_ci# Minimum value: 0, maximum value: 255, default value: 100. 1202195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1203195972f6Sopenharmony_ci 1204195972f6Sopenharmony_ciHTML_COLORSTYLE_SAT = 100 1205195972f6Sopenharmony_ci 1206195972f6Sopenharmony_ci# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1207195972f6Sopenharmony_ci# luminance component of the colors in the HTML output. Values below 100 1208195972f6Sopenharmony_ci# gradually make the output lighter, whereas values above 100 make the output 1209195972f6Sopenharmony_ci# darker. The value divided by 100 is the actual gamma applied, so 80 represents 1210195972f6Sopenharmony_ci# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1211195972f6Sopenharmony_ci# change the gamma. 1212195972f6Sopenharmony_ci# Minimum value: 40, maximum value: 240, default value: 80. 1213195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1214195972f6Sopenharmony_ci 1215195972f6Sopenharmony_ciHTML_COLORSTYLE_GAMMA = 80 1216195972f6Sopenharmony_ci 1217195972f6Sopenharmony_ci# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1218195972f6Sopenharmony_ci# page will contain the date and time when the page was generated. Setting this 1219195972f6Sopenharmony_ci# to YES can help to show when doxygen was last run and thus if the 1220195972f6Sopenharmony_ci# documentation is up to date. 1221195972f6Sopenharmony_ci# The default value is: NO. 1222195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1223195972f6Sopenharmony_ci 1224195972f6Sopenharmony_ciHTML_TIMESTAMP = NO 1225195972f6Sopenharmony_ci 1226195972f6Sopenharmony_ci# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1227195972f6Sopenharmony_ci# documentation will contain sections that can be hidden and shown after the 1228195972f6Sopenharmony_ci# page has loaded. 1229195972f6Sopenharmony_ci# The default value is: NO. 1230195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1231195972f6Sopenharmony_ci 1232195972f6Sopenharmony_ciHTML_DYNAMIC_SECTIONS = NO 1233195972f6Sopenharmony_ci 1234195972f6Sopenharmony_ci# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1235195972f6Sopenharmony_ci# shown in the various tree structured indices initially; the user can expand 1236195972f6Sopenharmony_ci# and collapse entries dynamically later on. Doxygen will expand the tree to 1237195972f6Sopenharmony_ci# such a level that at most the specified number of entries are visible (unless 1238195972f6Sopenharmony_ci# a fully collapsed tree already exceeds this amount). So setting the number of 1239195972f6Sopenharmony_ci# entries 1 will produce a full collapsed tree by default. 0 is a special value 1240195972f6Sopenharmony_ci# representing an infinite number of entries and will result in a full expanded 1241195972f6Sopenharmony_ci# tree by default. 1242195972f6Sopenharmony_ci# Minimum value: 0, maximum value: 9999, default value: 100. 1243195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1244195972f6Sopenharmony_ci 1245195972f6Sopenharmony_ciHTML_INDEX_NUM_ENTRIES = 100 1246195972f6Sopenharmony_ci 1247195972f6Sopenharmony_ci# If the GENERATE_DOCSET tag is set to YES, additional index files will be 1248195972f6Sopenharmony_ci# generated that can be used as input for Apple's Xcode 3 integrated development 1249195972f6Sopenharmony_ci# environment (see: http://developer.apple.com/tools/xcode/), introduced with 1250195972f6Sopenharmony_ci# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1251195972f6Sopenharmony_ci# Makefile in the HTML output directory. Running make will produce the docset in 1252195972f6Sopenharmony_ci# that directory and running make install will install the docset in 1253195972f6Sopenharmony_ci# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1254195972f6Sopenharmony_ci# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1255195972f6Sopenharmony_ci# for more information. 1256195972f6Sopenharmony_ci# The default value is: NO. 1257195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1258195972f6Sopenharmony_ci 1259195972f6Sopenharmony_ciGENERATE_DOCSET = NO 1260195972f6Sopenharmony_ci 1261195972f6Sopenharmony_ci# This tag determines the name of the docset feed. A documentation feed provides 1262195972f6Sopenharmony_ci# an umbrella under which multiple documentation sets from a single provider 1263195972f6Sopenharmony_ci# (such as a company or product suite) can be grouped. 1264195972f6Sopenharmony_ci# The default value is: Doxygen generated docs. 1265195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_DOCSET is set to YES. 1266195972f6Sopenharmony_ci 1267195972f6Sopenharmony_ciDOCSET_FEEDNAME = "Doxygen generated docs" 1268195972f6Sopenharmony_ci 1269195972f6Sopenharmony_ci# This tag specifies a string that should uniquely identify the documentation 1270195972f6Sopenharmony_ci# set bundle. This should be a reverse domain-name style string, e.g. 1271195972f6Sopenharmony_ci# com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1272195972f6Sopenharmony_ci# The default value is: org.doxygen.Project. 1273195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_DOCSET is set to YES. 1274195972f6Sopenharmony_ci 1275195972f6Sopenharmony_ciDOCSET_BUNDLE_ID = org.doxygen.Project 1276195972f6Sopenharmony_ci 1277195972f6Sopenharmony_ci# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1278195972f6Sopenharmony_ci# the documentation publisher. This should be a reverse domain-name style 1279195972f6Sopenharmony_ci# string, e.g. com.mycompany.MyDocSet.documentation. 1280195972f6Sopenharmony_ci# The default value is: org.doxygen.Publisher. 1281195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_DOCSET is set to YES. 1282195972f6Sopenharmony_ci 1283195972f6Sopenharmony_ciDOCSET_PUBLISHER_ID = org.doxygen.Publisher 1284195972f6Sopenharmony_ci 1285195972f6Sopenharmony_ci# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1286195972f6Sopenharmony_ci# The default value is: Publisher. 1287195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_DOCSET is set to YES. 1288195972f6Sopenharmony_ci 1289195972f6Sopenharmony_ciDOCSET_PUBLISHER_NAME = Publisher 1290195972f6Sopenharmony_ci 1291195972f6Sopenharmony_ci# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1292195972f6Sopenharmony_ci# additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1293195972f6Sopenharmony_ci# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1294195972f6Sopenharmony_ci# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1295195972f6Sopenharmony_ci# Windows. 1296195972f6Sopenharmony_ci# 1297195972f6Sopenharmony_ci# The HTML Help Workshop contains a compiler that can convert all HTML output 1298195972f6Sopenharmony_ci# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1299195972f6Sopenharmony_ci# files are now used as the Windows 98 help format, and will replace the old 1300195972f6Sopenharmony_ci# Windows help format (.hlp) on all Windows platforms in the future. Compressed 1301195972f6Sopenharmony_ci# HTML files also contain an index, a table of contents, and you can search for 1302195972f6Sopenharmony_ci# words in the documentation. The HTML workshop also contains a viewer for 1303195972f6Sopenharmony_ci# compressed HTML files. 1304195972f6Sopenharmony_ci# The default value is: NO. 1305195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1306195972f6Sopenharmony_ci 1307195972f6Sopenharmony_ciGENERATE_HTMLHELP = NO 1308195972f6Sopenharmony_ci 1309195972f6Sopenharmony_ci# The CHM_FILE tag can be used to specify the file name of the resulting .chm 1310195972f6Sopenharmony_ci# file. You can add a path in front of the file if the result should not be 1311195972f6Sopenharmony_ci# written to the html output directory. 1312195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1313195972f6Sopenharmony_ci 1314195972f6Sopenharmony_ciCHM_FILE = lwip.chm 1315195972f6Sopenharmony_ci 1316195972f6Sopenharmony_ci# The HHC_LOCATION tag can be used to specify the location (absolute path 1317195972f6Sopenharmony_ci# including file name) of the HTML help compiler (hhc.exe). If non-empty, 1318195972f6Sopenharmony_ci# doxygen will try to run the HTML help compiler on the generated index.hhp. 1319195972f6Sopenharmony_ci# The file has to be specified with full path. 1320195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1321195972f6Sopenharmony_ci 1322195972f6Sopenharmony_ciHHC_LOCATION = 1323195972f6Sopenharmony_ci 1324195972f6Sopenharmony_ci# The GENERATE_CHI flag controls if a separate .chi index file is generated 1325195972f6Sopenharmony_ci# (YES) or that it should be included in the master .chm file (NO). 1326195972f6Sopenharmony_ci# The default value is: NO. 1327195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1328195972f6Sopenharmony_ci 1329195972f6Sopenharmony_ciGENERATE_CHI = NO 1330195972f6Sopenharmony_ci 1331195972f6Sopenharmony_ci# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1332195972f6Sopenharmony_ci# and project file content. 1333195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1334195972f6Sopenharmony_ci 1335195972f6Sopenharmony_ciCHM_INDEX_ENCODING = 1336195972f6Sopenharmony_ci 1337195972f6Sopenharmony_ci# The BINARY_TOC flag controls whether a binary table of contents is generated 1338195972f6Sopenharmony_ci# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1339195972f6Sopenharmony_ci# enables the Previous and Next buttons. 1340195972f6Sopenharmony_ci# The default value is: NO. 1341195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1342195972f6Sopenharmony_ci 1343195972f6Sopenharmony_ciBINARY_TOC = NO 1344195972f6Sopenharmony_ci 1345195972f6Sopenharmony_ci# The TOC_EXPAND flag can be set to YES to add extra items for group members to 1346195972f6Sopenharmony_ci# the table of contents of the HTML help documentation and to the tree view. 1347195972f6Sopenharmony_ci# The default value is: NO. 1348195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1349195972f6Sopenharmony_ci 1350195972f6Sopenharmony_ciTOC_EXPAND = NO 1351195972f6Sopenharmony_ci 1352195972f6Sopenharmony_ci# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1353195972f6Sopenharmony_ci# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1354195972f6Sopenharmony_ci# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1355195972f6Sopenharmony_ci# (.qch) of the generated HTML documentation. 1356195972f6Sopenharmony_ci# The default value is: NO. 1357195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1358195972f6Sopenharmony_ci 1359195972f6Sopenharmony_ciGENERATE_QHP = NO 1360195972f6Sopenharmony_ci 1361195972f6Sopenharmony_ci# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1362195972f6Sopenharmony_ci# the file name of the resulting .qch file. The path specified is relative to 1363195972f6Sopenharmony_ci# the HTML output folder. 1364195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_QHP is set to YES. 1365195972f6Sopenharmony_ci 1366195972f6Sopenharmony_ciQCH_FILE = 1367195972f6Sopenharmony_ci 1368195972f6Sopenharmony_ci# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1369195972f6Sopenharmony_ci# Project output. For more information please see Qt Help Project / Namespace 1370195972f6Sopenharmony_ci# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1371195972f6Sopenharmony_ci# The default value is: org.doxygen.Project. 1372195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_QHP is set to YES. 1373195972f6Sopenharmony_ci 1374195972f6Sopenharmony_ciQHP_NAMESPACE = org.doxygen.Project 1375195972f6Sopenharmony_ci 1376195972f6Sopenharmony_ci# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1377195972f6Sopenharmony_ci# Help Project output. For more information please see Qt Help Project / Virtual 1378195972f6Sopenharmony_ci# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1379195972f6Sopenharmony_ci# folders). 1380195972f6Sopenharmony_ci# The default value is: doc. 1381195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_QHP is set to YES. 1382195972f6Sopenharmony_ci 1383195972f6Sopenharmony_ciQHP_VIRTUAL_FOLDER = doc 1384195972f6Sopenharmony_ci 1385195972f6Sopenharmony_ci# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1386195972f6Sopenharmony_ci# filter to add. For more information please see Qt Help Project / Custom 1387195972f6Sopenharmony_ci# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1388195972f6Sopenharmony_ci# filters). 1389195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_QHP is set to YES. 1390195972f6Sopenharmony_ci 1391195972f6Sopenharmony_ciQHP_CUST_FILTER_NAME = 1392195972f6Sopenharmony_ci 1393195972f6Sopenharmony_ci# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1394195972f6Sopenharmony_ci# custom filter to add. For more information please see Qt Help Project / Custom 1395195972f6Sopenharmony_ci# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1396195972f6Sopenharmony_ci# filters). 1397195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_QHP is set to YES. 1398195972f6Sopenharmony_ci 1399195972f6Sopenharmony_ciQHP_CUST_FILTER_ATTRS = 1400195972f6Sopenharmony_ci 1401195972f6Sopenharmony_ci# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1402195972f6Sopenharmony_ci# project's filter section matches. Qt Help Project / Filter Attributes (see: 1403195972f6Sopenharmony_ci# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1404195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_QHP is set to YES. 1405195972f6Sopenharmony_ci 1406195972f6Sopenharmony_ciQHP_SECT_FILTER_ATTRS = 1407195972f6Sopenharmony_ci 1408195972f6Sopenharmony_ci# The QHG_LOCATION tag can be used to specify the location of Qt's 1409195972f6Sopenharmony_ci# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1410195972f6Sopenharmony_ci# generated .qhp file. 1411195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_QHP is set to YES. 1412195972f6Sopenharmony_ci 1413195972f6Sopenharmony_ciQHG_LOCATION = 1414195972f6Sopenharmony_ci 1415195972f6Sopenharmony_ci# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1416195972f6Sopenharmony_ci# generated, together with the HTML files, they form an Eclipse help plugin. To 1417195972f6Sopenharmony_ci# install this plugin and make it available under the help contents menu in 1418195972f6Sopenharmony_ci# Eclipse, the contents of the directory containing the HTML and XML files needs 1419195972f6Sopenharmony_ci# to be copied into the plugins directory of eclipse. The name of the directory 1420195972f6Sopenharmony_ci# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1421195972f6Sopenharmony_ci# After copying Eclipse needs to be restarted before the help appears. 1422195972f6Sopenharmony_ci# The default value is: NO. 1423195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1424195972f6Sopenharmony_ci 1425195972f6Sopenharmony_ciGENERATE_ECLIPSEHELP = NO 1426195972f6Sopenharmony_ci 1427195972f6Sopenharmony_ci# A unique identifier for the Eclipse help plugin. When installing the plugin 1428195972f6Sopenharmony_ci# the directory name containing the HTML and XML files should also have this 1429195972f6Sopenharmony_ci# name. Each documentation set should have its own identifier. 1430195972f6Sopenharmony_ci# The default value is: org.doxygen.Project. 1431195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1432195972f6Sopenharmony_ci 1433195972f6Sopenharmony_ciECLIPSE_DOC_ID = org.doxygen.Project 1434195972f6Sopenharmony_ci 1435195972f6Sopenharmony_ci# If you want full control over the layout of the generated HTML pages it might 1436195972f6Sopenharmony_ci# be necessary to disable the index and replace it with your own. The 1437195972f6Sopenharmony_ci# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1438195972f6Sopenharmony_ci# of each HTML page. A value of NO enables the index and the value YES disables 1439195972f6Sopenharmony_ci# it. Since the tabs in the index contain the same information as the navigation 1440195972f6Sopenharmony_ci# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1441195972f6Sopenharmony_ci# The default value is: NO. 1442195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1443195972f6Sopenharmony_ci 1444195972f6Sopenharmony_ciDISABLE_INDEX = NO 1445195972f6Sopenharmony_ci 1446195972f6Sopenharmony_ci# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1447195972f6Sopenharmony_ci# structure should be generated to display hierarchical information. If the tag 1448195972f6Sopenharmony_ci# value is set to YES, a side panel will be generated containing a tree-like 1449195972f6Sopenharmony_ci# index structure (just like the one that is generated for HTML Help). For this 1450195972f6Sopenharmony_ci# to work a browser that supports JavaScript, DHTML, CSS and frames is required 1451195972f6Sopenharmony_ci# (i.e. any modern browser). Windows users are probably better off using the 1452195972f6Sopenharmony_ci# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1453195972f6Sopenharmony_ci# further fine-tune the look of the index. As an example, the default style 1454195972f6Sopenharmony_ci# sheet generated by doxygen has an example that shows how to put an image at 1455195972f6Sopenharmony_ci# the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1456195972f6Sopenharmony_ci# the same information as the tab index, you could consider setting 1457195972f6Sopenharmony_ci# DISABLE_INDEX to YES when enabling this option. 1458195972f6Sopenharmony_ci# The default value is: NO. 1459195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1460195972f6Sopenharmony_ci 1461195972f6Sopenharmony_ciGENERATE_TREEVIEW = YES 1462195972f6Sopenharmony_ci 1463195972f6Sopenharmony_ci# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1464195972f6Sopenharmony_ci# doxygen will group on one line in the generated HTML documentation. 1465195972f6Sopenharmony_ci# 1466195972f6Sopenharmony_ci# Note that a value of 0 will completely suppress the enum values from appearing 1467195972f6Sopenharmony_ci# in the overview section. 1468195972f6Sopenharmony_ci# Minimum value: 0, maximum value: 20, default value: 4. 1469195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1470195972f6Sopenharmony_ci 1471195972f6Sopenharmony_ciENUM_VALUES_PER_LINE = 4 1472195972f6Sopenharmony_ci 1473195972f6Sopenharmony_ci# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1474195972f6Sopenharmony_ci# to set the initial width (in pixels) of the frame in which the tree is shown. 1475195972f6Sopenharmony_ci# Minimum value: 0, maximum value: 1500, default value: 250. 1476195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1477195972f6Sopenharmony_ci 1478195972f6Sopenharmony_ciTREEVIEW_WIDTH = 250 1479195972f6Sopenharmony_ci 1480195972f6Sopenharmony_ci# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1481195972f6Sopenharmony_ci# external symbols imported via tag files in a separate window. 1482195972f6Sopenharmony_ci# The default value is: NO. 1483195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1484195972f6Sopenharmony_ci 1485195972f6Sopenharmony_ciEXT_LINKS_IN_WINDOW = NO 1486195972f6Sopenharmony_ci 1487195972f6Sopenharmony_ci# Use this tag to change the font size of LaTeX formulas included as images in 1488195972f6Sopenharmony_ci# the HTML documentation. When you change the font size after a successful 1489195972f6Sopenharmony_ci# doxygen run you need to manually remove any form_*.png images from the HTML 1490195972f6Sopenharmony_ci# output directory to force them to be regenerated. 1491195972f6Sopenharmony_ci# Minimum value: 8, maximum value: 50, default value: 10. 1492195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1493195972f6Sopenharmony_ci 1494195972f6Sopenharmony_ciFORMULA_FONTSIZE = 10 1495195972f6Sopenharmony_ci 1496195972f6Sopenharmony_ci# Use the FORMULA_TRANPARENT tag to determine whether or not the images 1497195972f6Sopenharmony_ci# generated for formulas are transparent PNGs. Transparent PNGs are not 1498195972f6Sopenharmony_ci# supported properly for IE 6.0, but are supported on all modern browsers. 1499195972f6Sopenharmony_ci# 1500195972f6Sopenharmony_ci# Note that when changing this option you need to delete any form_*.png files in 1501195972f6Sopenharmony_ci# the HTML output directory before the changes have effect. 1502195972f6Sopenharmony_ci# The default value is: YES. 1503195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1504195972f6Sopenharmony_ci 1505195972f6Sopenharmony_ciFORMULA_TRANSPARENT = YES 1506195972f6Sopenharmony_ci 1507195972f6Sopenharmony_ci# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1508195972f6Sopenharmony_ci# http://www.mathjax.org) which uses client side Javascript for the rendering 1509195972f6Sopenharmony_ci# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1510195972f6Sopenharmony_ci# installed or if you want to formulas look prettier in the HTML output. When 1511195972f6Sopenharmony_ci# enabled you may also need to install MathJax separately and configure the path 1512195972f6Sopenharmony_ci# to it using the MATHJAX_RELPATH option. 1513195972f6Sopenharmony_ci# The default value is: NO. 1514195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1515195972f6Sopenharmony_ci 1516195972f6Sopenharmony_ciUSE_MATHJAX = NO 1517195972f6Sopenharmony_ci 1518195972f6Sopenharmony_ci# When MathJax is enabled you can set the default output format to be used for 1519195972f6Sopenharmony_ci# the MathJax output. See the MathJax site (see: 1520195972f6Sopenharmony_ci# http://docs.mathjax.org/en/latest/output.html) for more details. 1521195972f6Sopenharmony_ci# Possible values are: HTML-CSS (which is slower, but has the best 1522195972f6Sopenharmony_ci# compatibility), NativeMML (i.e. MathML) and SVG. 1523195972f6Sopenharmony_ci# The default value is: HTML-CSS. 1524195972f6Sopenharmony_ci# This tag requires that the tag USE_MATHJAX is set to YES. 1525195972f6Sopenharmony_ci 1526195972f6Sopenharmony_ciMATHJAX_FORMAT = HTML-CSS 1527195972f6Sopenharmony_ci 1528195972f6Sopenharmony_ci# When MathJax is enabled you need to specify the location relative to the HTML 1529195972f6Sopenharmony_ci# output directory using the MATHJAX_RELPATH option. The destination directory 1530195972f6Sopenharmony_ci# should contain the MathJax.js script. For instance, if the mathjax directory 1531195972f6Sopenharmony_ci# is located at the same level as the HTML output directory, then 1532195972f6Sopenharmony_ci# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1533195972f6Sopenharmony_ci# Content Delivery Network so you can quickly see the result without installing 1534195972f6Sopenharmony_ci# MathJax. However, it is strongly recommended to install a local copy of 1535195972f6Sopenharmony_ci# MathJax from http://www.mathjax.org before deployment. 1536195972f6Sopenharmony_ci# The default value is: http://cdn.mathjax.org/mathjax/latest. 1537195972f6Sopenharmony_ci# This tag requires that the tag USE_MATHJAX is set to YES. 1538195972f6Sopenharmony_ci 1539195972f6Sopenharmony_ciMATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1540195972f6Sopenharmony_ci 1541195972f6Sopenharmony_ci# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1542195972f6Sopenharmony_ci# extension names that should be enabled during MathJax rendering. For example 1543195972f6Sopenharmony_ci# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1544195972f6Sopenharmony_ci# This tag requires that the tag USE_MATHJAX is set to YES. 1545195972f6Sopenharmony_ci 1546195972f6Sopenharmony_ciMATHJAX_EXTENSIONS = 1547195972f6Sopenharmony_ci 1548195972f6Sopenharmony_ci# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1549195972f6Sopenharmony_ci# of code that will be used on startup of the MathJax code. See the MathJax site 1550195972f6Sopenharmony_ci# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1551195972f6Sopenharmony_ci# example see the documentation. 1552195972f6Sopenharmony_ci# This tag requires that the tag USE_MATHJAX is set to YES. 1553195972f6Sopenharmony_ci 1554195972f6Sopenharmony_ciMATHJAX_CODEFILE = 1555195972f6Sopenharmony_ci 1556195972f6Sopenharmony_ci# When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1557195972f6Sopenharmony_ci# the HTML output. The underlying search engine uses javascript and DHTML and 1558195972f6Sopenharmony_ci# should work on any modern browser. Note that when using HTML help 1559195972f6Sopenharmony_ci# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1560195972f6Sopenharmony_ci# there is already a search function so this one should typically be disabled. 1561195972f6Sopenharmony_ci# For large projects the javascript based search engine can be slow, then 1562195972f6Sopenharmony_ci# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1563195972f6Sopenharmony_ci# search using the keyboard; to jump to the search box use <access key> + S 1564195972f6Sopenharmony_ci# (what the <access key> is depends on the OS and browser, but it is typically 1565195972f6Sopenharmony_ci# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down 1566195972f6Sopenharmony_ci# key> to jump into the search results window, the results can be navigated 1567195972f6Sopenharmony_ci# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel 1568195972f6Sopenharmony_ci# the search. The filter options can be selected when the cursor is inside the 1569195972f6Sopenharmony_ci# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> 1570195972f6Sopenharmony_ci# to select a filter and <Enter> or <escape> to activate or cancel the filter 1571195972f6Sopenharmony_ci# option. 1572195972f6Sopenharmony_ci# The default value is: YES. 1573195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_HTML is set to YES. 1574195972f6Sopenharmony_ci 1575195972f6Sopenharmony_ciSEARCHENGINE = YES 1576195972f6Sopenharmony_ci 1577195972f6Sopenharmony_ci# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1578195972f6Sopenharmony_ci# implemented using a web server instead of a web client using Javascript. There 1579195972f6Sopenharmony_ci# are two flavors of web server based searching depending on the EXTERNAL_SEARCH 1580195972f6Sopenharmony_ci# setting. When disabled, doxygen will generate a PHP script for searching and 1581195972f6Sopenharmony_ci# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing 1582195972f6Sopenharmony_ci# and searching needs to be provided by external tools. See the section 1583195972f6Sopenharmony_ci# "External Indexing and Searching" for details. 1584195972f6Sopenharmony_ci# The default value is: NO. 1585195972f6Sopenharmony_ci# This tag requires that the tag SEARCHENGINE is set to YES. 1586195972f6Sopenharmony_ci 1587195972f6Sopenharmony_ciSERVER_BASED_SEARCH = NO 1588195972f6Sopenharmony_ci 1589195972f6Sopenharmony_ci# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP 1590195972f6Sopenharmony_ci# script for searching. Instead the search results are written to an XML file 1591195972f6Sopenharmony_ci# which needs to be processed by an external indexer. Doxygen will invoke an 1592195972f6Sopenharmony_ci# external search engine pointed to by the SEARCHENGINE_URL option to obtain the 1593195972f6Sopenharmony_ci# search results. 1594195972f6Sopenharmony_ci# 1595195972f6Sopenharmony_ci# Doxygen ships with an example indexer (doxyindexer) and search engine 1596195972f6Sopenharmony_ci# (doxysearch.cgi) which are based on the open source search engine library 1597195972f6Sopenharmony_ci# Xapian (see: http://xapian.org/). 1598195972f6Sopenharmony_ci# 1599195972f6Sopenharmony_ci# See the section "External Indexing and Searching" for details. 1600195972f6Sopenharmony_ci# The default value is: NO. 1601195972f6Sopenharmony_ci# This tag requires that the tag SEARCHENGINE is set to YES. 1602195972f6Sopenharmony_ci 1603195972f6Sopenharmony_ciEXTERNAL_SEARCH = NO 1604195972f6Sopenharmony_ci 1605195972f6Sopenharmony_ci# The SEARCHENGINE_URL should point to a search engine hosted by a web server 1606195972f6Sopenharmony_ci# which will return the search results when EXTERNAL_SEARCH is enabled. 1607195972f6Sopenharmony_ci# 1608195972f6Sopenharmony_ci# Doxygen ships with an example indexer (doxyindexer) and search engine 1609195972f6Sopenharmony_ci# (doxysearch.cgi) which are based on the open source search engine library 1610195972f6Sopenharmony_ci# Xapian (see: http://xapian.org/). See the section "External Indexing and 1611195972f6Sopenharmony_ci# Searching" for details. 1612195972f6Sopenharmony_ci# This tag requires that the tag SEARCHENGINE is set to YES. 1613195972f6Sopenharmony_ci 1614195972f6Sopenharmony_ciSEARCHENGINE_URL = 1615195972f6Sopenharmony_ci 1616195972f6Sopenharmony_ci# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed 1617195972f6Sopenharmony_ci# search data is written to a file for indexing by an external tool. With the 1618195972f6Sopenharmony_ci# SEARCHDATA_FILE tag the name of this file can be specified. 1619195972f6Sopenharmony_ci# The default file is: searchdata.xml. 1620195972f6Sopenharmony_ci# This tag requires that the tag SEARCHENGINE is set to YES. 1621195972f6Sopenharmony_ci 1622195972f6Sopenharmony_ciSEARCHDATA_FILE = searchdata.xml 1623195972f6Sopenharmony_ci 1624195972f6Sopenharmony_ci# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the 1625195972f6Sopenharmony_ci# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is 1626195972f6Sopenharmony_ci# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple 1627195972f6Sopenharmony_ci# projects and redirect the results back to the right project. 1628195972f6Sopenharmony_ci# This tag requires that the tag SEARCHENGINE is set to YES. 1629195972f6Sopenharmony_ci 1630195972f6Sopenharmony_ciEXTERNAL_SEARCH_ID = 1631195972f6Sopenharmony_ci 1632195972f6Sopenharmony_ci# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen 1633195972f6Sopenharmony_ci# projects other than the one defined by this configuration file, but that are 1634195972f6Sopenharmony_ci# all added to the same external search index. Each project needs to have a 1635195972f6Sopenharmony_ci# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of 1636195972f6Sopenharmony_ci# to a relative location where the documentation can be found. The format is: 1637195972f6Sopenharmony_ci# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... 1638195972f6Sopenharmony_ci# This tag requires that the tag SEARCHENGINE is set to YES. 1639195972f6Sopenharmony_ci 1640195972f6Sopenharmony_ciEXTRA_SEARCH_MAPPINGS = 1641195972f6Sopenharmony_ci 1642195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 1643195972f6Sopenharmony_ci# Configuration options related to the LaTeX output 1644195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 1645195972f6Sopenharmony_ci 1646195972f6Sopenharmony_ci# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. 1647195972f6Sopenharmony_ci# The default value is: YES. 1648195972f6Sopenharmony_ci 1649195972f6Sopenharmony_ciGENERATE_LATEX = NO 1650195972f6Sopenharmony_ci 1651195972f6Sopenharmony_ci# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a 1652195972f6Sopenharmony_ci# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1653195972f6Sopenharmony_ci# it. 1654195972f6Sopenharmony_ci# The default directory is: latex. 1655195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1656195972f6Sopenharmony_ci 1657195972f6Sopenharmony_ciLATEX_OUTPUT = latex 1658195972f6Sopenharmony_ci 1659195972f6Sopenharmony_ci# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1660195972f6Sopenharmony_ci# invoked. 1661195972f6Sopenharmony_ci# 1662195972f6Sopenharmony_ci# Note that when enabling USE_PDFLATEX this option is only used for generating 1663195972f6Sopenharmony_ci# bitmaps for formulas in the HTML output, but not in the Makefile that is 1664195972f6Sopenharmony_ci# written to the output directory. 1665195972f6Sopenharmony_ci# The default file is: latex. 1666195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1667195972f6Sopenharmony_ci 1668195972f6Sopenharmony_ciLATEX_CMD_NAME = latex 1669195972f6Sopenharmony_ci 1670195972f6Sopenharmony_ci# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate 1671195972f6Sopenharmony_ci# index for LaTeX. 1672195972f6Sopenharmony_ci# The default file is: makeindex. 1673195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1674195972f6Sopenharmony_ci 1675195972f6Sopenharmony_ciMAKEINDEX_CMD_NAME = makeindex 1676195972f6Sopenharmony_ci 1677195972f6Sopenharmony_ci# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX 1678195972f6Sopenharmony_ci# documents. This may be useful for small projects and may help to save some 1679195972f6Sopenharmony_ci# trees in general. 1680195972f6Sopenharmony_ci# The default value is: NO. 1681195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1682195972f6Sopenharmony_ci 1683195972f6Sopenharmony_ciCOMPACT_LATEX = NO 1684195972f6Sopenharmony_ci 1685195972f6Sopenharmony_ci# The PAPER_TYPE tag can be used to set the paper type that is used by the 1686195972f6Sopenharmony_ci# printer. 1687195972f6Sopenharmony_ci# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x 1688195972f6Sopenharmony_ci# 14 inches) and executive (7.25 x 10.5 inches). 1689195972f6Sopenharmony_ci# The default value is: a4. 1690195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1691195972f6Sopenharmony_ci 1692195972f6Sopenharmony_ciPAPER_TYPE = a4wide 1693195972f6Sopenharmony_ci 1694195972f6Sopenharmony_ci# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names 1695195972f6Sopenharmony_ci# that should be included in the LaTeX output. The package can be specified just 1696195972f6Sopenharmony_ci# by its name or with the correct syntax as to be used with the LaTeX 1697195972f6Sopenharmony_ci# \usepackage command. To get the times font for instance you can specify : 1698195972f6Sopenharmony_ci# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} 1699195972f6Sopenharmony_ci# To use the option intlimits with the amsmath package you can specify: 1700195972f6Sopenharmony_ci# EXTRA_PACKAGES=[intlimits]{amsmath} 1701195972f6Sopenharmony_ci# If left blank no extra packages will be included. 1702195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1703195972f6Sopenharmony_ci 1704195972f6Sopenharmony_ciEXTRA_PACKAGES = 1705195972f6Sopenharmony_ci 1706195972f6Sopenharmony_ci# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the 1707195972f6Sopenharmony_ci# generated LaTeX document. The header should contain everything until the first 1708195972f6Sopenharmony_ci# chapter. If it is left blank doxygen will generate a standard header. See 1709195972f6Sopenharmony_ci# section "Doxygen usage" for information on how to let doxygen write the 1710195972f6Sopenharmony_ci# default header to a separate file. 1711195972f6Sopenharmony_ci# 1712195972f6Sopenharmony_ci# Note: Only use a user-defined header if you know what you are doing! The 1713195972f6Sopenharmony_ci# following commands have a special meaning inside the header: $title, 1714195972f6Sopenharmony_ci# $datetime, $date, $doxygenversion, $projectname, $projectnumber, 1715195972f6Sopenharmony_ci# $projectbrief, $projectlogo. Doxygen will replace $title with the empty 1716195972f6Sopenharmony_ci# string, for the replacement values of the other commands the user is referred 1717195972f6Sopenharmony_ci# to HTML_HEADER. 1718195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1719195972f6Sopenharmony_ci 1720195972f6Sopenharmony_ciLATEX_HEADER = 1721195972f6Sopenharmony_ci 1722195972f6Sopenharmony_ci# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the 1723195972f6Sopenharmony_ci# generated LaTeX document. The footer should contain everything after the last 1724195972f6Sopenharmony_ci# chapter. If it is left blank doxygen will generate a standard footer. See 1725195972f6Sopenharmony_ci# LATEX_HEADER for more information on how to generate a default footer and what 1726195972f6Sopenharmony_ci# special commands can be used inside the footer. 1727195972f6Sopenharmony_ci# 1728195972f6Sopenharmony_ci# Note: Only use a user-defined footer if you know what you are doing! 1729195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1730195972f6Sopenharmony_ci 1731195972f6Sopenharmony_ciLATEX_FOOTER = 1732195972f6Sopenharmony_ci 1733195972f6Sopenharmony_ci# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1734195972f6Sopenharmony_ci# LaTeX style sheets that are included after the standard style sheets created 1735195972f6Sopenharmony_ci# by doxygen. Using this option one can overrule certain style aspects. Doxygen 1736195972f6Sopenharmony_ci# will copy the style sheet files to the output directory. 1737195972f6Sopenharmony_ci# Note: The order of the extra style sheet files is of importance (e.g. the last 1738195972f6Sopenharmony_ci# style sheet in the list overrules the setting of the previous ones in the 1739195972f6Sopenharmony_ci# list). 1740195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1741195972f6Sopenharmony_ci 1742195972f6Sopenharmony_ciLATEX_EXTRA_STYLESHEET = 1743195972f6Sopenharmony_ci 1744195972f6Sopenharmony_ci# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or 1745195972f6Sopenharmony_ci# other source files which should be copied to the LATEX_OUTPUT output 1746195972f6Sopenharmony_ci# directory. Note that the files will be copied as-is; there are no commands or 1747195972f6Sopenharmony_ci# markers available. 1748195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1749195972f6Sopenharmony_ci 1750195972f6Sopenharmony_ciLATEX_EXTRA_FILES = 1751195972f6Sopenharmony_ci 1752195972f6Sopenharmony_ci# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is 1753195972f6Sopenharmony_ci# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will 1754195972f6Sopenharmony_ci# contain links (just like the HTML output) instead of page references. This 1755195972f6Sopenharmony_ci# makes the output suitable for online browsing using a PDF viewer. 1756195972f6Sopenharmony_ci# The default value is: YES. 1757195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1758195972f6Sopenharmony_ci 1759195972f6Sopenharmony_ciPDF_HYPERLINKS = NO 1760195972f6Sopenharmony_ci 1761195972f6Sopenharmony_ci# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate 1762195972f6Sopenharmony_ci# the PDF file directly from the LaTeX files. Set this option to YES, to get a 1763195972f6Sopenharmony_ci# higher quality PDF documentation. 1764195972f6Sopenharmony_ci# The default value is: YES. 1765195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1766195972f6Sopenharmony_ci 1767195972f6Sopenharmony_ciUSE_PDFLATEX = NO 1768195972f6Sopenharmony_ci 1769195972f6Sopenharmony_ci# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode 1770195972f6Sopenharmony_ci# command to the generated LaTeX files. This will instruct LaTeX to keep running 1771195972f6Sopenharmony_ci# if errors occur, instead of asking the user for help. This option is also used 1772195972f6Sopenharmony_ci# when generating formulas in HTML. 1773195972f6Sopenharmony_ci# The default value is: NO. 1774195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1775195972f6Sopenharmony_ci 1776195972f6Sopenharmony_ciLATEX_BATCHMODE = NO 1777195972f6Sopenharmony_ci 1778195972f6Sopenharmony_ci# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the 1779195972f6Sopenharmony_ci# index chapters (such as File Index, Compound Index, etc.) in the output. 1780195972f6Sopenharmony_ci# The default value is: NO. 1781195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1782195972f6Sopenharmony_ci 1783195972f6Sopenharmony_ciLATEX_HIDE_INDICES = NO 1784195972f6Sopenharmony_ci 1785195972f6Sopenharmony_ci# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source 1786195972f6Sopenharmony_ci# code with syntax highlighting in the LaTeX output. 1787195972f6Sopenharmony_ci# 1788195972f6Sopenharmony_ci# Note that which sources are shown also depends on other settings such as 1789195972f6Sopenharmony_ci# SOURCE_BROWSER. 1790195972f6Sopenharmony_ci# The default value is: NO. 1791195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1792195972f6Sopenharmony_ci 1793195972f6Sopenharmony_ciLATEX_SOURCE_CODE = NO 1794195972f6Sopenharmony_ci 1795195972f6Sopenharmony_ci# The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1796195972f6Sopenharmony_ci# bibliography, e.g. plainnat, or ieeetr. See 1797195972f6Sopenharmony_ci# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. 1798195972f6Sopenharmony_ci# The default value is: plain. 1799195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1800195972f6Sopenharmony_ci 1801195972f6Sopenharmony_ciLATEX_BIB_STYLE = plain 1802195972f6Sopenharmony_ci 1803195972f6Sopenharmony_ci# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated 1804195972f6Sopenharmony_ci# page will contain the date and time when the page was generated. Setting this 1805195972f6Sopenharmony_ci# to NO can help when comparing the output of multiple runs. 1806195972f6Sopenharmony_ci# The default value is: NO. 1807195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_LATEX is set to YES. 1808195972f6Sopenharmony_ci 1809195972f6Sopenharmony_ciLATEX_TIMESTAMP = NO 1810195972f6Sopenharmony_ci 1811195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 1812195972f6Sopenharmony_ci# Configuration options related to the RTF output 1813195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 1814195972f6Sopenharmony_ci 1815195972f6Sopenharmony_ci# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The 1816195972f6Sopenharmony_ci# RTF output is optimized for Word 97 and may not look too pretty with other RTF 1817195972f6Sopenharmony_ci# readers/editors. 1818195972f6Sopenharmony_ci# The default value is: NO. 1819195972f6Sopenharmony_ci 1820195972f6Sopenharmony_ciGENERATE_RTF = NO 1821195972f6Sopenharmony_ci 1822195972f6Sopenharmony_ci# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a 1823195972f6Sopenharmony_ci# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1824195972f6Sopenharmony_ci# it. 1825195972f6Sopenharmony_ci# The default directory is: rtf. 1826195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_RTF is set to YES. 1827195972f6Sopenharmony_ci 1828195972f6Sopenharmony_ciRTF_OUTPUT = rtf 1829195972f6Sopenharmony_ci 1830195972f6Sopenharmony_ci# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF 1831195972f6Sopenharmony_ci# documents. This may be useful for small projects and may help to save some 1832195972f6Sopenharmony_ci# trees in general. 1833195972f6Sopenharmony_ci# The default value is: NO. 1834195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_RTF is set to YES. 1835195972f6Sopenharmony_ci 1836195972f6Sopenharmony_ciCOMPACT_RTF = NO 1837195972f6Sopenharmony_ci 1838195972f6Sopenharmony_ci# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will 1839195972f6Sopenharmony_ci# contain hyperlink fields. The RTF file will contain links (just like the HTML 1840195972f6Sopenharmony_ci# output) instead of page references. This makes the output suitable for online 1841195972f6Sopenharmony_ci# browsing using Word or some other Word compatible readers that support those 1842195972f6Sopenharmony_ci# fields. 1843195972f6Sopenharmony_ci# 1844195972f6Sopenharmony_ci# Note: WordPad (write) and others do not support links. 1845195972f6Sopenharmony_ci# The default value is: NO. 1846195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_RTF is set to YES. 1847195972f6Sopenharmony_ci 1848195972f6Sopenharmony_ciRTF_HYPERLINKS = NO 1849195972f6Sopenharmony_ci 1850195972f6Sopenharmony_ci# Load stylesheet definitions from file. Syntax is similar to doxygen's config 1851195972f6Sopenharmony_ci# file, i.e. a series of assignments. You only have to provide replacements, 1852195972f6Sopenharmony_ci# missing definitions are set to their default value. 1853195972f6Sopenharmony_ci# 1854195972f6Sopenharmony_ci# See also section "Doxygen usage" for information on how to generate the 1855195972f6Sopenharmony_ci# default style sheet that doxygen normally uses. 1856195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_RTF is set to YES. 1857195972f6Sopenharmony_ci 1858195972f6Sopenharmony_ciRTF_STYLESHEET_FILE = 1859195972f6Sopenharmony_ci 1860195972f6Sopenharmony_ci# Set optional variables used in the generation of an RTF document. Syntax is 1861195972f6Sopenharmony_ci# similar to doxygen's config file. A template extensions file can be generated 1862195972f6Sopenharmony_ci# using doxygen -e rtf extensionFile. 1863195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_RTF is set to YES. 1864195972f6Sopenharmony_ci 1865195972f6Sopenharmony_ciRTF_EXTENSIONS_FILE = 1866195972f6Sopenharmony_ci 1867195972f6Sopenharmony_ci# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code 1868195972f6Sopenharmony_ci# with syntax highlighting in the RTF output. 1869195972f6Sopenharmony_ci# 1870195972f6Sopenharmony_ci# Note that which sources are shown also depends on other settings such as 1871195972f6Sopenharmony_ci# SOURCE_BROWSER. 1872195972f6Sopenharmony_ci# The default value is: NO. 1873195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_RTF is set to YES. 1874195972f6Sopenharmony_ci 1875195972f6Sopenharmony_ciRTF_SOURCE_CODE = NO 1876195972f6Sopenharmony_ci 1877195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 1878195972f6Sopenharmony_ci# Configuration options related to the man page output 1879195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 1880195972f6Sopenharmony_ci 1881195972f6Sopenharmony_ci# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for 1882195972f6Sopenharmony_ci# classes and files. 1883195972f6Sopenharmony_ci# The default value is: NO. 1884195972f6Sopenharmony_ci 1885195972f6Sopenharmony_ciGENERATE_MAN = NO 1886195972f6Sopenharmony_ci 1887195972f6Sopenharmony_ci# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a 1888195972f6Sopenharmony_ci# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1889195972f6Sopenharmony_ci# it. A directory man3 will be created inside the directory specified by 1890195972f6Sopenharmony_ci# MAN_OUTPUT. 1891195972f6Sopenharmony_ci# The default directory is: man. 1892195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_MAN is set to YES. 1893195972f6Sopenharmony_ci 1894195972f6Sopenharmony_ciMAN_OUTPUT = man 1895195972f6Sopenharmony_ci 1896195972f6Sopenharmony_ci# The MAN_EXTENSION tag determines the extension that is added to the generated 1897195972f6Sopenharmony_ci# man pages. In case the manual section does not start with a number, the number 1898195972f6Sopenharmony_ci# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is 1899195972f6Sopenharmony_ci# optional. 1900195972f6Sopenharmony_ci# The default value is: .3. 1901195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_MAN is set to YES. 1902195972f6Sopenharmony_ci 1903195972f6Sopenharmony_ciMAN_EXTENSION = .3 1904195972f6Sopenharmony_ci 1905195972f6Sopenharmony_ci# The MAN_SUBDIR tag determines the name of the directory created within 1906195972f6Sopenharmony_ci# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by 1907195972f6Sopenharmony_ci# MAN_EXTENSION with the initial . removed. 1908195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_MAN is set to YES. 1909195972f6Sopenharmony_ci 1910195972f6Sopenharmony_ciMAN_SUBDIR = 1911195972f6Sopenharmony_ci 1912195972f6Sopenharmony_ci# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it 1913195972f6Sopenharmony_ci# will generate one additional man file for each entity documented in the real 1914195972f6Sopenharmony_ci# man page(s). These additional files only source the real man page, but without 1915195972f6Sopenharmony_ci# them the man command would be unable to find the correct page. 1916195972f6Sopenharmony_ci# The default value is: NO. 1917195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_MAN is set to YES. 1918195972f6Sopenharmony_ci 1919195972f6Sopenharmony_ciMAN_LINKS = NO 1920195972f6Sopenharmony_ci 1921195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 1922195972f6Sopenharmony_ci# Configuration options related to the XML output 1923195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 1924195972f6Sopenharmony_ci 1925195972f6Sopenharmony_ci# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that 1926195972f6Sopenharmony_ci# captures the structure of the code including all documentation. 1927195972f6Sopenharmony_ci# The default value is: NO. 1928195972f6Sopenharmony_ci 1929195972f6Sopenharmony_ciGENERATE_XML = NO 1930195972f6Sopenharmony_ci 1931195972f6Sopenharmony_ci# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a 1932195972f6Sopenharmony_ci# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1933195972f6Sopenharmony_ci# it. 1934195972f6Sopenharmony_ci# The default directory is: xml. 1935195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_XML is set to YES. 1936195972f6Sopenharmony_ci 1937195972f6Sopenharmony_ciXML_OUTPUT = xml 1938195972f6Sopenharmony_ci 1939195972f6Sopenharmony_ci# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program 1940195972f6Sopenharmony_ci# listings (including syntax highlighting and cross-referencing information) to 1941195972f6Sopenharmony_ci# the XML output. Note that enabling this will significantly increase the size 1942195972f6Sopenharmony_ci# of the XML output. 1943195972f6Sopenharmony_ci# The default value is: YES. 1944195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_XML is set to YES. 1945195972f6Sopenharmony_ci 1946195972f6Sopenharmony_ciXML_PROGRAMLISTING = YES 1947195972f6Sopenharmony_ci 1948195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 1949195972f6Sopenharmony_ci# Configuration options related to the DOCBOOK output 1950195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 1951195972f6Sopenharmony_ci 1952195972f6Sopenharmony_ci# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files 1953195972f6Sopenharmony_ci# that can be used to generate PDF. 1954195972f6Sopenharmony_ci# The default value is: NO. 1955195972f6Sopenharmony_ci 1956195972f6Sopenharmony_ciGENERATE_DOCBOOK = NO 1957195972f6Sopenharmony_ci 1958195972f6Sopenharmony_ci# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. 1959195972f6Sopenharmony_ci# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in 1960195972f6Sopenharmony_ci# front of it. 1961195972f6Sopenharmony_ci# The default directory is: docbook. 1962195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_DOCBOOK is set to YES. 1963195972f6Sopenharmony_ci 1964195972f6Sopenharmony_ciDOCBOOK_OUTPUT = docbook 1965195972f6Sopenharmony_ci 1966195972f6Sopenharmony_ci# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the 1967195972f6Sopenharmony_ci# program listings (including syntax highlighting and cross-referencing 1968195972f6Sopenharmony_ci# information) to the DOCBOOK output. Note that enabling this will significantly 1969195972f6Sopenharmony_ci# increase the size of the DOCBOOK output. 1970195972f6Sopenharmony_ci# The default value is: NO. 1971195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_DOCBOOK is set to YES. 1972195972f6Sopenharmony_ci 1973195972f6Sopenharmony_ciDOCBOOK_PROGRAMLISTING = NO 1974195972f6Sopenharmony_ci 1975195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 1976195972f6Sopenharmony_ci# Configuration options for the AutoGen Definitions output 1977195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 1978195972f6Sopenharmony_ci 1979195972f6Sopenharmony_ci# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an 1980195972f6Sopenharmony_ci# AutoGen Definitions (see http://autogen.sf.net) file that captures the 1981195972f6Sopenharmony_ci# structure of the code including all documentation. Note that this feature is 1982195972f6Sopenharmony_ci# still experimental and incomplete at the moment. 1983195972f6Sopenharmony_ci# The default value is: NO. 1984195972f6Sopenharmony_ci 1985195972f6Sopenharmony_ciGENERATE_AUTOGEN_DEF = NO 1986195972f6Sopenharmony_ci 1987195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 1988195972f6Sopenharmony_ci# Configuration options related to the Perl module output 1989195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 1990195972f6Sopenharmony_ci 1991195972f6Sopenharmony_ci# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module 1992195972f6Sopenharmony_ci# file that captures the structure of the code including all documentation. 1993195972f6Sopenharmony_ci# 1994195972f6Sopenharmony_ci# Note that this feature is still experimental and incomplete at the moment. 1995195972f6Sopenharmony_ci# The default value is: NO. 1996195972f6Sopenharmony_ci 1997195972f6Sopenharmony_ciGENERATE_PERLMOD = NO 1998195972f6Sopenharmony_ci 1999195972f6Sopenharmony_ci# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary 2000195972f6Sopenharmony_ci# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI 2001195972f6Sopenharmony_ci# output from the Perl module output. 2002195972f6Sopenharmony_ci# The default value is: NO. 2003195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_PERLMOD is set to YES. 2004195972f6Sopenharmony_ci 2005195972f6Sopenharmony_ciPERLMOD_LATEX = NO 2006195972f6Sopenharmony_ci 2007195972f6Sopenharmony_ci# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely 2008195972f6Sopenharmony_ci# formatted so it can be parsed by a human reader. This is useful if you want to 2009195972f6Sopenharmony_ci# understand what is going on. On the other hand, if this tag is set to NO, the 2010195972f6Sopenharmony_ci# size of the Perl module output will be much smaller and Perl will parse it 2011195972f6Sopenharmony_ci# just the same. 2012195972f6Sopenharmony_ci# The default value is: YES. 2013195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_PERLMOD is set to YES. 2014195972f6Sopenharmony_ci 2015195972f6Sopenharmony_ciPERLMOD_PRETTY = YES 2016195972f6Sopenharmony_ci 2017195972f6Sopenharmony_ci# The names of the make variables in the generated doxyrules.make file are 2018195972f6Sopenharmony_ci# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful 2019195972f6Sopenharmony_ci# so different doxyrules.make files included by the same Makefile don't 2020195972f6Sopenharmony_ci# overwrite each other's variables. 2021195972f6Sopenharmony_ci# This tag requires that the tag GENERATE_PERLMOD is set to YES. 2022195972f6Sopenharmony_ci 2023195972f6Sopenharmony_ciPERLMOD_MAKEVAR_PREFIX = 2024195972f6Sopenharmony_ci 2025195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 2026195972f6Sopenharmony_ci# Configuration options related to the preprocessor 2027195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 2028195972f6Sopenharmony_ci 2029195972f6Sopenharmony_ci# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all 2030195972f6Sopenharmony_ci# C-preprocessor directives found in the sources and include files. 2031195972f6Sopenharmony_ci# The default value is: YES. 2032195972f6Sopenharmony_ci 2033195972f6Sopenharmony_ciENABLE_PREPROCESSING = YES 2034195972f6Sopenharmony_ci 2035195972f6Sopenharmony_ci# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names 2036195972f6Sopenharmony_ci# in the source code. If set to NO, only conditional compilation will be 2037195972f6Sopenharmony_ci# performed. Macro expansion can be done in a controlled way by setting 2038195972f6Sopenharmony_ci# EXPAND_ONLY_PREDEF to YES. 2039195972f6Sopenharmony_ci# The default value is: NO. 2040195972f6Sopenharmony_ci# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2041195972f6Sopenharmony_ci 2042195972f6Sopenharmony_ciMACRO_EXPANSION = YES 2043195972f6Sopenharmony_ci 2044195972f6Sopenharmony_ci# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then 2045195972f6Sopenharmony_ci# the macro expansion is limited to the macros specified with the PREDEFINED and 2046195972f6Sopenharmony_ci# EXPAND_AS_DEFINED tags. 2047195972f6Sopenharmony_ci# The default value is: NO. 2048195972f6Sopenharmony_ci# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2049195972f6Sopenharmony_ci 2050195972f6Sopenharmony_ciEXPAND_ONLY_PREDEF = NO 2051195972f6Sopenharmony_ci 2052195972f6Sopenharmony_ci# If the SEARCH_INCLUDES tag is set to YES, the include files in the 2053195972f6Sopenharmony_ci# INCLUDE_PATH will be searched if a #include is found. 2054195972f6Sopenharmony_ci# The default value is: YES. 2055195972f6Sopenharmony_ci# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2056195972f6Sopenharmony_ci 2057195972f6Sopenharmony_ciSEARCH_INCLUDES = YES 2058195972f6Sopenharmony_ci 2059195972f6Sopenharmony_ci# The INCLUDE_PATH tag can be used to specify one or more directories that 2060195972f6Sopenharmony_ci# contain include files that are not input files but should be processed by the 2061195972f6Sopenharmony_ci# preprocessor. 2062195972f6Sopenharmony_ci# This tag requires that the tag SEARCH_INCLUDES is set to YES. 2063195972f6Sopenharmony_ci 2064195972f6Sopenharmony_ciINCLUDE_PATH = ../../src/include 2065195972f6Sopenharmony_ci 2066195972f6Sopenharmony_ci# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 2067195972f6Sopenharmony_ci# patterns (like *.h and *.hpp) to filter out the header-files in the 2068195972f6Sopenharmony_ci# directories. If left blank, the patterns specified with FILE_PATTERNS will be 2069195972f6Sopenharmony_ci# used. 2070195972f6Sopenharmony_ci# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2071195972f6Sopenharmony_ci 2072195972f6Sopenharmony_ciINCLUDE_FILE_PATTERNS = *.h 2073195972f6Sopenharmony_ci 2074195972f6Sopenharmony_ci# The PREDEFINED tag can be used to specify one or more macro names that are 2075195972f6Sopenharmony_ci# defined before the preprocessor is started (similar to the -D option of e.g. 2076195972f6Sopenharmony_ci# gcc). The argument of the tag is a list of macros of the form: name or 2077195972f6Sopenharmony_ci# name=definition (no spaces). If the definition and the "=" are omitted, "=1" 2078195972f6Sopenharmony_ci# is assumed. To prevent a macro definition from being undefined via #undef or 2079195972f6Sopenharmony_ci# recursively expanded use the := operator instead of the = operator. 2080195972f6Sopenharmony_ci# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2081195972f6Sopenharmony_ci 2082195972f6Sopenharmony_ciPREDEFINED = __DOXYGEN__=1 \ 2083195972f6Sopenharmony_ci NO_SYS=0 \ 2084195972f6Sopenharmony_ci SYS_LIGHTWEIGHT_PROT=1 \ 2085195972f6Sopenharmony_ci LWIP_TCPIP_CORE_LOCKING=1 \ 2086195972f6Sopenharmony_ci LWIP_IPV4=1 \ 2087195972f6Sopenharmony_ci LWIP_IPV6=1 \ 2088195972f6Sopenharmony_ci LWIP_ICMP=1 \ 2089195972f6Sopenharmony_ci LWIP_RAW=1 \ 2090195972f6Sopenharmony_ci LWIP_DHCP=1 \ 2091195972f6Sopenharmony_ci LWIP_IPV6_DHCP6=1 \ 2092195972f6Sopenharmony_ci LWIP_UDPLITE=1 \ 2093195972f6Sopenharmony_ci LWIP_UDP=1 \ 2094195972f6Sopenharmony_ci LWIP_IGMP=1 \ 2095195972f6Sopenharmony_ci LWIP_TCP=1 \ 2096195972f6Sopenharmony_ci LWIP_ALTCP=1 \ 2097195972f6Sopenharmony_ci LWIP_ALTCP_TLS=1 \ 2098195972f6Sopenharmony_ci LWIP_IPV6_SCOPES=1 \ 2099195972f6Sopenharmony_ci TCP_LISTEN_BACKLOG=1 \ 2100195972f6Sopenharmony_ci LWIP_SNMP=1 \ 2101195972f6Sopenharmony_ci SNMP_USE_NETCONN=1 \ 2102195972f6Sopenharmony_ci SNMP_USE_RAW=1 \ 2103195972f6Sopenharmony_ci MIB2_STATS=1 \ 2104195972f6Sopenharmony_ci LWIP_MDNS_RESPONDER=1 \ 2105195972f6Sopenharmony_ci HTTPD_ENABLE_HTTPS=1 \ 2106195972f6Sopenharmony_ci LWIP_HTTPD_CGI=1 \ 2107195972f6Sopenharmony_ci LWIP_HTTPD_SSI=1 \ 2108195972f6Sopenharmony_ci LWIP_HTTPD_SSI_RAW=1 \ 2109195972f6Sopenharmony_ci LWIP_HTTPD_SUPPORT_POST=1 \ 2110195972f6Sopenharmony_ci LWIP_HTTPD_POST_MANUAL_WND=1 \ 2111195972f6Sopenharmony_ci MEMP_OVERFLOW_CHECK=0 \ 2112195972f6Sopenharmony_ci MEMP_SANITY_CHECK=1 \ 2113195972f6Sopenharmony_ci LWIP_ARP=1 \ 2114195972f6Sopenharmony_ci LWIP_HAVE_LOOPIF=1 \ 2115195972f6Sopenharmony_ci LWIP_NETIF_HOSTNAME=1 \ 2116195972f6Sopenharmony_ci LWIP_NETIF_API=1 \ 2117195972f6Sopenharmony_ci LWIP_NETIF_CALLBACK=1 \ 2118195972f6Sopenharmony_ci LWIP_NETIF_STATUS_CALLBACK=1 \ 2119195972f6Sopenharmony_ci LWIP_NETIF_REMOVE_CALLBACK=1 \ 2120195972f6Sopenharmony_ci LWIP_NETIF_LINK_CALLBACK=1 \ 2121195972f6Sopenharmony_ci LWIP_NETIF_EXT_STATUS_CALLBACK=1 \ 2122195972f6Sopenharmony_ci LWIP_NUM_NETIF_CLIENT_DATA=1 \ 2123195972f6Sopenharmony_ci ENABLE_LOOPBACK=1 \ 2124195972f6Sopenharmony_ci LWIP_AUTOIP=1 \ 2125195972f6Sopenharmony_ci ARP_QUEUEING=1 \ 2126195972f6Sopenharmony_ci LWIP_STATS=1 \ 2127195972f6Sopenharmony_ci MEM_USE_POOLS=0 \ 2128195972f6Sopenharmony_ci LWIP_DNS=1 \ 2129195972f6Sopenharmony_ci LWIP_SOCKET=1 \ 2130195972f6Sopenharmony_ci LWIP_NETCONN=1 \ 2131195972f6Sopenharmony_ci IP_SOF_BROADCAST=1 \ 2132195972f6Sopenharmony_ci IP_SOF_BROADCAST_RECV=1 \ 2133195972f6Sopenharmony_ci LWIP_NETIF_API=1 \ 2134195972f6Sopenharmony_ci LWIP_SO_SNDTIMEO=1 \ 2135195972f6Sopenharmony_ci LWIP_SO_RCVBUF=1 \ 2136195972f6Sopenharmony_ci LWIP_SO_LINGER=1 \ 2137195972f6Sopenharmony_ci SO_REUSE=1 \ 2138195972f6Sopenharmony_ci SO_REUSE_RXTOALL=1 \ 2139195972f6Sopenharmony_ci LWIP_HAVE_SLIPIF=1 \ 2140195972f6Sopenharmony_ci SLIP_RX_FROM_ISR=1 \ 2141195972f6Sopenharmony_ci LWIP_TCP_PCB_NUM_EXT_ARGS=1 2142195972f6Sopenharmony_ci 2143195972f6Sopenharmony_ci# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this 2144195972f6Sopenharmony_ci# tag can be used to specify a list of macro names that should be expanded. The 2145195972f6Sopenharmony_ci# macro definition that is found in the sources will be used. Use the PREDEFINED 2146195972f6Sopenharmony_ci# tag if you want to use a different macro definition that overrules the 2147195972f6Sopenharmony_ci# definition found in the source code. 2148195972f6Sopenharmony_ci# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2149195972f6Sopenharmony_ci 2150195972f6Sopenharmony_ciEXPAND_AS_DEFINED = 2151195972f6Sopenharmony_ci 2152195972f6Sopenharmony_ci# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will 2153195972f6Sopenharmony_ci# remove all references to function-like macros that are alone on a line, have 2154195972f6Sopenharmony_ci# an all uppercase name, and do not end with a semicolon. Such function macros 2155195972f6Sopenharmony_ci# are typically used for boiler-plate code, and will confuse the parser if not 2156195972f6Sopenharmony_ci# removed. 2157195972f6Sopenharmony_ci# The default value is: YES. 2158195972f6Sopenharmony_ci# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2159195972f6Sopenharmony_ci 2160195972f6Sopenharmony_ciSKIP_FUNCTION_MACROS = NO 2161195972f6Sopenharmony_ci 2162195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 2163195972f6Sopenharmony_ci# Configuration options related to external references 2164195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 2165195972f6Sopenharmony_ci 2166195972f6Sopenharmony_ci# The TAGFILES tag can be used to specify one or more tag files. For each tag 2167195972f6Sopenharmony_ci# file the location of the external documentation should be added. The format of 2168195972f6Sopenharmony_ci# a tag file without this location is as follows: 2169195972f6Sopenharmony_ci# TAGFILES = file1 file2 ... 2170195972f6Sopenharmony_ci# Adding location for the tag files is done as follows: 2171195972f6Sopenharmony_ci# TAGFILES = file1=loc1 "file2 = loc2" ... 2172195972f6Sopenharmony_ci# where loc1 and loc2 can be relative or absolute paths or URLs. See the 2173195972f6Sopenharmony_ci# section "Linking to external documentation" for more information about the use 2174195972f6Sopenharmony_ci# of tag files. 2175195972f6Sopenharmony_ci# Note: Each tag file must have a unique name (where the name does NOT include 2176195972f6Sopenharmony_ci# the path). If a tag file is not located in the directory in which doxygen is 2177195972f6Sopenharmony_ci# run, you must also specify the path to the tagfile here. 2178195972f6Sopenharmony_ci 2179195972f6Sopenharmony_ciTAGFILES = 2180195972f6Sopenharmony_ci 2181195972f6Sopenharmony_ci# When a file name is specified after GENERATE_TAGFILE, doxygen will create a 2182195972f6Sopenharmony_ci# tag file that is based on the input files it reads. See section "Linking to 2183195972f6Sopenharmony_ci# external documentation" for more information about the usage of tag files. 2184195972f6Sopenharmony_ci 2185195972f6Sopenharmony_ciGENERATE_TAGFILE = 2186195972f6Sopenharmony_ci 2187195972f6Sopenharmony_ci# If the ALLEXTERNALS tag is set to YES, all external class will be listed in 2188195972f6Sopenharmony_ci# the class index. If set to NO, only the inherited external classes will be 2189195972f6Sopenharmony_ci# listed. 2190195972f6Sopenharmony_ci# The default value is: NO. 2191195972f6Sopenharmony_ci 2192195972f6Sopenharmony_ciALLEXTERNALS = NO 2193195972f6Sopenharmony_ci 2194195972f6Sopenharmony_ci# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed 2195195972f6Sopenharmony_ci# in the modules index. If set to NO, only the current project's groups will be 2196195972f6Sopenharmony_ci# listed. 2197195972f6Sopenharmony_ci# The default value is: YES. 2198195972f6Sopenharmony_ci 2199195972f6Sopenharmony_ciEXTERNAL_GROUPS = YES 2200195972f6Sopenharmony_ci 2201195972f6Sopenharmony_ci# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in 2202195972f6Sopenharmony_ci# the related pages index. If set to NO, only the current project's pages will 2203195972f6Sopenharmony_ci# be listed. 2204195972f6Sopenharmony_ci# The default value is: YES. 2205195972f6Sopenharmony_ci 2206195972f6Sopenharmony_ciEXTERNAL_PAGES = YES 2207195972f6Sopenharmony_ci 2208195972f6Sopenharmony_ci# The PERL_PATH should be the absolute path and name of the perl script 2209195972f6Sopenharmony_ci# interpreter (i.e. the result of 'which perl'). 2210195972f6Sopenharmony_ci# The default file (with absolute path) is: /usr/bin/perl. 2211195972f6Sopenharmony_ci 2212195972f6Sopenharmony_ciPERL_PATH = /usr/bin/perl 2213195972f6Sopenharmony_ci 2214195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 2215195972f6Sopenharmony_ci# Configuration options related to the dot tool 2216195972f6Sopenharmony_ci#--------------------------------------------------------------------------- 2217195972f6Sopenharmony_ci 2218195972f6Sopenharmony_ci# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram 2219195972f6Sopenharmony_ci# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to 2220195972f6Sopenharmony_ci# NO turns the diagrams off. Note that this option also works with HAVE_DOT 2221195972f6Sopenharmony_ci# disabled, but it is recommended to install and use dot, since it yields more 2222195972f6Sopenharmony_ci# powerful graphs. 2223195972f6Sopenharmony_ci# The default value is: YES. 2224195972f6Sopenharmony_ci 2225195972f6Sopenharmony_ciCLASS_DIAGRAMS = YES 2226195972f6Sopenharmony_ci 2227195972f6Sopenharmony_ci# You can define message sequence charts within doxygen comments using the \msc 2228195972f6Sopenharmony_ci# command. Doxygen will then run the mscgen tool (see: 2229195972f6Sopenharmony_ci# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the 2230195972f6Sopenharmony_ci# documentation. The MSCGEN_PATH tag allows you to specify the directory where 2231195972f6Sopenharmony_ci# the mscgen tool resides. If left empty the tool is assumed to be found in the 2232195972f6Sopenharmony_ci# default search path. 2233195972f6Sopenharmony_ci 2234195972f6Sopenharmony_ciMSCGEN_PATH = 2235195972f6Sopenharmony_ci 2236195972f6Sopenharmony_ci# You can include diagrams made with dia in doxygen documentation. Doxygen will 2237195972f6Sopenharmony_ci# then run dia to produce the diagram and insert it in the documentation. The 2238195972f6Sopenharmony_ci# DIA_PATH tag allows you to specify the directory where the dia binary resides. 2239195972f6Sopenharmony_ci# If left empty dia is assumed to be found in the default search path. 2240195972f6Sopenharmony_ci 2241195972f6Sopenharmony_ciDIA_PATH = 2242195972f6Sopenharmony_ci 2243195972f6Sopenharmony_ci# If set to YES the inheritance and collaboration graphs will hide inheritance 2244195972f6Sopenharmony_ci# and usage relations if the target is undocumented or is not a class. 2245195972f6Sopenharmony_ci# The default value is: YES. 2246195972f6Sopenharmony_ci 2247195972f6Sopenharmony_ciHIDE_UNDOC_RELATIONS = YES 2248195972f6Sopenharmony_ci 2249195972f6Sopenharmony_ci# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 2250195972f6Sopenharmony_ci# available from the path. This tool is part of Graphviz (see: 2251195972f6Sopenharmony_ci# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent 2252195972f6Sopenharmony_ci# Bell Labs. The other options in this section have no effect if this option is 2253195972f6Sopenharmony_ci# set to NO 2254195972f6Sopenharmony_ci# The default value is: NO. 2255195972f6Sopenharmony_ci 2256195972f6Sopenharmony_ciHAVE_DOT = NO 2257195972f6Sopenharmony_ci 2258195972f6Sopenharmony_ci# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed 2259195972f6Sopenharmony_ci# to run in parallel. When set to 0 doxygen will base this on the number of 2260195972f6Sopenharmony_ci# processors available in the system. You can set it explicitly to a value 2261195972f6Sopenharmony_ci# larger than 0 to get control over the balance between CPU load and processing 2262195972f6Sopenharmony_ci# speed. 2263195972f6Sopenharmony_ci# Minimum value: 0, maximum value: 32, default value: 0. 2264195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2265195972f6Sopenharmony_ci 2266195972f6Sopenharmony_ciDOT_NUM_THREADS = 0 2267195972f6Sopenharmony_ci 2268195972f6Sopenharmony_ci# When you want a differently looking font in the dot files that doxygen 2269195972f6Sopenharmony_ci# generates you can specify the font name using DOT_FONTNAME. You need to make 2270195972f6Sopenharmony_ci# sure dot is able to find the font, which can be done by putting it in a 2271195972f6Sopenharmony_ci# standard location or by setting the DOTFONTPATH environment variable or by 2272195972f6Sopenharmony_ci# setting DOT_FONTPATH to the directory containing the font. 2273195972f6Sopenharmony_ci# The default value is: Helvetica. 2274195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2275195972f6Sopenharmony_ci 2276195972f6Sopenharmony_ciDOT_FONTNAME = Helvetica 2277195972f6Sopenharmony_ci 2278195972f6Sopenharmony_ci# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of 2279195972f6Sopenharmony_ci# dot graphs. 2280195972f6Sopenharmony_ci# Minimum value: 4, maximum value: 24, default value: 10. 2281195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2282195972f6Sopenharmony_ci 2283195972f6Sopenharmony_ciDOT_FONTSIZE = 10 2284195972f6Sopenharmony_ci 2285195972f6Sopenharmony_ci# By default doxygen will tell dot to use the default font as specified with 2286195972f6Sopenharmony_ci# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set 2287195972f6Sopenharmony_ci# the path where dot can find it using this tag. 2288195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2289195972f6Sopenharmony_ci 2290195972f6Sopenharmony_ciDOT_FONTPATH = 2291195972f6Sopenharmony_ci 2292195972f6Sopenharmony_ci# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for 2293195972f6Sopenharmony_ci# each documented class showing the direct and indirect inheritance relations. 2294195972f6Sopenharmony_ci# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. 2295195972f6Sopenharmony_ci# The default value is: YES. 2296195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2297195972f6Sopenharmony_ci 2298195972f6Sopenharmony_ciCLASS_GRAPH = YES 2299195972f6Sopenharmony_ci 2300195972f6Sopenharmony_ci# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a 2301195972f6Sopenharmony_ci# graph for each documented class showing the direct and indirect implementation 2302195972f6Sopenharmony_ci# dependencies (inheritance, containment, and class references variables) of the 2303195972f6Sopenharmony_ci# class with other documented classes. 2304195972f6Sopenharmony_ci# The default value is: YES. 2305195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2306195972f6Sopenharmony_ci 2307195972f6Sopenharmony_ciCOLLABORATION_GRAPH = YES 2308195972f6Sopenharmony_ci 2309195972f6Sopenharmony_ci# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for 2310195972f6Sopenharmony_ci# groups, showing the direct groups dependencies. 2311195972f6Sopenharmony_ci# The default value is: YES. 2312195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2313195972f6Sopenharmony_ci 2314195972f6Sopenharmony_ciGROUP_GRAPHS = YES 2315195972f6Sopenharmony_ci 2316195972f6Sopenharmony_ci# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and 2317195972f6Sopenharmony_ci# collaboration diagrams in a style similar to the OMG's Unified Modeling 2318195972f6Sopenharmony_ci# Language. 2319195972f6Sopenharmony_ci# The default value is: NO. 2320195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2321195972f6Sopenharmony_ci 2322195972f6Sopenharmony_ciUML_LOOK = NO 2323195972f6Sopenharmony_ci 2324195972f6Sopenharmony_ci# If the UML_LOOK tag is enabled, the fields and methods are shown inside the 2325195972f6Sopenharmony_ci# class node. If there are many fields or methods and many nodes the graph may 2326195972f6Sopenharmony_ci# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the 2327195972f6Sopenharmony_ci# number of items for each type to make the size more manageable. Set this to 0 2328195972f6Sopenharmony_ci# for no limit. Note that the threshold may be exceeded by 50% before the limit 2329195972f6Sopenharmony_ci# is enforced. So when you set the threshold to 10, up to 15 fields may appear, 2330195972f6Sopenharmony_ci# but if the number exceeds 15, the total amount of fields shown is limited to 2331195972f6Sopenharmony_ci# 10. 2332195972f6Sopenharmony_ci# Minimum value: 0, maximum value: 100, default value: 10. 2333195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2334195972f6Sopenharmony_ci 2335195972f6Sopenharmony_ciUML_LIMIT_NUM_FIELDS = 10 2336195972f6Sopenharmony_ci 2337195972f6Sopenharmony_ci# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and 2338195972f6Sopenharmony_ci# collaboration graphs will show the relations between templates and their 2339195972f6Sopenharmony_ci# instances. 2340195972f6Sopenharmony_ci# The default value is: NO. 2341195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2342195972f6Sopenharmony_ci 2343195972f6Sopenharmony_ciTEMPLATE_RELATIONS = NO 2344195972f6Sopenharmony_ci 2345195972f6Sopenharmony_ci# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to 2346195972f6Sopenharmony_ci# YES then doxygen will generate a graph for each documented file showing the 2347195972f6Sopenharmony_ci# direct and indirect include dependencies of the file with other documented 2348195972f6Sopenharmony_ci# files. 2349195972f6Sopenharmony_ci# The default value is: YES. 2350195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2351195972f6Sopenharmony_ci 2352195972f6Sopenharmony_ciINCLUDE_GRAPH = YES 2353195972f6Sopenharmony_ci 2354195972f6Sopenharmony_ci# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are 2355195972f6Sopenharmony_ci# set to YES then doxygen will generate a graph for each documented file showing 2356195972f6Sopenharmony_ci# the direct and indirect include dependencies of the file with other documented 2357195972f6Sopenharmony_ci# files. 2358195972f6Sopenharmony_ci# The default value is: YES. 2359195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2360195972f6Sopenharmony_ci 2361195972f6Sopenharmony_ciINCLUDED_BY_GRAPH = YES 2362195972f6Sopenharmony_ci 2363195972f6Sopenharmony_ci# If the CALL_GRAPH tag is set to YES then doxygen will generate a call 2364195972f6Sopenharmony_ci# dependency graph for every global function or class method. 2365195972f6Sopenharmony_ci# 2366195972f6Sopenharmony_ci# Note that enabling this option will significantly increase the time of a run. 2367195972f6Sopenharmony_ci# So in most cases it will be better to enable call graphs for selected 2368195972f6Sopenharmony_ci# functions only using the \callgraph command. Disabling a call graph can be 2369195972f6Sopenharmony_ci# accomplished by means of the command \hidecallgraph. 2370195972f6Sopenharmony_ci# The default value is: NO. 2371195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2372195972f6Sopenharmony_ci 2373195972f6Sopenharmony_ciCALL_GRAPH = NO 2374195972f6Sopenharmony_ci 2375195972f6Sopenharmony_ci# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller 2376195972f6Sopenharmony_ci# dependency graph for every global function or class method. 2377195972f6Sopenharmony_ci# 2378195972f6Sopenharmony_ci# Note that enabling this option will significantly increase the time of a run. 2379195972f6Sopenharmony_ci# So in most cases it will be better to enable caller graphs for selected 2380195972f6Sopenharmony_ci# functions only using the \callergraph command. Disabling a caller graph can be 2381195972f6Sopenharmony_ci# accomplished by means of the command \hidecallergraph. 2382195972f6Sopenharmony_ci# The default value is: NO. 2383195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2384195972f6Sopenharmony_ci 2385195972f6Sopenharmony_ciCALLER_GRAPH = NO 2386195972f6Sopenharmony_ci 2387195972f6Sopenharmony_ci# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical 2388195972f6Sopenharmony_ci# hierarchy of all classes instead of a textual one. 2389195972f6Sopenharmony_ci# The default value is: YES. 2390195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2391195972f6Sopenharmony_ci 2392195972f6Sopenharmony_ciGRAPHICAL_HIERARCHY = YES 2393195972f6Sopenharmony_ci 2394195972f6Sopenharmony_ci# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the 2395195972f6Sopenharmony_ci# dependencies a directory has on other directories in a graphical way. The 2396195972f6Sopenharmony_ci# dependency relations are determined by the #include relations between the 2397195972f6Sopenharmony_ci# files in the directories. 2398195972f6Sopenharmony_ci# The default value is: YES. 2399195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2400195972f6Sopenharmony_ci 2401195972f6Sopenharmony_ciDIRECTORY_GRAPH = YES 2402195972f6Sopenharmony_ci 2403195972f6Sopenharmony_ci# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 2404195972f6Sopenharmony_ci# generated by dot. For an explanation of the image formats see the section 2405195972f6Sopenharmony_ci# output formats in the documentation of the dot tool (Graphviz (see: 2406195972f6Sopenharmony_ci# http://www.graphviz.org/)). 2407195972f6Sopenharmony_ci# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order 2408195972f6Sopenharmony_ci# to make the SVG files visible in IE 9+ (other browsers do not have this 2409195972f6Sopenharmony_ci# requirement). 2410195972f6Sopenharmony_ci# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, 2411195972f6Sopenharmony_ci# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and 2412195972f6Sopenharmony_ci# png:gdiplus:gdiplus. 2413195972f6Sopenharmony_ci# The default value is: png. 2414195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2415195972f6Sopenharmony_ci 2416195972f6Sopenharmony_ciDOT_IMAGE_FORMAT = png 2417195972f6Sopenharmony_ci 2418195972f6Sopenharmony_ci# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 2419195972f6Sopenharmony_ci# enable generation of interactive SVG images that allow zooming and panning. 2420195972f6Sopenharmony_ci# 2421195972f6Sopenharmony_ci# Note that this requires a modern browser other than Internet Explorer. Tested 2422195972f6Sopenharmony_ci# and working are Firefox, Chrome, Safari, and Opera. 2423195972f6Sopenharmony_ci# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make 2424195972f6Sopenharmony_ci# the SVG files visible. Older versions of IE do not have SVG support. 2425195972f6Sopenharmony_ci# The default value is: NO. 2426195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2427195972f6Sopenharmony_ci 2428195972f6Sopenharmony_ciINTERACTIVE_SVG = NO 2429195972f6Sopenharmony_ci 2430195972f6Sopenharmony_ci# The DOT_PATH tag can be used to specify the path where the dot tool can be 2431195972f6Sopenharmony_ci# found. If left blank, it is assumed the dot tool can be found in the path. 2432195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2433195972f6Sopenharmony_ci 2434195972f6Sopenharmony_ciDOT_PATH = 2435195972f6Sopenharmony_ci 2436195972f6Sopenharmony_ci# The DOTFILE_DIRS tag can be used to specify one or more directories that 2437195972f6Sopenharmony_ci# contain dot files that are included in the documentation (see the \dotfile 2438195972f6Sopenharmony_ci# command). 2439195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2440195972f6Sopenharmony_ci 2441195972f6Sopenharmony_ciDOTFILE_DIRS = 2442195972f6Sopenharmony_ci 2443195972f6Sopenharmony_ci# The MSCFILE_DIRS tag can be used to specify one or more directories that 2444195972f6Sopenharmony_ci# contain msc files that are included in the documentation (see the \mscfile 2445195972f6Sopenharmony_ci# command). 2446195972f6Sopenharmony_ci 2447195972f6Sopenharmony_ciMSCFILE_DIRS = 2448195972f6Sopenharmony_ci 2449195972f6Sopenharmony_ci# The DIAFILE_DIRS tag can be used to specify one or more directories that 2450195972f6Sopenharmony_ci# contain dia files that are included in the documentation (see the \diafile 2451195972f6Sopenharmony_ci# command). 2452195972f6Sopenharmony_ci 2453195972f6Sopenharmony_ciDIAFILE_DIRS = 2454195972f6Sopenharmony_ci 2455195972f6Sopenharmony_ci# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the 2456195972f6Sopenharmony_ci# path where java can find the plantuml.jar file. If left blank, it is assumed 2457195972f6Sopenharmony_ci# PlantUML is not used or called during a preprocessing step. Doxygen will 2458195972f6Sopenharmony_ci# generate a warning when it encounters a \startuml command in this case and 2459195972f6Sopenharmony_ci# will not generate output for the diagram. 2460195972f6Sopenharmony_ci 2461195972f6Sopenharmony_ciPLANTUML_JAR_PATH = 2462195972f6Sopenharmony_ci 2463195972f6Sopenharmony_ci# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a 2464195972f6Sopenharmony_ci# configuration file for plantuml. 2465195972f6Sopenharmony_ci 2466195972f6Sopenharmony_ciPLANTUML_CFG_FILE = 2467195972f6Sopenharmony_ci 2468195972f6Sopenharmony_ci# When using plantuml, the specified paths are searched for files specified by 2469195972f6Sopenharmony_ci# the !include statement in a plantuml block. 2470195972f6Sopenharmony_ci 2471195972f6Sopenharmony_ciPLANTUML_INCLUDE_PATH = 2472195972f6Sopenharmony_ci 2473195972f6Sopenharmony_ci# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes 2474195972f6Sopenharmony_ci# that will be shown in the graph. If the number of nodes in a graph becomes 2475195972f6Sopenharmony_ci# larger than this value, doxygen will truncate the graph, which is visualized 2476195972f6Sopenharmony_ci# by representing a node as a red box. Note that doxygen if the number of direct 2477195972f6Sopenharmony_ci# children of the root node in a graph is already larger than 2478195972f6Sopenharmony_ci# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that 2479195972f6Sopenharmony_ci# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 2480195972f6Sopenharmony_ci# Minimum value: 0, maximum value: 10000, default value: 50. 2481195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2482195972f6Sopenharmony_ci 2483195972f6Sopenharmony_ciDOT_GRAPH_MAX_NODES = 50 2484195972f6Sopenharmony_ci 2485195972f6Sopenharmony_ci# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs 2486195972f6Sopenharmony_ci# generated by dot. A depth value of 3 means that only nodes reachable from the 2487195972f6Sopenharmony_ci# root by following a path via at most 3 edges will be shown. Nodes that lay 2488195972f6Sopenharmony_ci# further from the root node will be omitted. Note that setting this option to 1 2489195972f6Sopenharmony_ci# or 2 may greatly reduce the computation time needed for large code bases. Also 2490195972f6Sopenharmony_ci# note that the size of a graph can be further restricted by 2491195972f6Sopenharmony_ci# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 2492195972f6Sopenharmony_ci# Minimum value: 0, maximum value: 1000, default value: 0. 2493195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2494195972f6Sopenharmony_ci 2495195972f6Sopenharmony_ciMAX_DOT_GRAPH_DEPTH = 1000 2496195972f6Sopenharmony_ci 2497195972f6Sopenharmony_ci# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 2498195972f6Sopenharmony_ci# background. This is disabled by default, because dot on Windows does not seem 2499195972f6Sopenharmony_ci# to support this out of the box. 2500195972f6Sopenharmony_ci# 2501195972f6Sopenharmony_ci# Warning: Depending on the platform used, enabling this option may lead to 2502195972f6Sopenharmony_ci# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 2503195972f6Sopenharmony_ci# read). 2504195972f6Sopenharmony_ci# The default value is: NO. 2505195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2506195972f6Sopenharmony_ci 2507195972f6Sopenharmony_ciDOT_TRANSPARENT = NO 2508195972f6Sopenharmony_ci 2509195972f6Sopenharmony_ci# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output 2510195972f6Sopenharmony_ci# files in one run (i.e. multiple -o and -T options on the command line). This 2511195972f6Sopenharmony_ci# makes dot run faster, but since only newer versions of dot (>1.8.10) support 2512195972f6Sopenharmony_ci# this, this feature is disabled by default. 2513195972f6Sopenharmony_ci# The default value is: NO. 2514195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2515195972f6Sopenharmony_ci 2516195972f6Sopenharmony_ciDOT_MULTI_TARGETS = NO 2517195972f6Sopenharmony_ci 2518195972f6Sopenharmony_ci# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page 2519195972f6Sopenharmony_ci# explaining the meaning of the various boxes and arrows in the dot generated 2520195972f6Sopenharmony_ci# graphs. 2521195972f6Sopenharmony_ci# The default value is: YES. 2522195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2523195972f6Sopenharmony_ci 2524195972f6Sopenharmony_ciGENERATE_LEGEND = YES 2525195972f6Sopenharmony_ci 2526195972f6Sopenharmony_ci# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot 2527195972f6Sopenharmony_ci# files that are used to generate the various graphs. 2528195972f6Sopenharmony_ci# The default value is: YES. 2529195972f6Sopenharmony_ci# This tag requires that the tag HAVE_DOT is set to YES. 2530195972f6Sopenharmony_ci 2531195972f6Sopenharmony_ciDOT_CLEANUP = YES 2532