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