153a5a1b3Sopenharmony_ci# Doxyfile 1.8.3.1 253a5a1b3Sopenharmony_ci 353a5a1b3Sopenharmony_ci# This file describes the settings to be used by the documentation system 453a5a1b3Sopenharmony_ci# doxygen (www.doxygen.org) for a project. 553a5a1b3Sopenharmony_ci# 653a5a1b3Sopenharmony_ci# All text after a hash (#) is considered a comment and will be ignored. 753a5a1b3Sopenharmony_ci# The format is: 853a5a1b3Sopenharmony_ci# TAG = value [value, ...] 953a5a1b3Sopenharmony_ci# For lists items can also be appended using: 1053a5a1b3Sopenharmony_ci# TAG += value [value, ...] 1153a5a1b3Sopenharmony_ci# Values that contain spaces should be placed between quotes (" "). 1253a5a1b3Sopenharmony_ci 1353a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 1453a5a1b3Sopenharmony_ci# Project related configuration options 1553a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 1653a5a1b3Sopenharmony_ci 1753a5a1b3Sopenharmony_ci# This tag specifies the encoding used for all characters in the config file 1853a5a1b3Sopenharmony_ci# that follow. The default is UTF-8 which is also the encoding used for all 1953a5a1b3Sopenharmony_ci# text before the first occurrence of this tag. Doxygen uses libiconv (or the 2053a5a1b3Sopenharmony_ci# iconv built into libc) for the transcoding. See 2153a5a1b3Sopenharmony_ci# http://www.gnu.org/software/libiconv for the list of possible encodings. 2253a5a1b3Sopenharmony_ci 2353a5a1b3Sopenharmony_ciDOXYFILE_ENCODING = UTF-8 2453a5a1b3Sopenharmony_ci 2553a5a1b3Sopenharmony_ci# The PROJECT_NAME tag is a single word (or sequence of words) that should 2653a5a1b3Sopenharmony_ci# identify the project. Note that if you do not use Doxywizard you need 2753a5a1b3Sopenharmony_ci# to put quotes around the project name if it contains spaces. 2853a5a1b3Sopenharmony_ci 2953a5a1b3Sopenharmony_ciPROJECT_NAME = PulseAudio 3053a5a1b3Sopenharmony_ci 3153a5a1b3Sopenharmony_ci# The PROJECT_NUMBER tag can be used to enter a project or revision number. 3253a5a1b3Sopenharmony_ci# This could be handy for archiving the generated documentation or 3353a5a1b3Sopenharmony_ci# if some version control system is used. 3453a5a1b3Sopenharmony_ci 3553a5a1b3Sopenharmony_ciPROJECT_NUMBER = @PACKAGE_VERSION@ 3653a5a1b3Sopenharmony_ci 3753a5a1b3Sopenharmony_ci# Using the PROJECT_BRIEF tag one can provide an optional one line description 3853a5a1b3Sopenharmony_ci# for a project that appears at the top of each page and should give viewer 3953a5a1b3Sopenharmony_ci# a quick idea about the purpose of the project. Keep the description short. 4053a5a1b3Sopenharmony_ci 4153a5a1b3Sopenharmony_ciPROJECT_BRIEF = 4253a5a1b3Sopenharmony_ci 4353a5a1b3Sopenharmony_ci# With the PROJECT_LOGO tag one can specify an logo or icon that is 4453a5a1b3Sopenharmony_ci# included in the documentation. The maximum height of the logo should not 4553a5a1b3Sopenharmony_ci# exceed 55 pixels and the maximum width should not exceed 200 pixels. 4653a5a1b3Sopenharmony_ci# Doxygen will copy the logo to the output directory. 4753a5a1b3Sopenharmony_ci 4853a5a1b3Sopenharmony_ciPROJECT_LOGO = 4953a5a1b3Sopenharmony_ci 5053a5a1b3Sopenharmony_ci# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 5153a5a1b3Sopenharmony_ci# base path where the generated documentation will be put. 5253a5a1b3Sopenharmony_ci# If a relative path is entered, it will be relative to the location 5353a5a1b3Sopenharmony_ci# where doxygen was started. If left blank the current directory will be used. 5453a5a1b3Sopenharmony_ci 5553a5a1b3Sopenharmony_ciOUTPUT_DIRECTORY = @DOXYGEN_OUTPUT_DIRECTORY@ 5653a5a1b3Sopenharmony_ci 5753a5a1b3Sopenharmony_ci# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 5853a5a1b3Sopenharmony_ci# 4096 sub-directories (in 2 levels) under the output directory of each output 5953a5a1b3Sopenharmony_ci# format and will distribute the generated files over these directories. 6053a5a1b3Sopenharmony_ci# Enabling this option can be useful when feeding doxygen a huge amount of 6153a5a1b3Sopenharmony_ci# source files, where putting all generated files in the same directory would 6253a5a1b3Sopenharmony_ci# otherwise cause performance problems for the file system. 6353a5a1b3Sopenharmony_ci 6453a5a1b3Sopenharmony_ciCREATE_SUBDIRS = NO 6553a5a1b3Sopenharmony_ci 6653a5a1b3Sopenharmony_ci# The OUTPUT_LANGUAGE tag is used to specify the language in which all 6753a5a1b3Sopenharmony_ci# documentation generated by doxygen is written. Doxygen will use this 6853a5a1b3Sopenharmony_ci# information to generate all constant output in the proper language. 6953a5a1b3Sopenharmony_ci# The default language is English, other supported languages are: 7053a5a1b3Sopenharmony_ci# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 7153a5a1b3Sopenharmony_ci# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 7253a5a1b3Sopenharmony_ci# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 7353a5a1b3Sopenharmony_ci# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 7453a5a1b3Sopenharmony_ci# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, 7553a5a1b3Sopenharmony_ci# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 7653a5a1b3Sopenharmony_ci 7753a5a1b3Sopenharmony_ciOUTPUT_LANGUAGE = English 7853a5a1b3Sopenharmony_ci 7953a5a1b3Sopenharmony_ci# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 8053a5a1b3Sopenharmony_ci# include brief member descriptions after the members that are listed in 8153a5a1b3Sopenharmony_ci# the file and class documentation (similar to JavaDoc). 8253a5a1b3Sopenharmony_ci# Set to NO to disable this. 8353a5a1b3Sopenharmony_ci 8453a5a1b3Sopenharmony_ciBRIEF_MEMBER_DESC = YES 8553a5a1b3Sopenharmony_ci 8653a5a1b3Sopenharmony_ci# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 8753a5a1b3Sopenharmony_ci# the brief description of a member or function before the detailed description. 8853a5a1b3Sopenharmony_ci# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 8953a5a1b3Sopenharmony_ci# brief descriptions will be completely suppressed. 9053a5a1b3Sopenharmony_ci 9153a5a1b3Sopenharmony_ciREPEAT_BRIEF = YES 9253a5a1b3Sopenharmony_ci 9353a5a1b3Sopenharmony_ci# This tag implements a quasi-intelligent brief description abbreviator 9453a5a1b3Sopenharmony_ci# that is used to form the text in various listings. Each string 9553a5a1b3Sopenharmony_ci# in this list, if found as the leading text of the brief description, will be 9653a5a1b3Sopenharmony_ci# stripped from the text and the result after processing the whole list, is 9753a5a1b3Sopenharmony_ci# used as the annotated text. Otherwise, the brief description is used as-is. 9853a5a1b3Sopenharmony_ci# If left blank, the following values are used ("$name" is automatically 9953a5a1b3Sopenharmony_ci# replaced with the name of the entity): "The $name class" "The $name widget" 10053a5a1b3Sopenharmony_ci# "The $name file" "is" "provides" "specifies" "contains" 10153a5a1b3Sopenharmony_ci# "represents" "a" "an" "the" 10253a5a1b3Sopenharmony_ci 10353a5a1b3Sopenharmony_ciABBREVIATE_BRIEF = 10453a5a1b3Sopenharmony_ci 10553a5a1b3Sopenharmony_ci# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 10653a5a1b3Sopenharmony_ci# Doxygen will generate a detailed section even if there is only a brief 10753a5a1b3Sopenharmony_ci# description. 10853a5a1b3Sopenharmony_ci 10953a5a1b3Sopenharmony_ciALWAYS_DETAILED_SEC = NO 11053a5a1b3Sopenharmony_ci 11153a5a1b3Sopenharmony_ci# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 11253a5a1b3Sopenharmony_ci# inherited members of a class in the documentation of that class as if those 11353a5a1b3Sopenharmony_ci# members were ordinary class members. Constructors, destructors and assignment 11453a5a1b3Sopenharmony_ci# operators of the base classes will not be shown. 11553a5a1b3Sopenharmony_ci 11653a5a1b3Sopenharmony_ciINLINE_INHERITED_MEMB = NO 11753a5a1b3Sopenharmony_ci 11853a5a1b3Sopenharmony_ci# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 11953a5a1b3Sopenharmony_ci# path before files name in the file list and in the header files. If set 12053a5a1b3Sopenharmony_ci# to NO the shortest path that makes the file name unique will be used. 12153a5a1b3Sopenharmony_ci 12253a5a1b3Sopenharmony_ciFULL_PATH_NAMES = NO 12353a5a1b3Sopenharmony_ci 12453a5a1b3Sopenharmony_ci# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 12553a5a1b3Sopenharmony_ci# can be used to strip a user-defined part of the path. Stripping is 12653a5a1b3Sopenharmony_ci# only done if one of the specified strings matches the left-hand part of 12753a5a1b3Sopenharmony_ci# the path. The tag can be used to show relative paths in the file list. 12853a5a1b3Sopenharmony_ci# If left blank the directory from which doxygen is run is used as the 12953a5a1b3Sopenharmony_ci# path to strip. Note that you specify absolute paths here, but also 13053a5a1b3Sopenharmony_ci# relative paths, which will be relative from the directory where doxygen is 13153a5a1b3Sopenharmony_ci# started. 13253a5a1b3Sopenharmony_ci 13353a5a1b3Sopenharmony_ciSTRIP_FROM_PATH = 13453a5a1b3Sopenharmony_ci 13553a5a1b3Sopenharmony_ci# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 13653a5a1b3Sopenharmony_ci# the path mentioned in the documentation of a class, which tells 13753a5a1b3Sopenharmony_ci# the reader which header file to include in order to use a class. 13853a5a1b3Sopenharmony_ci# If left blank only the name of the header file containing the class 13953a5a1b3Sopenharmony_ci# definition is used. Otherwise one should specify the include paths that 14053a5a1b3Sopenharmony_ci# are normally passed to the compiler using the -I flag. 14153a5a1b3Sopenharmony_ci 14253a5a1b3Sopenharmony_ciSTRIP_FROM_INC_PATH = 14353a5a1b3Sopenharmony_ci 14453a5a1b3Sopenharmony_ci# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 14553a5a1b3Sopenharmony_ci# (but less readable) file names. This can be useful if your file system 14653a5a1b3Sopenharmony_ci# doesn't support long names like on DOS, Mac, or CD-ROM. 14753a5a1b3Sopenharmony_ci 14853a5a1b3Sopenharmony_ciSHORT_NAMES = NO 14953a5a1b3Sopenharmony_ci 15053a5a1b3Sopenharmony_ci# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 15153a5a1b3Sopenharmony_ci# will interpret the first line (until the first dot) of a JavaDoc-style 15253a5a1b3Sopenharmony_ci# comment as the brief description. If set to NO, the JavaDoc 15353a5a1b3Sopenharmony_ci# comments will behave just like regular Qt-style comments 15453a5a1b3Sopenharmony_ci# (thus requiring an explicit @brief command for a brief description.) 15553a5a1b3Sopenharmony_ci 15653a5a1b3Sopenharmony_ciJAVADOC_AUTOBRIEF = YES 15753a5a1b3Sopenharmony_ci 15853a5a1b3Sopenharmony_ci# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 15953a5a1b3Sopenharmony_ci# interpret the first line (until the first dot) of a Qt-style 16053a5a1b3Sopenharmony_ci# comment as the brief description. If set to NO, the comments 16153a5a1b3Sopenharmony_ci# will behave just like regular Qt-style comments (thus requiring 16253a5a1b3Sopenharmony_ci# an explicit \brief command for a brief description.) 16353a5a1b3Sopenharmony_ci 16453a5a1b3Sopenharmony_ciQT_AUTOBRIEF = NO 16553a5a1b3Sopenharmony_ci 16653a5a1b3Sopenharmony_ci# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 16753a5a1b3Sopenharmony_ci# treat a multi-line C++ special comment block (i.e. a block of //! or /// 16853a5a1b3Sopenharmony_ci# comments) as a brief description. This used to be the default behaviour. 16953a5a1b3Sopenharmony_ci# The new default is to treat a multi-line C++ comment block as a detailed 17053a5a1b3Sopenharmony_ci# description. Set this tag to YES if you prefer the old behaviour instead. 17153a5a1b3Sopenharmony_ci 17253a5a1b3Sopenharmony_ciMULTILINE_CPP_IS_BRIEF = NO 17353a5a1b3Sopenharmony_ci 17453a5a1b3Sopenharmony_ci# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 17553a5a1b3Sopenharmony_ci# member inherits the documentation from any documented member that it 17653a5a1b3Sopenharmony_ci# re-implements. 17753a5a1b3Sopenharmony_ci 17853a5a1b3Sopenharmony_ciINHERIT_DOCS = YES 17953a5a1b3Sopenharmony_ci 18053a5a1b3Sopenharmony_ci# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 18153a5a1b3Sopenharmony_ci# a new page for each member. If set to NO, the documentation of a member will 18253a5a1b3Sopenharmony_ci# be part of the file/class/namespace that contains it. 18353a5a1b3Sopenharmony_ci 18453a5a1b3Sopenharmony_ciSEPARATE_MEMBER_PAGES = NO 18553a5a1b3Sopenharmony_ci 18653a5a1b3Sopenharmony_ci# The TAB_SIZE tag can be used to set the number of spaces in a tab. 18753a5a1b3Sopenharmony_ci# Doxygen uses this value to replace tabs by spaces in code fragments. 18853a5a1b3Sopenharmony_ci 18953a5a1b3Sopenharmony_ciTAB_SIZE = 4 19053a5a1b3Sopenharmony_ci 19153a5a1b3Sopenharmony_ci# This tag can be used to specify a number of aliases that acts 19253a5a1b3Sopenharmony_ci# as commands in the documentation. An alias has the form "name=value". 19353a5a1b3Sopenharmony_ci# For example adding "sideeffect=\par Side Effects:\n" will allow you to 19453a5a1b3Sopenharmony_ci# put the command \sideeffect (or @sideeffect) in the documentation, which 19553a5a1b3Sopenharmony_ci# will result in a user-defined paragraph with heading "Side Effects:". 19653a5a1b3Sopenharmony_ci# You can put \n's in the value part of an alias to insert newlines. 19753a5a1b3Sopenharmony_ci 19853a5a1b3Sopenharmony_ciALIASES = 19953a5a1b3Sopenharmony_ci 20053a5a1b3Sopenharmony_ci# This tag can be used to specify a number of word-keyword mappings (TCL only). 20153a5a1b3Sopenharmony_ci# A mapping has the form "name=value". For example adding 20253a5a1b3Sopenharmony_ci# "class=itcl::class" will allow you to use the command class in the 20353a5a1b3Sopenharmony_ci# itcl::class meaning. 20453a5a1b3Sopenharmony_ci 20553a5a1b3Sopenharmony_ciTCL_SUBST = 20653a5a1b3Sopenharmony_ci 20753a5a1b3Sopenharmony_ci# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 20853a5a1b3Sopenharmony_ci# sources only. Doxygen will then generate output that is more tailored for C. 20953a5a1b3Sopenharmony_ci# For instance, some of the names that are used will be different. The list 21053a5a1b3Sopenharmony_ci# of all members will be omitted, etc. 21153a5a1b3Sopenharmony_ci 21253a5a1b3Sopenharmony_ciOPTIMIZE_OUTPUT_FOR_C = YES 21353a5a1b3Sopenharmony_ci 21453a5a1b3Sopenharmony_ci# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 21553a5a1b3Sopenharmony_ci# sources only. Doxygen will then generate output that is more tailored for 21653a5a1b3Sopenharmony_ci# Java. For instance, namespaces will be presented as packages, qualified 21753a5a1b3Sopenharmony_ci# scopes will look different, etc. 21853a5a1b3Sopenharmony_ci 21953a5a1b3Sopenharmony_ciOPTIMIZE_OUTPUT_JAVA = NO 22053a5a1b3Sopenharmony_ci 22153a5a1b3Sopenharmony_ci# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 22253a5a1b3Sopenharmony_ci# sources only. Doxygen will then generate output that is more tailored for 22353a5a1b3Sopenharmony_ci# Fortran. 22453a5a1b3Sopenharmony_ci 22553a5a1b3Sopenharmony_ciOPTIMIZE_FOR_FORTRAN = NO 22653a5a1b3Sopenharmony_ci 22753a5a1b3Sopenharmony_ci# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 22853a5a1b3Sopenharmony_ci# sources. Doxygen will then generate output that is tailored for 22953a5a1b3Sopenharmony_ci# VHDL. 23053a5a1b3Sopenharmony_ci 23153a5a1b3Sopenharmony_ciOPTIMIZE_OUTPUT_VHDL = NO 23253a5a1b3Sopenharmony_ci 23353a5a1b3Sopenharmony_ci# Doxygen selects the parser to use depending on the extension of the files it 23453a5a1b3Sopenharmony_ci# parses. With this tag you can assign which parser to use for a given 23553a5a1b3Sopenharmony_ci# extension. Doxygen has a built-in mapping, but you can override or extend it 23653a5a1b3Sopenharmony_ci# using this tag. The format is ext=language, where ext is a file extension, 23753a5a1b3Sopenharmony_ci# and language is one of the parsers supported by doxygen: IDL, Java, 23853a5a1b3Sopenharmony_ci# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, 23953a5a1b3Sopenharmony_ci# C++. For instance to make doxygen treat .inc files as Fortran files (default 24053a5a1b3Sopenharmony_ci# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note 24153a5a1b3Sopenharmony_ci# that for custom extensions you also need to set FILE_PATTERNS otherwise the 24253a5a1b3Sopenharmony_ci# files are not read by doxygen. 24353a5a1b3Sopenharmony_ci 24453a5a1b3Sopenharmony_ciEXTENSION_MAPPING = 24553a5a1b3Sopenharmony_ci 24653a5a1b3Sopenharmony_ci# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all 24753a5a1b3Sopenharmony_ci# comments according to the Markdown format, which allows for more readable 24853a5a1b3Sopenharmony_ci# documentation. See http://daringfireball.net/projects/markdown/ for details. 24953a5a1b3Sopenharmony_ci# The output of markdown processing is further processed by doxygen, so you 25053a5a1b3Sopenharmony_ci# can mix doxygen, HTML, and XML commands with Markdown formatting. 25153a5a1b3Sopenharmony_ci# Disable only in case of backward compatibilities issues. 25253a5a1b3Sopenharmony_ci 25353a5a1b3Sopenharmony_ciMARKDOWN_SUPPORT = YES 25453a5a1b3Sopenharmony_ci 25553a5a1b3Sopenharmony_ci# When enabled doxygen tries to link words that correspond to documented classes, 25653a5a1b3Sopenharmony_ci# or namespaces to their corresponding documentation. Such a link can be 25753a5a1b3Sopenharmony_ci# prevented in individual cases by by putting a % sign in front of the word or 25853a5a1b3Sopenharmony_ci# globally by setting AUTOLINK_SUPPORT to NO. 25953a5a1b3Sopenharmony_ci 26053a5a1b3Sopenharmony_ciAUTOLINK_SUPPORT = YES 26153a5a1b3Sopenharmony_ci 26253a5a1b3Sopenharmony_ci# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 26353a5a1b3Sopenharmony_ci# to include (a tag file for) the STL sources as input, then you should 26453a5a1b3Sopenharmony_ci# set this tag to YES in order to let doxygen match functions declarations and 26553a5a1b3Sopenharmony_ci# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 26653a5a1b3Sopenharmony_ci# func(std::string) {}). This also makes the inheritance and collaboration 26753a5a1b3Sopenharmony_ci# diagrams that involve STL classes more complete and accurate. 26853a5a1b3Sopenharmony_ci 26953a5a1b3Sopenharmony_ciBUILTIN_STL_SUPPORT = NO 27053a5a1b3Sopenharmony_ci 27153a5a1b3Sopenharmony_ci# If you use Microsoft's C++/CLI language, you should set this option to YES to 27253a5a1b3Sopenharmony_ci# enable parsing support. 27353a5a1b3Sopenharmony_ci 27453a5a1b3Sopenharmony_ciCPP_CLI_SUPPORT = NO 27553a5a1b3Sopenharmony_ci 27653a5a1b3Sopenharmony_ci# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 27753a5a1b3Sopenharmony_ci# Doxygen will parse them like normal C++ but will assume all classes use public 27853a5a1b3Sopenharmony_ci# instead of private inheritance when no explicit protection keyword is present. 27953a5a1b3Sopenharmony_ci 28053a5a1b3Sopenharmony_ciSIP_SUPPORT = NO 28153a5a1b3Sopenharmony_ci 28253a5a1b3Sopenharmony_ci# For Microsoft's IDL there are propget and propput attributes to indicate 28353a5a1b3Sopenharmony_ci# getter and setter methods for a property. Setting this option to YES (the 28453a5a1b3Sopenharmony_ci# default) will make doxygen replace the get and set methods by a property in 28553a5a1b3Sopenharmony_ci# the documentation. This will only work if the methods are indeed getting or 28653a5a1b3Sopenharmony_ci# setting a simple type. If this is not the case, or you want to show the 28753a5a1b3Sopenharmony_ci# methods anyway, you should set this option to NO. 28853a5a1b3Sopenharmony_ci 28953a5a1b3Sopenharmony_ciIDL_PROPERTY_SUPPORT = YES 29053a5a1b3Sopenharmony_ci 29153a5a1b3Sopenharmony_ci# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 29253a5a1b3Sopenharmony_ci# tag is set to YES, then doxygen will reuse the documentation of the first 29353a5a1b3Sopenharmony_ci# member in the group (if any) for the other members of the group. By default 29453a5a1b3Sopenharmony_ci# all members of a group must be documented explicitly. 29553a5a1b3Sopenharmony_ci 29653a5a1b3Sopenharmony_ciDISTRIBUTE_GROUP_DOC = NO 29753a5a1b3Sopenharmony_ci 29853a5a1b3Sopenharmony_ci# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 29953a5a1b3Sopenharmony_ci# the same type (for instance a group of public functions) to be put as a 30053a5a1b3Sopenharmony_ci# subgroup of that type (e.g. under the Public Functions section). Set it to 30153a5a1b3Sopenharmony_ci# NO to prevent subgrouping. Alternatively, this can be done per class using 30253a5a1b3Sopenharmony_ci# the \nosubgrouping command. 30353a5a1b3Sopenharmony_ci 30453a5a1b3Sopenharmony_ciSUBGROUPING = YES 30553a5a1b3Sopenharmony_ci 30653a5a1b3Sopenharmony_ci# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and 30753a5a1b3Sopenharmony_ci# unions are shown inside the group in which they are included (e.g. using 30853a5a1b3Sopenharmony_ci# @ingroup) instead of on a separate page (for HTML and Man pages) or 30953a5a1b3Sopenharmony_ci# section (for LaTeX and RTF). 31053a5a1b3Sopenharmony_ci 31153a5a1b3Sopenharmony_ciINLINE_GROUPED_CLASSES = NO 31253a5a1b3Sopenharmony_ci 31353a5a1b3Sopenharmony_ci# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and 31453a5a1b3Sopenharmony_ci# unions with only public data fields will be shown inline in the documentation 31553a5a1b3Sopenharmony_ci# of the scope in which they are defined (i.e. file, namespace, or group 31653a5a1b3Sopenharmony_ci# documentation), provided this scope is documented. If set to NO (the default), 31753a5a1b3Sopenharmony_ci# structs, classes, and unions are shown on a separate page (for HTML and Man 31853a5a1b3Sopenharmony_ci# pages) or section (for LaTeX and RTF). 31953a5a1b3Sopenharmony_ci 32053a5a1b3Sopenharmony_ciINLINE_SIMPLE_STRUCTS = NO 32153a5a1b3Sopenharmony_ci 32253a5a1b3Sopenharmony_ci# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 32353a5a1b3Sopenharmony_ci# is documented as struct, union, or enum with the name of the typedef. So 32453a5a1b3Sopenharmony_ci# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 32553a5a1b3Sopenharmony_ci# with name TypeT. When disabled the typedef will appear as a member of a file, 32653a5a1b3Sopenharmony_ci# namespace, or class. And the struct will be named TypeS. This can typically 32753a5a1b3Sopenharmony_ci# be useful for C code in case the coding convention dictates that all compound 32853a5a1b3Sopenharmony_ci# types are typedef'ed and only the typedef is referenced, never the tag name. 32953a5a1b3Sopenharmony_ci 33053a5a1b3Sopenharmony_ciTYPEDEF_HIDES_STRUCT = NO 33153a5a1b3Sopenharmony_ci 33253a5a1b3Sopenharmony_ci# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 33353a5a1b3Sopenharmony_ci# determine which symbols to keep in memory and which to flush to disk. 33453a5a1b3Sopenharmony_ci# When the cache is full, less often used symbols will be written to disk. 33553a5a1b3Sopenharmony_ci# For small to medium size projects (<1000 input files) the default value is 33653a5a1b3Sopenharmony_ci# probably good enough. For larger projects a too small cache size can cause 33753a5a1b3Sopenharmony_ci# doxygen to be busy swapping symbols to and from disk most of the time 33853a5a1b3Sopenharmony_ci# causing a significant performance penalty. 33953a5a1b3Sopenharmony_ci# If the system has enough physical memory increasing the cache will improve the 34053a5a1b3Sopenharmony_ci# performance by keeping more symbols in memory. Note that the value works on 34153a5a1b3Sopenharmony_ci# a logarithmic scale so increasing the size by one will roughly double the 34253a5a1b3Sopenharmony_ci# memory usage. The cache size is given by this formula: 34353a5a1b3Sopenharmony_ci# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 34453a5a1b3Sopenharmony_ci# corresponding to a cache size of 2^16 = 65536 symbols. 34553a5a1b3Sopenharmony_ci 34653a5a1b3Sopenharmony_ciSYMBOL_CACHE_SIZE = 0 34753a5a1b3Sopenharmony_ci 34853a5a1b3Sopenharmony_ci# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be 34953a5a1b3Sopenharmony_ci# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given 35053a5a1b3Sopenharmony_ci# their name and scope. Since this can be an expensive process and often the 35153a5a1b3Sopenharmony_ci# same symbol appear multiple times in the code, doxygen keeps a cache of 35253a5a1b3Sopenharmony_ci# pre-resolved symbols. If the cache is too small doxygen will become slower. 35353a5a1b3Sopenharmony_ci# If the cache is too large, memory is wasted. The cache size is given by this 35453a5a1b3Sopenharmony_ci# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, 35553a5a1b3Sopenharmony_ci# corresponding to a cache size of 2^16 = 65536 symbols. 35653a5a1b3Sopenharmony_ci 35753a5a1b3Sopenharmony_ciLOOKUP_CACHE_SIZE = 0 35853a5a1b3Sopenharmony_ci 35953a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 36053a5a1b3Sopenharmony_ci# Build related configuration options 36153a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 36253a5a1b3Sopenharmony_ci 36353a5a1b3Sopenharmony_ci# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 36453a5a1b3Sopenharmony_ci# documentation are documented, even if no documentation was available. 36553a5a1b3Sopenharmony_ci# Private class members and static file members will be hidden unless 36653a5a1b3Sopenharmony_ci# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 36753a5a1b3Sopenharmony_ci 36853a5a1b3Sopenharmony_ciEXTRACT_ALL = YES 36953a5a1b3Sopenharmony_ci 37053a5a1b3Sopenharmony_ci# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 37153a5a1b3Sopenharmony_ci# will be included in the documentation. 37253a5a1b3Sopenharmony_ci 37353a5a1b3Sopenharmony_ciEXTRACT_PRIVATE = NO 37453a5a1b3Sopenharmony_ci 37553a5a1b3Sopenharmony_ci# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal 37653a5a1b3Sopenharmony_ci# scope will be included in the documentation. 37753a5a1b3Sopenharmony_ci 37853a5a1b3Sopenharmony_ciEXTRACT_PACKAGE = NO 37953a5a1b3Sopenharmony_ci 38053a5a1b3Sopenharmony_ci# If the EXTRACT_STATIC tag is set to YES all static members of a file 38153a5a1b3Sopenharmony_ci# will be included in the documentation. 38253a5a1b3Sopenharmony_ci 38353a5a1b3Sopenharmony_ciEXTRACT_STATIC = NO 38453a5a1b3Sopenharmony_ci 38553a5a1b3Sopenharmony_ci# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 38653a5a1b3Sopenharmony_ci# defined locally in source files will be included in the documentation. 38753a5a1b3Sopenharmony_ci# If set to NO only classes defined in header files are included. 38853a5a1b3Sopenharmony_ci 38953a5a1b3Sopenharmony_ciEXTRACT_LOCAL_CLASSES = YES 39053a5a1b3Sopenharmony_ci 39153a5a1b3Sopenharmony_ci# This flag is only useful for Objective-C code. When set to YES local 39253a5a1b3Sopenharmony_ci# methods, which are defined in the implementation section but not in 39353a5a1b3Sopenharmony_ci# the interface are included in the documentation. 39453a5a1b3Sopenharmony_ci# If set to NO (the default) only methods in the interface are included. 39553a5a1b3Sopenharmony_ci 39653a5a1b3Sopenharmony_ciEXTRACT_LOCAL_METHODS = NO 39753a5a1b3Sopenharmony_ci 39853a5a1b3Sopenharmony_ci# If this flag is set to YES, the members of anonymous namespaces will be 39953a5a1b3Sopenharmony_ci# extracted and appear in the documentation as a namespace called 40053a5a1b3Sopenharmony_ci# 'anonymous_namespace{file}', where file will be replaced with the base 40153a5a1b3Sopenharmony_ci# name of the file that contains the anonymous namespace. By default 40253a5a1b3Sopenharmony_ci# anonymous namespaces are hidden. 40353a5a1b3Sopenharmony_ci 40453a5a1b3Sopenharmony_ciEXTRACT_ANON_NSPACES = NO 40553a5a1b3Sopenharmony_ci 40653a5a1b3Sopenharmony_ci# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 40753a5a1b3Sopenharmony_ci# undocumented members of documented classes, files or namespaces. 40853a5a1b3Sopenharmony_ci# If set to NO (the default) these members will be included in the 40953a5a1b3Sopenharmony_ci# various overviews, but no documentation section is generated. 41053a5a1b3Sopenharmony_ci# This option has no effect if EXTRACT_ALL is enabled. 41153a5a1b3Sopenharmony_ci 41253a5a1b3Sopenharmony_ciHIDE_UNDOC_MEMBERS = NO 41353a5a1b3Sopenharmony_ci 41453a5a1b3Sopenharmony_ci# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 41553a5a1b3Sopenharmony_ci# undocumented classes that are normally visible in the class hierarchy. 41653a5a1b3Sopenharmony_ci# If set to NO (the default) these classes will be included in the various 41753a5a1b3Sopenharmony_ci# overviews. This option has no effect if EXTRACT_ALL is enabled. 41853a5a1b3Sopenharmony_ci 41953a5a1b3Sopenharmony_ciHIDE_UNDOC_CLASSES = NO 42053a5a1b3Sopenharmony_ci 42153a5a1b3Sopenharmony_ci# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 42253a5a1b3Sopenharmony_ci# friend (class|struct|union) declarations. 42353a5a1b3Sopenharmony_ci# If set to NO (the default) these declarations will be included in the 42453a5a1b3Sopenharmony_ci# documentation. 42553a5a1b3Sopenharmony_ci 42653a5a1b3Sopenharmony_ciHIDE_FRIEND_COMPOUNDS = NO 42753a5a1b3Sopenharmony_ci 42853a5a1b3Sopenharmony_ci# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 42953a5a1b3Sopenharmony_ci# documentation blocks found inside the body of a function. 43053a5a1b3Sopenharmony_ci# If set to NO (the default) these blocks will be appended to the 43153a5a1b3Sopenharmony_ci# function's detailed documentation block. 43253a5a1b3Sopenharmony_ci 43353a5a1b3Sopenharmony_ciHIDE_IN_BODY_DOCS = NO 43453a5a1b3Sopenharmony_ci 43553a5a1b3Sopenharmony_ci# The INTERNAL_DOCS tag determines if documentation 43653a5a1b3Sopenharmony_ci# that is typed after a \internal command is included. If the tag is set 43753a5a1b3Sopenharmony_ci# to NO (the default) then the documentation will be excluded. 43853a5a1b3Sopenharmony_ci# Set it to YES to include the internal documentation. 43953a5a1b3Sopenharmony_ci 44053a5a1b3Sopenharmony_ciINTERNAL_DOCS = NO 44153a5a1b3Sopenharmony_ci 44253a5a1b3Sopenharmony_ci# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 44353a5a1b3Sopenharmony_ci# file names in lower-case letters. If set to YES upper-case letters are also 44453a5a1b3Sopenharmony_ci# allowed. This is useful if you have classes or files whose names only differ 44553a5a1b3Sopenharmony_ci# in case and if your file system supports case sensitive file names. Windows 44653a5a1b3Sopenharmony_ci# and Mac users are advised to set this option to NO. 44753a5a1b3Sopenharmony_ci 44853a5a1b3Sopenharmony_ciCASE_SENSE_NAMES = YES 44953a5a1b3Sopenharmony_ci 45053a5a1b3Sopenharmony_ci# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 45153a5a1b3Sopenharmony_ci# will show members with their full class and namespace scopes in the 45253a5a1b3Sopenharmony_ci# documentation. If set to YES the scope will be hidden. 45353a5a1b3Sopenharmony_ci 45453a5a1b3Sopenharmony_ciHIDE_SCOPE_NAMES = NO 45553a5a1b3Sopenharmony_ci 45653a5a1b3Sopenharmony_ci# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 45753a5a1b3Sopenharmony_ci# will put a list of the files that are included by a file in the documentation 45853a5a1b3Sopenharmony_ci# of that file. 45953a5a1b3Sopenharmony_ci 46053a5a1b3Sopenharmony_ciSHOW_INCLUDE_FILES = NO 46153a5a1b3Sopenharmony_ci 46253a5a1b3Sopenharmony_ci# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 46353a5a1b3Sopenharmony_ci# will list include files with double quotes in the documentation 46453a5a1b3Sopenharmony_ci# rather than with sharp brackets. 46553a5a1b3Sopenharmony_ci 46653a5a1b3Sopenharmony_ciFORCE_LOCAL_INCLUDES = NO 46753a5a1b3Sopenharmony_ci 46853a5a1b3Sopenharmony_ci# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 46953a5a1b3Sopenharmony_ci# is inserted in the documentation for inline members. 47053a5a1b3Sopenharmony_ci 47153a5a1b3Sopenharmony_ciINLINE_INFO = YES 47253a5a1b3Sopenharmony_ci 47353a5a1b3Sopenharmony_ci# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 47453a5a1b3Sopenharmony_ci# will sort the (detailed) documentation of file and class members 47553a5a1b3Sopenharmony_ci# alphabetically by member name. If set to NO the members will appear in 47653a5a1b3Sopenharmony_ci# declaration order. 47753a5a1b3Sopenharmony_ci 47853a5a1b3Sopenharmony_ciSORT_MEMBER_DOCS = YES 47953a5a1b3Sopenharmony_ci 48053a5a1b3Sopenharmony_ci# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 48153a5a1b3Sopenharmony_ci# brief documentation of file, namespace and class members alphabetically 48253a5a1b3Sopenharmony_ci# by member name. If set to NO (the default) the members will appear in 48353a5a1b3Sopenharmony_ci# declaration order. 48453a5a1b3Sopenharmony_ci 48553a5a1b3Sopenharmony_ciSORT_BRIEF_DOCS = NO 48653a5a1b3Sopenharmony_ci 48753a5a1b3Sopenharmony_ci# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 48853a5a1b3Sopenharmony_ci# will sort the (brief and detailed) documentation of class members so that 48953a5a1b3Sopenharmony_ci# constructors and destructors are listed first. If set to NO (the default) 49053a5a1b3Sopenharmony_ci# the constructors will appear in the respective orders defined by 49153a5a1b3Sopenharmony_ci# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 49253a5a1b3Sopenharmony_ci# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 49353a5a1b3Sopenharmony_ci# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 49453a5a1b3Sopenharmony_ci 49553a5a1b3Sopenharmony_ciSORT_MEMBERS_CTORS_1ST = NO 49653a5a1b3Sopenharmony_ci 49753a5a1b3Sopenharmony_ci# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 49853a5a1b3Sopenharmony_ci# hierarchy of group names into alphabetical order. If set to NO (the default) 49953a5a1b3Sopenharmony_ci# the group names will appear in their defined order. 50053a5a1b3Sopenharmony_ci 50153a5a1b3Sopenharmony_ciSORT_GROUP_NAMES = NO 50253a5a1b3Sopenharmony_ci 50353a5a1b3Sopenharmony_ci# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 50453a5a1b3Sopenharmony_ci# sorted by fully-qualified names, including namespaces. If set to 50553a5a1b3Sopenharmony_ci# NO (the default), the class list will be sorted only by class name, 50653a5a1b3Sopenharmony_ci# not including the namespace part. 50753a5a1b3Sopenharmony_ci# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 50853a5a1b3Sopenharmony_ci# Note: This option applies only to the class list, not to the 50953a5a1b3Sopenharmony_ci# alphabetical list. 51053a5a1b3Sopenharmony_ci 51153a5a1b3Sopenharmony_ciSORT_BY_SCOPE_NAME = NO 51253a5a1b3Sopenharmony_ci 51353a5a1b3Sopenharmony_ci# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 51453a5a1b3Sopenharmony_ci# do proper type resolution of all parameters of a function it will reject a 51553a5a1b3Sopenharmony_ci# match between the prototype and the implementation of a member function even 51653a5a1b3Sopenharmony_ci# if there is only one candidate or it is obvious which candidate to choose 51753a5a1b3Sopenharmony_ci# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 51853a5a1b3Sopenharmony_ci# will still accept a match between prototype and implementation in such cases. 51953a5a1b3Sopenharmony_ci 52053a5a1b3Sopenharmony_ciSTRICT_PROTO_MATCHING = NO 52153a5a1b3Sopenharmony_ci 52253a5a1b3Sopenharmony_ci# The GENERATE_TODOLIST tag can be used to enable (YES) or 52353a5a1b3Sopenharmony_ci# disable (NO) the todo list. This list is created by putting \todo 52453a5a1b3Sopenharmony_ci# commands in the documentation. 52553a5a1b3Sopenharmony_ci 52653a5a1b3Sopenharmony_ciGENERATE_TODOLIST = NO 52753a5a1b3Sopenharmony_ci 52853a5a1b3Sopenharmony_ci# The GENERATE_TESTLIST tag can be used to enable (YES) or 52953a5a1b3Sopenharmony_ci# disable (NO) the test list. This list is created by putting \test 53053a5a1b3Sopenharmony_ci# commands in the documentation. 53153a5a1b3Sopenharmony_ci 53253a5a1b3Sopenharmony_ciGENERATE_TESTLIST = NO 53353a5a1b3Sopenharmony_ci 53453a5a1b3Sopenharmony_ci# The GENERATE_BUGLIST tag can be used to enable (YES) or 53553a5a1b3Sopenharmony_ci# disable (NO) the bug list. This list is created by putting \bug 53653a5a1b3Sopenharmony_ci# commands in the documentation. 53753a5a1b3Sopenharmony_ci 53853a5a1b3Sopenharmony_ciGENERATE_BUGLIST = NO 53953a5a1b3Sopenharmony_ci 54053a5a1b3Sopenharmony_ci# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 54153a5a1b3Sopenharmony_ci# disable (NO) the deprecated list. This list is created by putting 54253a5a1b3Sopenharmony_ci# \deprecated commands in the documentation. 54353a5a1b3Sopenharmony_ci 54453a5a1b3Sopenharmony_ciGENERATE_DEPRECATEDLIST= YES 54553a5a1b3Sopenharmony_ci 54653a5a1b3Sopenharmony_ci# The ENABLED_SECTIONS tag can be used to enable conditional 54753a5a1b3Sopenharmony_ci# documentation sections, marked by \if section-label ... \endif 54853a5a1b3Sopenharmony_ci# and \cond section-label ... \endcond blocks. 54953a5a1b3Sopenharmony_ci 55053a5a1b3Sopenharmony_ciENABLED_SECTIONS = 55153a5a1b3Sopenharmony_ci 55253a5a1b3Sopenharmony_ci# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 55353a5a1b3Sopenharmony_ci# the initial value of a variable or macro consists of for it to appear in 55453a5a1b3Sopenharmony_ci# the documentation. If the initializer consists of more lines than specified 55553a5a1b3Sopenharmony_ci# here it will be hidden. Use a value of 0 to hide initializers completely. 55653a5a1b3Sopenharmony_ci# The appearance of the initializer of individual variables and macros in the 55753a5a1b3Sopenharmony_ci# documentation can be controlled using \showinitializer or \hideinitializer 55853a5a1b3Sopenharmony_ci# command in the documentation regardless of this setting. 55953a5a1b3Sopenharmony_ci 56053a5a1b3Sopenharmony_ciMAX_INITIALIZER_LINES = 30 56153a5a1b3Sopenharmony_ci 56253a5a1b3Sopenharmony_ci# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 56353a5a1b3Sopenharmony_ci# at the bottom of the documentation of classes and structs. If set to YES the 56453a5a1b3Sopenharmony_ci# list will mention the files that were used to generate the documentation. 56553a5a1b3Sopenharmony_ci 56653a5a1b3Sopenharmony_ciSHOW_USED_FILES = YES 56753a5a1b3Sopenharmony_ci 56853a5a1b3Sopenharmony_ci# Set the SHOW_FILES tag to NO to disable the generation of the Files page. 56953a5a1b3Sopenharmony_ci# This will remove the Files entry from the Quick Index and from the 57053a5a1b3Sopenharmony_ci# Folder Tree View (if specified). The default is YES. 57153a5a1b3Sopenharmony_ci 57253a5a1b3Sopenharmony_ciSHOW_FILES = YES 57353a5a1b3Sopenharmony_ci 57453a5a1b3Sopenharmony_ci# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 57553a5a1b3Sopenharmony_ci# Namespaces page. 57653a5a1b3Sopenharmony_ci# This will remove the Namespaces entry from the Quick Index 57753a5a1b3Sopenharmony_ci# and from the Folder Tree View (if specified). The default is YES. 57853a5a1b3Sopenharmony_ci 57953a5a1b3Sopenharmony_ciSHOW_NAMESPACES = YES 58053a5a1b3Sopenharmony_ci 58153a5a1b3Sopenharmony_ci# The FILE_VERSION_FILTER tag can be used to specify a program or script that 58253a5a1b3Sopenharmony_ci# doxygen should invoke to get the current version for each file (typically from 58353a5a1b3Sopenharmony_ci# the version control system). Doxygen will invoke the program by executing (via 58453a5a1b3Sopenharmony_ci# popen()) the command <command> <input-file>, where <command> is the value of 58553a5a1b3Sopenharmony_ci# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 58653a5a1b3Sopenharmony_ci# provided by doxygen. Whatever the program writes to standard output 58753a5a1b3Sopenharmony_ci# is used as the file version. See the manual for examples. 58853a5a1b3Sopenharmony_ci 58953a5a1b3Sopenharmony_ciFILE_VERSION_FILTER = 59053a5a1b3Sopenharmony_ci 59153a5a1b3Sopenharmony_ci# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 59253a5a1b3Sopenharmony_ci# by doxygen. The layout file controls the global structure of the generated 59353a5a1b3Sopenharmony_ci# output files in an output format independent way. To create the layout file 59453a5a1b3Sopenharmony_ci# that represents doxygen's defaults, run doxygen with the -l option. 59553a5a1b3Sopenharmony_ci# You can optionally specify a file name after the option, if omitted 59653a5a1b3Sopenharmony_ci# DoxygenLayout.xml will be used as the name of the layout file. 59753a5a1b3Sopenharmony_ci 59853a5a1b3Sopenharmony_ciLAYOUT_FILE = 59953a5a1b3Sopenharmony_ci 60053a5a1b3Sopenharmony_ci# The CITE_BIB_FILES tag can be used to specify one or more bib files 60153a5a1b3Sopenharmony_ci# containing the references data. This must be a list of .bib files. The 60253a5a1b3Sopenharmony_ci# .bib extension is automatically appended if omitted. Using this command 60353a5a1b3Sopenharmony_ci# requires the bibtex tool to be installed. See also 60453a5a1b3Sopenharmony_ci# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style 60553a5a1b3Sopenharmony_ci# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this 60653a5a1b3Sopenharmony_ci# feature you need bibtex and perl available in the search path. Do not use 60753a5a1b3Sopenharmony_ci# file names with spaces, bibtex cannot handle them. 60853a5a1b3Sopenharmony_ci 60953a5a1b3Sopenharmony_ciCITE_BIB_FILES = 61053a5a1b3Sopenharmony_ci 61153a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 61253a5a1b3Sopenharmony_ci# configuration options related to warning and progress messages 61353a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 61453a5a1b3Sopenharmony_ci 61553a5a1b3Sopenharmony_ci# The QUIET tag can be used to turn on/off the messages that are generated 61653a5a1b3Sopenharmony_ci# by doxygen. Possible values are YES and NO. If left blank NO is used. 61753a5a1b3Sopenharmony_ci 61853a5a1b3Sopenharmony_ciQUIET = NO 61953a5a1b3Sopenharmony_ci 62053a5a1b3Sopenharmony_ci# The WARNINGS tag can be used to turn on/off the warning messages that are 62153a5a1b3Sopenharmony_ci# generated by doxygen. Possible values are YES and NO. If left blank 62253a5a1b3Sopenharmony_ci# NO is used. 62353a5a1b3Sopenharmony_ci 62453a5a1b3Sopenharmony_ciWARNINGS = YES 62553a5a1b3Sopenharmony_ci 62653a5a1b3Sopenharmony_ci# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 62753a5a1b3Sopenharmony_ci# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 62853a5a1b3Sopenharmony_ci# automatically be disabled. 62953a5a1b3Sopenharmony_ci 63053a5a1b3Sopenharmony_ciWARN_IF_UNDOCUMENTED = YES 63153a5a1b3Sopenharmony_ci 63253a5a1b3Sopenharmony_ci# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 63353a5a1b3Sopenharmony_ci# potential errors in the documentation, such as not documenting some 63453a5a1b3Sopenharmony_ci# parameters in a documented function, or documenting parameters that 63553a5a1b3Sopenharmony_ci# don't exist or using markup commands wrongly. 63653a5a1b3Sopenharmony_ci 63753a5a1b3Sopenharmony_ciWARN_IF_DOC_ERROR = YES 63853a5a1b3Sopenharmony_ci 63953a5a1b3Sopenharmony_ci# The WARN_NO_PARAMDOC option can be enabled to get warnings for 64053a5a1b3Sopenharmony_ci# functions that are documented, but have no documentation for their parameters 64153a5a1b3Sopenharmony_ci# or return value. If set to NO (the default) doxygen will only warn about 64253a5a1b3Sopenharmony_ci# wrong or incomplete parameter documentation, but not about the absence of 64353a5a1b3Sopenharmony_ci# documentation. 64453a5a1b3Sopenharmony_ci 64553a5a1b3Sopenharmony_ciWARN_NO_PARAMDOC = NO 64653a5a1b3Sopenharmony_ci 64753a5a1b3Sopenharmony_ci# The WARN_FORMAT tag determines the format of the warning messages that 64853a5a1b3Sopenharmony_ci# doxygen can produce. The string should contain the $file, $line, and $text 64953a5a1b3Sopenharmony_ci# tags, which will be replaced by the file and line number from which the 65053a5a1b3Sopenharmony_ci# warning originated and the warning text. Optionally the format may contain 65153a5a1b3Sopenharmony_ci# $version, which will be replaced by the version of the file (if it could 65253a5a1b3Sopenharmony_ci# be obtained via FILE_VERSION_FILTER) 65353a5a1b3Sopenharmony_ci 65453a5a1b3Sopenharmony_ciWARN_FORMAT = "$file:$line: $text" 65553a5a1b3Sopenharmony_ci 65653a5a1b3Sopenharmony_ci# The WARN_LOGFILE tag can be used to specify a file to which warning 65753a5a1b3Sopenharmony_ci# and error messages should be written. If left blank the output is written 65853a5a1b3Sopenharmony_ci# to stderr. 65953a5a1b3Sopenharmony_ci 66053a5a1b3Sopenharmony_ciWARN_LOGFILE = 66153a5a1b3Sopenharmony_ci 66253a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 66353a5a1b3Sopenharmony_ci# configuration options related to the input files 66453a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 66553a5a1b3Sopenharmony_ci 66653a5a1b3Sopenharmony_ci# The INPUT tag can be used to specify the files and/or directories that contain 66753a5a1b3Sopenharmony_ci# documented source files. You may enter file names like "myfile.cpp" or 66853a5a1b3Sopenharmony_ci# directories like "/usr/src/myproject". Separate the files or directories 66953a5a1b3Sopenharmony_ci# with spaces. 67053a5a1b3Sopenharmony_ci 67153a5a1b3Sopenharmony_ciINPUT = @top_srcdir@/src/pulse/channelmap.h \ 67253a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/context.h \ 67353a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/def.h \ 67453a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/direction.h \ 67553a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/error.h \ 67653a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/ext-stream-restore.h \ 67753a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/ext-device-manager.h \ 67853a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/ext-device-restore.h \ 67953a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/format.h \ 68053a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/gccmacro.h \ 68153a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/glib-mainloop.h \ 68253a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/introspect.h \ 68353a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/mainloop-api.h \ 68453a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/mainloop-signal.h \ 68553a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/mainloop.h \ 68653a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/operation.h \ 68753a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/proplist.h \ 68853a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/pulseaudio.h \ 68953a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/rtclock.h \ 69053a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/sample.h \ 69153a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/scache.h \ 69253a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/simple.h \ 69353a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/stream.h \ 69453a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/subscribe.h \ 69553a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/thread-mainloop.h \ 69653a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/timeval.h \ 69753a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/utf8.h \ 69853a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/util.h \ 69953a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/version.h \ 70053a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/volume.h \ 70153a5a1b3Sopenharmony_ci @top_srcdir@/src/pulse/xmalloc.h 70253a5a1b3Sopenharmony_ci 70353a5a1b3Sopenharmony_ci# This tag can be used to specify the character encoding of the source files 70453a5a1b3Sopenharmony_ci# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 70553a5a1b3Sopenharmony_ci# also the default input encoding. Doxygen uses libiconv (or the iconv built 70653a5a1b3Sopenharmony_ci# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 70753a5a1b3Sopenharmony_ci# the list of possible encodings. 70853a5a1b3Sopenharmony_ci 70953a5a1b3Sopenharmony_ciINPUT_ENCODING = UTF-8 71053a5a1b3Sopenharmony_ci 71153a5a1b3Sopenharmony_ci# If the value of the INPUT tag contains directories, you can use the 71253a5a1b3Sopenharmony_ci# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 71353a5a1b3Sopenharmony_ci# and *.h) to filter out the source-files in the directories. If left 71453a5a1b3Sopenharmony_ci# blank the following patterns are tested: 71553a5a1b3Sopenharmony_ci# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 71653a5a1b3Sopenharmony_ci# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 71753a5a1b3Sopenharmony_ci# *.f90 *.f *.for *.vhd *.vhdl 71853a5a1b3Sopenharmony_ci 71953a5a1b3Sopenharmony_ciFILE_PATTERNS = 72053a5a1b3Sopenharmony_ci 72153a5a1b3Sopenharmony_ci# The RECURSIVE tag can be used to turn specify whether or not subdirectories 72253a5a1b3Sopenharmony_ci# should be searched for input files as well. Possible values are YES and NO. 72353a5a1b3Sopenharmony_ci# If left blank NO is used. 72453a5a1b3Sopenharmony_ci 72553a5a1b3Sopenharmony_ciRECURSIVE = NO 72653a5a1b3Sopenharmony_ci 72753a5a1b3Sopenharmony_ci# The EXCLUDE tag can be used to specify files and/or directories that should be 72853a5a1b3Sopenharmony_ci# excluded from the INPUT source files. This way you can easily exclude a 72953a5a1b3Sopenharmony_ci# subdirectory from a directory tree whose root is specified with the INPUT tag. 73053a5a1b3Sopenharmony_ci# Note that relative paths are relative to the directory from which doxygen is 73153a5a1b3Sopenharmony_ci# run. 73253a5a1b3Sopenharmony_ci 73353a5a1b3Sopenharmony_ciEXCLUDE = 73453a5a1b3Sopenharmony_ci 73553a5a1b3Sopenharmony_ci# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 73653a5a1b3Sopenharmony_ci# directories that are symbolic links (a Unix file system feature) are excluded 73753a5a1b3Sopenharmony_ci# from the input. 73853a5a1b3Sopenharmony_ci 73953a5a1b3Sopenharmony_ciEXCLUDE_SYMLINKS = NO 74053a5a1b3Sopenharmony_ci 74153a5a1b3Sopenharmony_ci# If the value of the INPUT tag contains directories, you can use the 74253a5a1b3Sopenharmony_ci# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 74353a5a1b3Sopenharmony_ci# certain files from those directories. Note that the wildcards are matched 74453a5a1b3Sopenharmony_ci# against the file with absolute path, so to exclude all test directories 74553a5a1b3Sopenharmony_ci# for example use the pattern */test/* 74653a5a1b3Sopenharmony_ci 74753a5a1b3Sopenharmony_ciEXCLUDE_PATTERNS = 74853a5a1b3Sopenharmony_ci 74953a5a1b3Sopenharmony_ci# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 75053a5a1b3Sopenharmony_ci# (namespaces, classes, functions, etc.) that should be excluded from the 75153a5a1b3Sopenharmony_ci# output. The symbol name can be a fully qualified name, a word, or if the 75253a5a1b3Sopenharmony_ci# wildcard * is used, a substring. Examples: ANamespace, AClass, 75353a5a1b3Sopenharmony_ci# AClass::ANamespace, ANamespace::*Test 75453a5a1b3Sopenharmony_ci 75553a5a1b3Sopenharmony_ciEXCLUDE_SYMBOLS = 75653a5a1b3Sopenharmony_ci 75753a5a1b3Sopenharmony_ci# The EXAMPLE_PATH tag can be used to specify one or more files or 75853a5a1b3Sopenharmony_ci# directories that contain example code fragments that are included (see 75953a5a1b3Sopenharmony_ci# the \include command). 76053a5a1b3Sopenharmony_ci 76153a5a1b3Sopenharmony_ciEXAMPLE_PATH = @top_srcdir@/src/utils \ 76253a5a1b3Sopenharmony_ci @top_srcdir@/src/tests 76353a5a1b3Sopenharmony_ci 76453a5a1b3Sopenharmony_ci# If the value of the EXAMPLE_PATH tag contains directories, you can use the 76553a5a1b3Sopenharmony_ci# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 76653a5a1b3Sopenharmony_ci# and *.h) to filter out the source-files in the directories. If left 76753a5a1b3Sopenharmony_ci# blank all files are included. 76853a5a1b3Sopenharmony_ci 76953a5a1b3Sopenharmony_ciEXAMPLE_PATTERNS = 77053a5a1b3Sopenharmony_ci 77153a5a1b3Sopenharmony_ci# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 77253a5a1b3Sopenharmony_ci# searched for input files to be used with the \include or \dontinclude 77353a5a1b3Sopenharmony_ci# commands irrespective of the value of the RECURSIVE tag. 77453a5a1b3Sopenharmony_ci# Possible values are YES and NO. If left blank NO is used. 77553a5a1b3Sopenharmony_ci 77653a5a1b3Sopenharmony_ciEXAMPLE_RECURSIVE = NO 77753a5a1b3Sopenharmony_ci 77853a5a1b3Sopenharmony_ci# The IMAGE_PATH tag can be used to specify one or more files or 77953a5a1b3Sopenharmony_ci# directories that contain image that are included in the documentation (see 78053a5a1b3Sopenharmony_ci# the \image command). 78153a5a1b3Sopenharmony_ci 78253a5a1b3Sopenharmony_ciIMAGE_PATH = 78353a5a1b3Sopenharmony_ci 78453a5a1b3Sopenharmony_ci# The INPUT_FILTER tag can be used to specify a program that doxygen should 78553a5a1b3Sopenharmony_ci# invoke to filter for each input file. Doxygen will invoke the filter program 78653a5a1b3Sopenharmony_ci# by executing (via popen()) the command <filter> <input-file>, where <filter> 78753a5a1b3Sopenharmony_ci# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 78853a5a1b3Sopenharmony_ci# input file. Doxygen will then use the output that the filter program writes 78953a5a1b3Sopenharmony_ci# to standard output. 79053a5a1b3Sopenharmony_ci# If FILTER_PATTERNS is specified, this tag will be 79153a5a1b3Sopenharmony_ci# ignored. 79253a5a1b3Sopenharmony_ci 79353a5a1b3Sopenharmony_ciINPUT_FILTER = 79453a5a1b3Sopenharmony_ci 79553a5a1b3Sopenharmony_ci# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 79653a5a1b3Sopenharmony_ci# basis. 79753a5a1b3Sopenharmony_ci# Doxygen will compare the file name with each pattern and apply the 79853a5a1b3Sopenharmony_ci# filter if there is a match. 79953a5a1b3Sopenharmony_ci# The filters are a list of the form: 80053a5a1b3Sopenharmony_ci# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 80153a5a1b3Sopenharmony_ci# info on how filters are used. If FILTER_PATTERNS is empty or if 80253a5a1b3Sopenharmony_ci# non of the patterns match the file name, INPUT_FILTER is applied. 80353a5a1b3Sopenharmony_ci 80453a5a1b3Sopenharmony_ciFILTER_PATTERNS = 80553a5a1b3Sopenharmony_ci 80653a5a1b3Sopenharmony_ci# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 80753a5a1b3Sopenharmony_ci# INPUT_FILTER) will be used to filter the input files when producing source 80853a5a1b3Sopenharmony_ci# files to browse (i.e. when SOURCE_BROWSER is set to YES). 80953a5a1b3Sopenharmony_ci 81053a5a1b3Sopenharmony_ciFILTER_SOURCE_FILES = NO 81153a5a1b3Sopenharmony_ci 81253a5a1b3Sopenharmony_ci# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 81353a5a1b3Sopenharmony_ci# pattern. A pattern will override the setting for FILTER_PATTERN (if any) 81453a5a1b3Sopenharmony_ci# and it is also possible to disable source filtering for a specific pattern 81553a5a1b3Sopenharmony_ci# using *.ext= (so without naming a filter). This option only has effect when 81653a5a1b3Sopenharmony_ci# FILTER_SOURCE_FILES is enabled. 81753a5a1b3Sopenharmony_ci 81853a5a1b3Sopenharmony_ciFILTER_SOURCE_PATTERNS = 81953a5a1b3Sopenharmony_ci 82053a5a1b3Sopenharmony_ci# If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that 82153a5a1b3Sopenharmony_ci# is part of the input, its contents will be placed on the main page (index.html). 82253a5a1b3Sopenharmony_ci# This can be useful if you have a project on for instance GitHub and want reuse 82353a5a1b3Sopenharmony_ci# the introduction page also for the doxygen output. 82453a5a1b3Sopenharmony_ci 82553a5a1b3Sopenharmony_ciUSE_MDFILE_AS_MAINPAGE = 82653a5a1b3Sopenharmony_ci 82753a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 82853a5a1b3Sopenharmony_ci# configuration options related to source browsing 82953a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 83053a5a1b3Sopenharmony_ci 83153a5a1b3Sopenharmony_ci# If the SOURCE_BROWSER tag is set to YES then a list of source files will 83253a5a1b3Sopenharmony_ci# be generated. Documented entities will be cross-referenced with these sources. 83353a5a1b3Sopenharmony_ci# Note: To get rid of all source code in the generated output, make sure also 83453a5a1b3Sopenharmony_ci# VERBATIM_HEADERS is set to NO. 83553a5a1b3Sopenharmony_ci 83653a5a1b3Sopenharmony_ciSOURCE_BROWSER = NO 83753a5a1b3Sopenharmony_ci 83853a5a1b3Sopenharmony_ci# Setting the INLINE_SOURCES tag to YES will include the body 83953a5a1b3Sopenharmony_ci# of functions and classes directly in the documentation. 84053a5a1b3Sopenharmony_ci 84153a5a1b3Sopenharmony_ciINLINE_SOURCES = NO 84253a5a1b3Sopenharmony_ci 84353a5a1b3Sopenharmony_ci# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 84453a5a1b3Sopenharmony_ci# doxygen to hide any special comment blocks from generated source code 84553a5a1b3Sopenharmony_ci# fragments. Normal C, C++ and Fortran comments will always remain visible. 84653a5a1b3Sopenharmony_ci 84753a5a1b3Sopenharmony_ciSTRIP_CODE_COMMENTS = YES 84853a5a1b3Sopenharmony_ci 84953a5a1b3Sopenharmony_ci# If the REFERENCED_BY_RELATION tag is set to YES 85053a5a1b3Sopenharmony_ci# then for each documented function all documented 85153a5a1b3Sopenharmony_ci# functions referencing it will be listed. 85253a5a1b3Sopenharmony_ci 85353a5a1b3Sopenharmony_ciREFERENCED_BY_RELATION = YES 85453a5a1b3Sopenharmony_ci 85553a5a1b3Sopenharmony_ci# If the REFERENCES_RELATION tag is set to YES 85653a5a1b3Sopenharmony_ci# then for each documented function all documented entities 85753a5a1b3Sopenharmony_ci# called/used by that function will be listed. 85853a5a1b3Sopenharmony_ci 85953a5a1b3Sopenharmony_ciREFERENCES_RELATION = YES 86053a5a1b3Sopenharmony_ci 86153a5a1b3Sopenharmony_ci# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 86253a5a1b3Sopenharmony_ci# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 86353a5a1b3Sopenharmony_ci# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 86453a5a1b3Sopenharmony_ci# link to the source code. 86553a5a1b3Sopenharmony_ci# Otherwise they will link to the documentation. 86653a5a1b3Sopenharmony_ci 86753a5a1b3Sopenharmony_ciREFERENCES_LINK_SOURCE = YES 86853a5a1b3Sopenharmony_ci 86953a5a1b3Sopenharmony_ci# If the USE_HTAGS tag is set to YES then the references to source code 87053a5a1b3Sopenharmony_ci# will point to the HTML generated by the htags(1) tool instead of doxygen 87153a5a1b3Sopenharmony_ci# built-in source browser. The htags tool is part of GNU's global source 87253a5a1b3Sopenharmony_ci# tagging system (see http://www.gnu.org/software/global/global.html). You 87353a5a1b3Sopenharmony_ci# will need version 4.8.6 or higher. 87453a5a1b3Sopenharmony_ci 87553a5a1b3Sopenharmony_ciUSE_HTAGS = NO 87653a5a1b3Sopenharmony_ci 87753a5a1b3Sopenharmony_ci# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 87853a5a1b3Sopenharmony_ci# will generate a verbatim copy of the header file for each class for 87953a5a1b3Sopenharmony_ci# which an include is specified. Set to NO to disable this. 88053a5a1b3Sopenharmony_ci 88153a5a1b3Sopenharmony_ciVERBATIM_HEADERS = YES 88253a5a1b3Sopenharmony_ci 88353a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 88453a5a1b3Sopenharmony_ci# configuration options related to the alphabetical class index 88553a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 88653a5a1b3Sopenharmony_ci 88753a5a1b3Sopenharmony_ci# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 88853a5a1b3Sopenharmony_ci# of all compounds will be generated. Enable this if the project 88953a5a1b3Sopenharmony_ci# contains a lot of classes, structs, unions or interfaces. 89053a5a1b3Sopenharmony_ci 89153a5a1b3Sopenharmony_ciALPHABETICAL_INDEX = YES 89253a5a1b3Sopenharmony_ci 89353a5a1b3Sopenharmony_ci# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 89453a5a1b3Sopenharmony_ci# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 89553a5a1b3Sopenharmony_ci# in which this list will be split (can be a number in the range [1..20]) 89653a5a1b3Sopenharmony_ci 89753a5a1b3Sopenharmony_ciCOLS_IN_ALPHA_INDEX = 5 89853a5a1b3Sopenharmony_ci 89953a5a1b3Sopenharmony_ci# In case all classes in a project start with a common prefix, all 90053a5a1b3Sopenharmony_ci# classes will be put under the same header in the alphabetical index. 90153a5a1b3Sopenharmony_ci# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 90253a5a1b3Sopenharmony_ci# should be ignored while generating the index headers. 90353a5a1b3Sopenharmony_ci 90453a5a1b3Sopenharmony_ciIGNORE_PREFIX = pa_ \ 90553a5a1b3Sopenharmony_ci PA_ 90653a5a1b3Sopenharmony_ci 90753a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 90853a5a1b3Sopenharmony_ci# configuration options related to the HTML output 90953a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 91053a5a1b3Sopenharmony_ci 91153a5a1b3Sopenharmony_ci# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 91253a5a1b3Sopenharmony_ci# generate HTML output. 91353a5a1b3Sopenharmony_ci 91453a5a1b3Sopenharmony_ciGENERATE_HTML = YES 91553a5a1b3Sopenharmony_ci 91653a5a1b3Sopenharmony_ci# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 91753a5a1b3Sopenharmony_ci# If a relative path is entered the value of OUTPUT_DIRECTORY will be 91853a5a1b3Sopenharmony_ci# put in front of it. If left blank `html' will be used as the default path. 91953a5a1b3Sopenharmony_ci 92053a5a1b3Sopenharmony_ciHTML_OUTPUT = html 92153a5a1b3Sopenharmony_ci 92253a5a1b3Sopenharmony_ci# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 92353a5a1b3Sopenharmony_ci# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 92453a5a1b3Sopenharmony_ci# doxygen will generate files with .html extension. 92553a5a1b3Sopenharmony_ci 92653a5a1b3Sopenharmony_ciHTML_FILE_EXTENSION = .html 92753a5a1b3Sopenharmony_ci 92853a5a1b3Sopenharmony_ci# The HTML_HEADER tag can be used to specify a personal HTML header for 92953a5a1b3Sopenharmony_ci# each generated HTML page. If it is left blank doxygen will generate a 93053a5a1b3Sopenharmony_ci# standard header. Note that when using a custom header you are responsible 93153a5a1b3Sopenharmony_ci# for the proper inclusion of any scripts and style sheets that doxygen 93253a5a1b3Sopenharmony_ci# needs, which is dependent on the configuration options used. 93353a5a1b3Sopenharmony_ci# It is advised to generate a default header using "doxygen -w html 93453a5a1b3Sopenharmony_ci# header.html footer.html stylesheet.css YourConfigFile" and then modify 93553a5a1b3Sopenharmony_ci# that header. Note that the header is subject to change so you typically 93653a5a1b3Sopenharmony_ci# have to redo this when upgrading to a newer version of doxygen or when 93753a5a1b3Sopenharmony_ci# changing the value of configuration settings such as GENERATE_TREEVIEW! 93853a5a1b3Sopenharmony_ci 93953a5a1b3Sopenharmony_ciHTML_HEADER = 94053a5a1b3Sopenharmony_ci 94153a5a1b3Sopenharmony_ci# The HTML_FOOTER tag can be used to specify a personal HTML footer for 94253a5a1b3Sopenharmony_ci# each generated HTML page. If it is left blank doxygen will generate a 94353a5a1b3Sopenharmony_ci# standard footer. 94453a5a1b3Sopenharmony_ci 94553a5a1b3Sopenharmony_ciHTML_FOOTER = 94653a5a1b3Sopenharmony_ci 94753a5a1b3Sopenharmony_ci# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 94853a5a1b3Sopenharmony_ci# style sheet that is used by each HTML page. It can be used to 94953a5a1b3Sopenharmony_ci# fine-tune the look of the HTML output. If left blank doxygen will 95053a5a1b3Sopenharmony_ci# generate a default style sheet. Note that it is recommended to use 95153a5a1b3Sopenharmony_ci# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this 95253a5a1b3Sopenharmony_ci# tag will in the future become obsolete. 95353a5a1b3Sopenharmony_ci 95453a5a1b3Sopenharmony_ciHTML_STYLESHEET = 95553a5a1b3Sopenharmony_ci 95653a5a1b3Sopenharmony_ci# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional 95753a5a1b3Sopenharmony_ci# user-defined cascading style sheet that is included after the standard 95853a5a1b3Sopenharmony_ci# style sheets created by doxygen. Using this option one can overrule 95953a5a1b3Sopenharmony_ci# certain style aspects. This is preferred over using HTML_STYLESHEET 96053a5a1b3Sopenharmony_ci# since it does not replace the standard style sheet and is therefor more 96153a5a1b3Sopenharmony_ci# robust against future updates. Doxygen will copy the style sheet file to 96253a5a1b3Sopenharmony_ci# the output directory. 96353a5a1b3Sopenharmony_ci 96453a5a1b3Sopenharmony_ciHTML_EXTRA_STYLESHEET = 96553a5a1b3Sopenharmony_ci 96653a5a1b3Sopenharmony_ci# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 96753a5a1b3Sopenharmony_ci# other source files which should be copied to the HTML output directory. Note 96853a5a1b3Sopenharmony_ci# that these files will be copied to the base HTML output directory. Use the 96953a5a1b3Sopenharmony_ci# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 97053a5a1b3Sopenharmony_ci# files. In the HTML_STYLESHEET file, use the file name only. Also note that 97153a5a1b3Sopenharmony_ci# the files will be copied as-is; there are no commands or markers available. 97253a5a1b3Sopenharmony_ci 97353a5a1b3Sopenharmony_ciHTML_EXTRA_FILES = 97453a5a1b3Sopenharmony_ci 97553a5a1b3Sopenharmony_ci# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 97653a5a1b3Sopenharmony_ci# Doxygen will adjust the colors in the style sheet and background images 97753a5a1b3Sopenharmony_ci# according to this color. Hue is specified as an angle on a colorwheel, 97853a5a1b3Sopenharmony_ci# see http://en.wikipedia.org/wiki/Hue for more information. 97953a5a1b3Sopenharmony_ci# For instance the value 0 represents red, 60 is yellow, 120 is green, 98053a5a1b3Sopenharmony_ci# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 98153a5a1b3Sopenharmony_ci# The allowed range is 0 to 359. 98253a5a1b3Sopenharmony_ci 98353a5a1b3Sopenharmony_ciHTML_COLORSTYLE_HUE = 220 98453a5a1b3Sopenharmony_ci 98553a5a1b3Sopenharmony_ci# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 98653a5a1b3Sopenharmony_ci# the colors in the HTML output. For a value of 0 the output will use 98753a5a1b3Sopenharmony_ci# grayscales only. A value of 255 will produce the most vivid colors. 98853a5a1b3Sopenharmony_ci 98953a5a1b3Sopenharmony_ciHTML_COLORSTYLE_SAT = 100 99053a5a1b3Sopenharmony_ci 99153a5a1b3Sopenharmony_ci# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 99253a5a1b3Sopenharmony_ci# the luminance component of the colors in the HTML output. Values below 99353a5a1b3Sopenharmony_ci# 100 gradually make the output lighter, whereas values above 100 make 99453a5a1b3Sopenharmony_ci# the output darker. The value divided by 100 is the actual gamma applied, 99553a5a1b3Sopenharmony_ci# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 99653a5a1b3Sopenharmony_ci# and 100 does not change the gamma. 99753a5a1b3Sopenharmony_ci 99853a5a1b3Sopenharmony_ciHTML_COLORSTYLE_GAMMA = 80 99953a5a1b3Sopenharmony_ci 100053a5a1b3Sopenharmony_ci# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 100153a5a1b3Sopenharmony_ci# page will contain the date and time when the page was generated. Setting 100253a5a1b3Sopenharmony_ci# this to NO can help when comparing the output of multiple runs. 100353a5a1b3Sopenharmony_ci 100453a5a1b3Sopenharmony_ciHTML_TIMESTAMP = NO 100553a5a1b3Sopenharmony_ci 100653a5a1b3Sopenharmony_ci# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 100753a5a1b3Sopenharmony_ci# documentation will contain sections that can be hidden and shown after the 100853a5a1b3Sopenharmony_ci# page has loaded. 100953a5a1b3Sopenharmony_ci 101053a5a1b3Sopenharmony_ciHTML_DYNAMIC_SECTIONS = NO 101153a5a1b3Sopenharmony_ci 101253a5a1b3Sopenharmony_ci# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of 101353a5a1b3Sopenharmony_ci# entries shown in the various tree structured indices initially; the user 101453a5a1b3Sopenharmony_ci# can expand and collapse entries dynamically later on. Doxygen will expand 101553a5a1b3Sopenharmony_ci# the tree to such a level that at most the specified number of entries are 101653a5a1b3Sopenharmony_ci# visible (unless a fully collapsed tree already exceeds this amount). 101753a5a1b3Sopenharmony_ci# So setting the number of entries 1 will produce a full collapsed tree by 101853a5a1b3Sopenharmony_ci# default. 0 is a special value representing an infinite number of entries 101953a5a1b3Sopenharmony_ci# and will result in a full expanded tree by default. 102053a5a1b3Sopenharmony_ci 102153a5a1b3Sopenharmony_ciHTML_INDEX_NUM_ENTRIES = 100 102253a5a1b3Sopenharmony_ci 102353a5a1b3Sopenharmony_ci# If the GENERATE_DOCSET tag is set to YES, additional index files 102453a5a1b3Sopenharmony_ci# will be generated that can be used as input for Apple's Xcode 3 102553a5a1b3Sopenharmony_ci# integrated development environment, introduced with OSX 10.5 (Leopard). 102653a5a1b3Sopenharmony_ci# To create a documentation set, doxygen will generate a Makefile in the 102753a5a1b3Sopenharmony_ci# HTML output directory. Running make will produce the docset in that 102853a5a1b3Sopenharmony_ci# directory and running "make install" will install the docset in 102953a5a1b3Sopenharmony_ci# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 103053a5a1b3Sopenharmony_ci# it at startup. 103153a5a1b3Sopenharmony_ci# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 103253a5a1b3Sopenharmony_ci# for more information. 103353a5a1b3Sopenharmony_ci 103453a5a1b3Sopenharmony_ciGENERATE_DOCSET = NO 103553a5a1b3Sopenharmony_ci 103653a5a1b3Sopenharmony_ci# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 103753a5a1b3Sopenharmony_ci# feed. A documentation feed provides an umbrella under which multiple 103853a5a1b3Sopenharmony_ci# documentation sets from a single provider (such as a company or product suite) 103953a5a1b3Sopenharmony_ci# can be grouped. 104053a5a1b3Sopenharmony_ci 104153a5a1b3Sopenharmony_ciDOCSET_FEEDNAME = "Doxygen generated docs" 104253a5a1b3Sopenharmony_ci 104353a5a1b3Sopenharmony_ci# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 104453a5a1b3Sopenharmony_ci# should uniquely identify the documentation set bundle. This should be a 104553a5a1b3Sopenharmony_ci# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 104653a5a1b3Sopenharmony_ci# will append .docset to the name. 104753a5a1b3Sopenharmony_ci 104853a5a1b3Sopenharmony_ciDOCSET_BUNDLE_ID = org.doxygen.Project 104953a5a1b3Sopenharmony_ci 105053a5a1b3Sopenharmony_ci# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely 105153a5a1b3Sopenharmony_ci# identify the documentation publisher. This should be a reverse domain-name 105253a5a1b3Sopenharmony_ci# style string, e.g. com.mycompany.MyDocSet.documentation. 105353a5a1b3Sopenharmony_ci 105453a5a1b3Sopenharmony_ciDOCSET_PUBLISHER_ID = org.doxygen.Publisher 105553a5a1b3Sopenharmony_ci 105653a5a1b3Sopenharmony_ci# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. 105753a5a1b3Sopenharmony_ci 105853a5a1b3Sopenharmony_ciDOCSET_PUBLISHER_NAME = Publisher 105953a5a1b3Sopenharmony_ci 106053a5a1b3Sopenharmony_ci# If the GENERATE_HTMLHELP tag is set to YES, additional index files 106153a5a1b3Sopenharmony_ci# will be generated that can be used as input for tools like the 106253a5a1b3Sopenharmony_ci# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 106353a5a1b3Sopenharmony_ci# of the generated HTML documentation. 106453a5a1b3Sopenharmony_ci 106553a5a1b3Sopenharmony_ciGENERATE_HTMLHELP = NO 106653a5a1b3Sopenharmony_ci 106753a5a1b3Sopenharmony_ci# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 106853a5a1b3Sopenharmony_ci# be used to specify the file name of the resulting .chm file. You 106953a5a1b3Sopenharmony_ci# can add a path in front of the file if the result should not be 107053a5a1b3Sopenharmony_ci# written to the html output directory. 107153a5a1b3Sopenharmony_ci 107253a5a1b3Sopenharmony_ciCHM_FILE = 107353a5a1b3Sopenharmony_ci 107453a5a1b3Sopenharmony_ci# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 107553a5a1b3Sopenharmony_ci# be used to specify the location (absolute path including file name) of 107653a5a1b3Sopenharmony_ci# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 107753a5a1b3Sopenharmony_ci# the HTML help compiler on the generated index.hhp. 107853a5a1b3Sopenharmony_ci 107953a5a1b3Sopenharmony_ciHHC_LOCATION = 108053a5a1b3Sopenharmony_ci 108153a5a1b3Sopenharmony_ci# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 108253a5a1b3Sopenharmony_ci# controls if a separate .chi index file is generated (YES) or that 108353a5a1b3Sopenharmony_ci# it should be included in the master .chm file (NO). 108453a5a1b3Sopenharmony_ci 108553a5a1b3Sopenharmony_ciGENERATE_CHI = NO 108653a5a1b3Sopenharmony_ci 108753a5a1b3Sopenharmony_ci# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 108853a5a1b3Sopenharmony_ci# is used to encode HtmlHelp index (hhk), content (hhc) and project file 108953a5a1b3Sopenharmony_ci# content. 109053a5a1b3Sopenharmony_ci 109153a5a1b3Sopenharmony_ciCHM_INDEX_ENCODING = 109253a5a1b3Sopenharmony_ci 109353a5a1b3Sopenharmony_ci# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 109453a5a1b3Sopenharmony_ci# controls whether a binary table of contents is generated (YES) or a 109553a5a1b3Sopenharmony_ci# normal table of contents (NO) in the .chm file. 109653a5a1b3Sopenharmony_ci 109753a5a1b3Sopenharmony_ciBINARY_TOC = NO 109853a5a1b3Sopenharmony_ci 109953a5a1b3Sopenharmony_ci# The TOC_EXPAND flag can be set to YES to add extra items for group members 110053a5a1b3Sopenharmony_ci# to the contents of the HTML help documentation and to the tree view. 110153a5a1b3Sopenharmony_ci 110253a5a1b3Sopenharmony_ciTOC_EXPAND = NO 110353a5a1b3Sopenharmony_ci 110453a5a1b3Sopenharmony_ci# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 110553a5a1b3Sopenharmony_ci# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 110653a5a1b3Sopenharmony_ci# that can be used as input for Qt's qhelpgenerator to generate a 110753a5a1b3Sopenharmony_ci# Qt Compressed Help (.qch) of the generated HTML documentation. 110853a5a1b3Sopenharmony_ci 110953a5a1b3Sopenharmony_ciGENERATE_QHP = NO 111053a5a1b3Sopenharmony_ci 111153a5a1b3Sopenharmony_ci# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 111253a5a1b3Sopenharmony_ci# be used to specify the file name of the resulting .qch file. 111353a5a1b3Sopenharmony_ci# The path specified is relative to the HTML output folder. 111453a5a1b3Sopenharmony_ci 111553a5a1b3Sopenharmony_ciQCH_FILE = 111653a5a1b3Sopenharmony_ci 111753a5a1b3Sopenharmony_ci# The QHP_NAMESPACE tag specifies the namespace to use when generating 111853a5a1b3Sopenharmony_ci# Qt Help Project output. For more information please see 111953a5a1b3Sopenharmony_ci# http://doc.trolltech.com/qthelpproject.html#namespace 112053a5a1b3Sopenharmony_ci 112153a5a1b3Sopenharmony_ciQHP_NAMESPACE = org.doxygen.Project 112253a5a1b3Sopenharmony_ci 112353a5a1b3Sopenharmony_ci# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 112453a5a1b3Sopenharmony_ci# Qt Help Project output. For more information please see 112553a5a1b3Sopenharmony_ci# http://doc.trolltech.com/qthelpproject.html#virtual-folders 112653a5a1b3Sopenharmony_ci 112753a5a1b3Sopenharmony_ciQHP_VIRTUAL_FOLDER = doc 112853a5a1b3Sopenharmony_ci 112953a5a1b3Sopenharmony_ci# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 113053a5a1b3Sopenharmony_ci# add. For more information please see 113153a5a1b3Sopenharmony_ci# http://doc.trolltech.com/qthelpproject.html#custom-filters 113253a5a1b3Sopenharmony_ci 113353a5a1b3Sopenharmony_ciQHP_CUST_FILTER_NAME = 113453a5a1b3Sopenharmony_ci 113553a5a1b3Sopenharmony_ci# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 113653a5a1b3Sopenharmony_ci# custom filter to add. For more information please see 113753a5a1b3Sopenharmony_ci# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> 113853a5a1b3Sopenharmony_ci# Qt Help Project / Custom Filters</a>. 113953a5a1b3Sopenharmony_ci 114053a5a1b3Sopenharmony_ciQHP_CUST_FILTER_ATTRS = 114153a5a1b3Sopenharmony_ci 114253a5a1b3Sopenharmony_ci# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 114353a5a1b3Sopenharmony_ci# project's 114453a5a1b3Sopenharmony_ci# filter section matches. 114553a5a1b3Sopenharmony_ci# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> 114653a5a1b3Sopenharmony_ci# Qt Help Project / Filter Attributes</a>. 114753a5a1b3Sopenharmony_ci 114853a5a1b3Sopenharmony_ciQHP_SECT_FILTER_ATTRS = 114953a5a1b3Sopenharmony_ci 115053a5a1b3Sopenharmony_ci# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 115153a5a1b3Sopenharmony_ci# be used to specify the location of Qt's qhelpgenerator. 115253a5a1b3Sopenharmony_ci# If non-empty doxygen will try to run qhelpgenerator on the generated 115353a5a1b3Sopenharmony_ci# .qhp file. 115453a5a1b3Sopenharmony_ci 115553a5a1b3Sopenharmony_ciQHG_LOCATION = 115653a5a1b3Sopenharmony_ci 115753a5a1b3Sopenharmony_ci# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 115853a5a1b3Sopenharmony_ci# will be generated, which together with the HTML files, form an Eclipse help 115953a5a1b3Sopenharmony_ci# plugin. To install this plugin and make it available under the help contents 116053a5a1b3Sopenharmony_ci# menu in Eclipse, the contents of the directory containing the HTML and XML 116153a5a1b3Sopenharmony_ci# files needs to be copied into the plugins directory of eclipse. The name of 116253a5a1b3Sopenharmony_ci# the directory within the plugins directory should be the same as 116353a5a1b3Sopenharmony_ci# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 116453a5a1b3Sopenharmony_ci# the help appears. 116553a5a1b3Sopenharmony_ci 116653a5a1b3Sopenharmony_ciGENERATE_ECLIPSEHELP = NO 116753a5a1b3Sopenharmony_ci 116853a5a1b3Sopenharmony_ci# A unique identifier for the eclipse help plugin. When installing the plugin 116953a5a1b3Sopenharmony_ci# the directory name containing the HTML and XML files should also have 117053a5a1b3Sopenharmony_ci# this name. 117153a5a1b3Sopenharmony_ci 117253a5a1b3Sopenharmony_ciECLIPSE_DOC_ID = org.doxygen.Project 117353a5a1b3Sopenharmony_ci 117453a5a1b3Sopenharmony_ci# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) 117553a5a1b3Sopenharmony_ci# at top of each HTML page. The value NO (the default) enables the index and 117653a5a1b3Sopenharmony_ci# the value YES disables it. Since the tabs have the same information as the 117753a5a1b3Sopenharmony_ci# navigation tree you can set this option to NO if you already set 117853a5a1b3Sopenharmony_ci# GENERATE_TREEVIEW to YES. 117953a5a1b3Sopenharmony_ci 118053a5a1b3Sopenharmony_ciDISABLE_INDEX = NO 118153a5a1b3Sopenharmony_ci 118253a5a1b3Sopenharmony_ci# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 118353a5a1b3Sopenharmony_ci# structure should be generated to display hierarchical information. 118453a5a1b3Sopenharmony_ci# If the tag value is set to YES, a side panel will be generated 118553a5a1b3Sopenharmony_ci# containing a tree-like index structure (just like the one that 118653a5a1b3Sopenharmony_ci# is generated for HTML Help). For this to work a browser that supports 118753a5a1b3Sopenharmony_ci# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 118853a5a1b3Sopenharmony_ci# Windows users are probably better off using the HTML help feature. 118953a5a1b3Sopenharmony_ci# Since the tree basically has the same information as the tab index you 119053a5a1b3Sopenharmony_ci# could consider to set DISABLE_INDEX to NO when enabling this option. 119153a5a1b3Sopenharmony_ci 119253a5a1b3Sopenharmony_ciGENERATE_TREEVIEW = YES 119353a5a1b3Sopenharmony_ci 119453a5a1b3Sopenharmony_ci# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 119553a5a1b3Sopenharmony_ci# (range [0,1..20]) that doxygen will group on one line in the generated HTML 119653a5a1b3Sopenharmony_ci# documentation. Note that a value of 0 will completely suppress the enum 119753a5a1b3Sopenharmony_ci# values from appearing in the overview section. 119853a5a1b3Sopenharmony_ci 119953a5a1b3Sopenharmony_ciENUM_VALUES_PER_LINE = 1 120053a5a1b3Sopenharmony_ci 120153a5a1b3Sopenharmony_ci# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 120253a5a1b3Sopenharmony_ci# used to set the initial width (in pixels) of the frame in which the tree 120353a5a1b3Sopenharmony_ci# is shown. 120453a5a1b3Sopenharmony_ci 120553a5a1b3Sopenharmony_ciTREEVIEW_WIDTH = 250 120653a5a1b3Sopenharmony_ci 120753a5a1b3Sopenharmony_ci# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 120853a5a1b3Sopenharmony_ci# links to external symbols imported via tag files in a separate window. 120953a5a1b3Sopenharmony_ci 121053a5a1b3Sopenharmony_ciEXT_LINKS_IN_WINDOW = NO 121153a5a1b3Sopenharmony_ci 121253a5a1b3Sopenharmony_ci# Use this tag to change the font size of Latex formulas included 121353a5a1b3Sopenharmony_ci# as images in the HTML documentation. The default is 10. Note that 121453a5a1b3Sopenharmony_ci# when you change the font size after a successful doxygen run you need 121553a5a1b3Sopenharmony_ci# to manually remove any form_*.png images from the HTML output directory 121653a5a1b3Sopenharmony_ci# to force them to be regenerated. 121753a5a1b3Sopenharmony_ci 121853a5a1b3Sopenharmony_ciFORMULA_FONTSIZE = 10 121953a5a1b3Sopenharmony_ci 122053a5a1b3Sopenharmony_ci# Use the FORMULA_TRANPARENT tag to determine whether or not the images 122153a5a1b3Sopenharmony_ci# generated for formulas are transparent PNGs. Transparent PNGs are 122253a5a1b3Sopenharmony_ci# not supported properly for IE 6.0, but are supported on all modern browsers. 122353a5a1b3Sopenharmony_ci# Note that when changing this option you need to delete any form_*.png files 122453a5a1b3Sopenharmony_ci# in the HTML output before the changes have effect. 122553a5a1b3Sopenharmony_ci 122653a5a1b3Sopenharmony_ciFORMULA_TRANSPARENT = YES 122753a5a1b3Sopenharmony_ci 122853a5a1b3Sopenharmony_ci# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 122953a5a1b3Sopenharmony_ci# (see http://www.mathjax.org) which uses client side Javascript for the 123053a5a1b3Sopenharmony_ci# rendering instead of using prerendered bitmaps. Use this if you do not 123153a5a1b3Sopenharmony_ci# have LaTeX installed or if you want to formulas look prettier in the HTML 123253a5a1b3Sopenharmony_ci# output. When enabled you may also need to install MathJax separately and 123353a5a1b3Sopenharmony_ci# configure the path to it using the MATHJAX_RELPATH option. 123453a5a1b3Sopenharmony_ci 123553a5a1b3Sopenharmony_ciUSE_MATHJAX = NO 123653a5a1b3Sopenharmony_ci 123753a5a1b3Sopenharmony_ci# When MathJax is enabled you can set the default output format to be used for 123853a5a1b3Sopenharmony_ci# thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and 123953a5a1b3Sopenharmony_ci# SVG. The default value is HTML-CSS, which is slower, but has the best 124053a5a1b3Sopenharmony_ci# compatibility. 124153a5a1b3Sopenharmony_ci 124253a5a1b3Sopenharmony_ciMATHJAX_FORMAT = HTML-CSS 124353a5a1b3Sopenharmony_ci 124453a5a1b3Sopenharmony_ci# When MathJax is enabled you need to specify the location relative to the 124553a5a1b3Sopenharmony_ci# HTML output directory using the MATHJAX_RELPATH option. The destination 124653a5a1b3Sopenharmony_ci# directory should contain the MathJax.js script. For instance, if the mathjax 124753a5a1b3Sopenharmony_ci# directory is located at the same level as the HTML output directory, then 124853a5a1b3Sopenharmony_ci# MATHJAX_RELPATH should be ../mathjax. The default value points to 124953a5a1b3Sopenharmony_ci# the MathJax Content Delivery Network so you can quickly see the result without 125053a5a1b3Sopenharmony_ci# installing MathJax. 125153a5a1b3Sopenharmony_ci# However, it is strongly recommended to install a local 125253a5a1b3Sopenharmony_ci# copy of MathJax from http://www.mathjax.org before deployment. 125353a5a1b3Sopenharmony_ci 125453a5a1b3Sopenharmony_ciMATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 125553a5a1b3Sopenharmony_ci 125653a5a1b3Sopenharmony_ci# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension 125753a5a1b3Sopenharmony_ci# names that should be enabled during MathJax rendering. 125853a5a1b3Sopenharmony_ci 125953a5a1b3Sopenharmony_ciMATHJAX_EXTENSIONS = 126053a5a1b3Sopenharmony_ci 126153a5a1b3Sopenharmony_ci# When the SEARCHENGINE tag is enabled doxygen will generate a search box 126253a5a1b3Sopenharmony_ci# for the HTML output. The underlying search engine uses javascript 126353a5a1b3Sopenharmony_ci# and DHTML and should work on any modern browser. Note that when using 126453a5a1b3Sopenharmony_ci# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 126553a5a1b3Sopenharmony_ci# (GENERATE_DOCSET) there is already a search function so this one should 126653a5a1b3Sopenharmony_ci# typically be disabled. For large projects the javascript based search engine 126753a5a1b3Sopenharmony_ci# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 126853a5a1b3Sopenharmony_ci 126953a5a1b3Sopenharmony_ciSEARCHENGINE = NO 127053a5a1b3Sopenharmony_ci 127153a5a1b3Sopenharmony_ci# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 127253a5a1b3Sopenharmony_ci# implemented using a web server instead of a web client using Javascript. 127353a5a1b3Sopenharmony_ci# There are two flavours of web server based search depending on the 127453a5a1b3Sopenharmony_ci# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for 127553a5a1b3Sopenharmony_ci# searching and an index file used by the script. When EXTERNAL_SEARCH is 127653a5a1b3Sopenharmony_ci# enabled the indexing and searching needs to be provided by external tools. 127753a5a1b3Sopenharmony_ci# See the manual for details. 127853a5a1b3Sopenharmony_ci 127953a5a1b3Sopenharmony_ciSERVER_BASED_SEARCH = NO 128053a5a1b3Sopenharmony_ci 128153a5a1b3Sopenharmony_ci# When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP 128253a5a1b3Sopenharmony_ci# script for searching. Instead the search results are written to an XML file 128353a5a1b3Sopenharmony_ci# which needs to be processed by an external indexer. Doxygen will invoke an 128453a5a1b3Sopenharmony_ci# external search engine pointed to by the SEARCHENGINE_URL option to obtain 128553a5a1b3Sopenharmony_ci# the search results. Doxygen ships with an example indexer (doxyindexer) and 128653a5a1b3Sopenharmony_ci# search engine (doxysearch.cgi) which are based on the open source search engine 128753a5a1b3Sopenharmony_ci# library Xapian. See the manual for configuration details. 128853a5a1b3Sopenharmony_ci 128953a5a1b3Sopenharmony_ciEXTERNAL_SEARCH = NO 129053a5a1b3Sopenharmony_ci 129153a5a1b3Sopenharmony_ci# The SEARCHENGINE_URL should point to a search engine hosted by a web server 129253a5a1b3Sopenharmony_ci# which will returned the search results when EXTERNAL_SEARCH is enabled. 129353a5a1b3Sopenharmony_ci# Doxygen ships with an example search engine (doxysearch) which is based on 129453a5a1b3Sopenharmony_ci# the open source search engine library Xapian. See the manual for configuration 129553a5a1b3Sopenharmony_ci# details. 129653a5a1b3Sopenharmony_ci 129753a5a1b3Sopenharmony_ciSEARCHENGINE_URL = 129853a5a1b3Sopenharmony_ci 129953a5a1b3Sopenharmony_ci# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed 130053a5a1b3Sopenharmony_ci# search data is written to a file for indexing by an external tool. With the 130153a5a1b3Sopenharmony_ci# SEARCHDATA_FILE tag the name of this file can be specified. 130253a5a1b3Sopenharmony_ci 130353a5a1b3Sopenharmony_ciSEARCHDATA_FILE = searchdata.xml 130453a5a1b3Sopenharmony_ci 130553a5a1b3Sopenharmony_ci# When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the 130653a5a1b3Sopenharmony_ci# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is 130753a5a1b3Sopenharmony_ci# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple 130853a5a1b3Sopenharmony_ci# projects and redirect the results back to the right project. 130953a5a1b3Sopenharmony_ci 131053a5a1b3Sopenharmony_ciEXTERNAL_SEARCH_ID = 131153a5a1b3Sopenharmony_ci 131253a5a1b3Sopenharmony_ci# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen 131353a5a1b3Sopenharmony_ci# projects other than the one defined by this configuration file, but that are 131453a5a1b3Sopenharmony_ci# all added to the same external search index. Each project needs to have a 131553a5a1b3Sopenharmony_ci# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id 131653a5a1b3Sopenharmony_ci# of to a relative location where the documentation can be found. 131753a5a1b3Sopenharmony_ci# The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ... 131853a5a1b3Sopenharmony_ci 131953a5a1b3Sopenharmony_ciEXTRA_SEARCH_MAPPINGS = 132053a5a1b3Sopenharmony_ci 132153a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 132253a5a1b3Sopenharmony_ci# configuration options related to the LaTeX output 132353a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 132453a5a1b3Sopenharmony_ci 132553a5a1b3Sopenharmony_ci# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 132653a5a1b3Sopenharmony_ci# generate Latex output. 132753a5a1b3Sopenharmony_ci 132853a5a1b3Sopenharmony_ciGENERATE_LATEX = NO 132953a5a1b3Sopenharmony_ci 133053a5a1b3Sopenharmony_ci# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 133153a5a1b3Sopenharmony_ci# If a relative path is entered the value of OUTPUT_DIRECTORY will be 133253a5a1b3Sopenharmony_ci# put in front of it. If left blank `latex' will be used as the default path. 133353a5a1b3Sopenharmony_ci 133453a5a1b3Sopenharmony_ciLATEX_OUTPUT = latex 133553a5a1b3Sopenharmony_ci 133653a5a1b3Sopenharmony_ci# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 133753a5a1b3Sopenharmony_ci# invoked. If left blank `latex' will be used as the default command name. 133853a5a1b3Sopenharmony_ci# Note that when enabling USE_PDFLATEX this option is only used for 133953a5a1b3Sopenharmony_ci# generating bitmaps for formulas in the HTML output, but not in the 134053a5a1b3Sopenharmony_ci# Makefile that is written to the output directory. 134153a5a1b3Sopenharmony_ci 134253a5a1b3Sopenharmony_ciLATEX_CMD_NAME = latex 134353a5a1b3Sopenharmony_ci 134453a5a1b3Sopenharmony_ci# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 134553a5a1b3Sopenharmony_ci# generate index for LaTeX. If left blank `makeindex' will be used as the 134653a5a1b3Sopenharmony_ci# default command name. 134753a5a1b3Sopenharmony_ci 134853a5a1b3Sopenharmony_ciMAKEINDEX_CMD_NAME = makeindex 134953a5a1b3Sopenharmony_ci 135053a5a1b3Sopenharmony_ci# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 135153a5a1b3Sopenharmony_ci# LaTeX documents. This may be useful for small projects and may help to 135253a5a1b3Sopenharmony_ci# save some trees in general. 135353a5a1b3Sopenharmony_ci 135453a5a1b3Sopenharmony_ciCOMPACT_LATEX = NO 135553a5a1b3Sopenharmony_ci 135653a5a1b3Sopenharmony_ci# The PAPER_TYPE tag can be used to set the paper type that is used 135753a5a1b3Sopenharmony_ci# by the printer. Possible values are: a4, letter, legal and 135853a5a1b3Sopenharmony_ci# executive. If left blank a4wide will be used. 135953a5a1b3Sopenharmony_ci 136053a5a1b3Sopenharmony_ciPAPER_TYPE = a4wide 136153a5a1b3Sopenharmony_ci 136253a5a1b3Sopenharmony_ci# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 136353a5a1b3Sopenharmony_ci# packages that should be included in the LaTeX output. 136453a5a1b3Sopenharmony_ci 136553a5a1b3Sopenharmony_ciEXTRA_PACKAGES = 136653a5a1b3Sopenharmony_ci 136753a5a1b3Sopenharmony_ci# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 136853a5a1b3Sopenharmony_ci# the generated latex document. The header should contain everything until 136953a5a1b3Sopenharmony_ci# the first chapter. If it is left blank doxygen will generate a 137053a5a1b3Sopenharmony_ci# standard header. Notice: only use this tag if you know what you are doing! 137153a5a1b3Sopenharmony_ci 137253a5a1b3Sopenharmony_ciLATEX_HEADER = 137353a5a1b3Sopenharmony_ci 137453a5a1b3Sopenharmony_ci# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for 137553a5a1b3Sopenharmony_ci# the generated latex document. The footer should contain everything after 137653a5a1b3Sopenharmony_ci# the last chapter. If it is left blank doxygen will generate a 137753a5a1b3Sopenharmony_ci# standard footer. Notice: only use this tag if you know what you are doing! 137853a5a1b3Sopenharmony_ci 137953a5a1b3Sopenharmony_ciLATEX_FOOTER = 138053a5a1b3Sopenharmony_ci 138153a5a1b3Sopenharmony_ci# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 138253a5a1b3Sopenharmony_ci# is prepared for conversion to pdf (using ps2pdf). The pdf file will 138353a5a1b3Sopenharmony_ci# contain links (just like the HTML output) instead of page references 138453a5a1b3Sopenharmony_ci# This makes the output suitable for online browsing using a pdf viewer. 138553a5a1b3Sopenharmony_ci 138653a5a1b3Sopenharmony_ciPDF_HYPERLINKS = NO 138753a5a1b3Sopenharmony_ci 138853a5a1b3Sopenharmony_ci# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 138953a5a1b3Sopenharmony_ci# plain latex in the generated Makefile. Set this option to YES to get a 139053a5a1b3Sopenharmony_ci# higher quality PDF documentation. 139153a5a1b3Sopenharmony_ci 139253a5a1b3Sopenharmony_ciUSE_PDFLATEX = NO 139353a5a1b3Sopenharmony_ci 139453a5a1b3Sopenharmony_ci# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 139553a5a1b3Sopenharmony_ci# command to the generated LaTeX files. This will instruct LaTeX to keep 139653a5a1b3Sopenharmony_ci# running if errors occur, instead of asking the user for help. 139753a5a1b3Sopenharmony_ci# This option is also used when generating formulas in HTML. 139853a5a1b3Sopenharmony_ci 139953a5a1b3Sopenharmony_ciLATEX_BATCHMODE = NO 140053a5a1b3Sopenharmony_ci 140153a5a1b3Sopenharmony_ci# If LATEX_HIDE_INDICES is set to YES then doxygen will not 140253a5a1b3Sopenharmony_ci# include the index chapters (such as File Index, Compound Index, etc.) 140353a5a1b3Sopenharmony_ci# in the output. 140453a5a1b3Sopenharmony_ci 140553a5a1b3Sopenharmony_ciLATEX_HIDE_INDICES = NO 140653a5a1b3Sopenharmony_ci 140753a5a1b3Sopenharmony_ci# If LATEX_SOURCE_CODE is set to YES then doxygen will include 140853a5a1b3Sopenharmony_ci# source code with syntax highlighting in the LaTeX output. 140953a5a1b3Sopenharmony_ci# Note that which sources are shown also depends on other settings 141053a5a1b3Sopenharmony_ci# such as SOURCE_BROWSER. 141153a5a1b3Sopenharmony_ci 141253a5a1b3Sopenharmony_ciLATEX_SOURCE_CODE = NO 141353a5a1b3Sopenharmony_ci 141453a5a1b3Sopenharmony_ci# The LATEX_BIB_STYLE tag can be used to specify the style to use for the 141553a5a1b3Sopenharmony_ci# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See 141653a5a1b3Sopenharmony_ci# http://en.wikipedia.org/wiki/BibTeX for more info. 141753a5a1b3Sopenharmony_ci 141853a5a1b3Sopenharmony_ciLATEX_BIB_STYLE = plain 141953a5a1b3Sopenharmony_ci 142053a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 142153a5a1b3Sopenharmony_ci# configuration options related to the RTF output 142253a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 142353a5a1b3Sopenharmony_ci 142453a5a1b3Sopenharmony_ci# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 142553a5a1b3Sopenharmony_ci# The RTF output is optimized for Word 97 and may not look very pretty with 142653a5a1b3Sopenharmony_ci# other RTF readers or editors. 142753a5a1b3Sopenharmony_ci 142853a5a1b3Sopenharmony_ciGENERATE_RTF = NO 142953a5a1b3Sopenharmony_ci 143053a5a1b3Sopenharmony_ci# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 143153a5a1b3Sopenharmony_ci# If a relative path is entered the value of OUTPUT_DIRECTORY will be 143253a5a1b3Sopenharmony_ci# put in front of it. If left blank `rtf' will be used as the default path. 143353a5a1b3Sopenharmony_ci 143453a5a1b3Sopenharmony_ciRTF_OUTPUT = rtf 143553a5a1b3Sopenharmony_ci 143653a5a1b3Sopenharmony_ci# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 143753a5a1b3Sopenharmony_ci# RTF documents. This may be useful for small projects and may help to 143853a5a1b3Sopenharmony_ci# save some trees in general. 143953a5a1b3Sopenharmony_ci 144053a5a1b3Sopenharmony_ciCOMPACT_RTF = NO 144153a5a1b3Sopenharmony_ci 144253a5a1b3Sopenharmony_ci# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 144353a5a1b3Sopenharmony_ci# will contain hyperlink fields. The RTF file will 144453a5a1b3Sopenharmony_ci# contain links (just like the HTML output) instead of page references. 144553a5a1b3Sopenharmony_ci# This makes the output suitable for online browsing using WORD or other 144653a5a1b3Sopenharmony_ci# programs which support those fields. 144753a5a1b3Sopenharmony_ci# Note: wordpad (write) and others do not support links. 144853a5a1b3Sopenharmony_ci 144953a5a1b3Sopenharmony_ciRTF_HYPERLINKS = NO 145053a5a1b3Sopenharmony_ci 145153a5a1b3Sopenharmony_ci# Load style sheet definitions from file. Syntax is similar to doxygen's 145253a5a1b3Sopenharmony_ci# config file, i.e. a series of assignments. You only have to provide 145353a5a1b3Sopenharmony_ci# replacements, missing definitions are set to their default value. 145453a5a1b3Sopenharmony_ci 145553a5a1b3Sopenharmony_ciRTF_STYLESHEET_FILE = 145653a5a1b3Sopenharmony_ci 145753a5a1b3Sopenharmony_ci# Set optional variables used in the generation of an rtf document. 145853a5a1b3Sopenharmony_ci# Syntax is similar to doxygen's config file. 145953a5a1b3Sopenharmony_ci 146053a5a1b3Sopenharmony_ciRTF_EXTENSIONS_FILE = 146153a5a1b3Sopenharmony_ci 146253a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 146353a5a1b3Sopenharmony_ci# configuration options related to the man page output 146453a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 146553a5a1b3Sopenharmony_ci 146653a5a1b3Sopenharmony_ci# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 146753a5a1b3Sopenharmony_ci# generate man pages 146853a5a1b3Sopenharmony_ci 146953a5a1b3Sopenharmony_ciGENERATE_MAN = NO 147053a5a1b3Sopenharmony_ci 147153a5a1b3Sopenharmony_ci# The MAN_OUTPUT tag is used to specify where the man pages will be put. 147253a5a1b3Sopenharmony_ci# If a relative path is entered the value of OUTPUT_DIRECTORY will be 147353a5a1b3Sopenharmony_ci# put in front of it. If left blank `man' will be used as the default path. 147453a5a1b3Sopenharmony_ci 147553a5a1b3Sopenharmony_ciMAN_OUTPUT = man 147653a5a1b3Sopenharmony_ci 147753a5a1b3Sopenharmony_ci# The MAN_EXTENSION tag determines the extension that is added to 147853a5a1b3Sopenharmony_ci# the generated man pages (default is the subroutine's section .3) 147953a5a1b3Sopenharmony_ci 148053a5a1b3Sopenharmony_ciMAN_EXTENSION = .3 148153a5a1b3Sopenharmony_ci 148253a5a1b3Sopenharmony_ci# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 148353a5a1b3Sopenharmony_ci# then it will generate one additional man file for each entity 148453a5a1b3Sopenharmony_ci# documented in the real man page(s). These additional files 148553a5a1b3Sopenharmony_ci# only source the real man page, but without them the man command 148653a5a1b3Sopenharmony_ci# would be unable to find the correct page. The default is NO. 148753a5a1b3Sopenharmony_ci 148853a5a1b3Sopenharmony_ciMAN_LINKS = NO 148953a5a1b3Sopenharmony_ci 149053a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 149153a5a1b3Sopenharmony_ci# configuration options related to the XML output 149253a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 149353a5a1b3Sopenharmony_ci 149453a5a1b3Sopenharmony_ci# If the GENERATE_XML tag is set to YES Doxygen will 149553a5a1b3Sopenharmony_ci# generate an XML file that captures the structure of 149653a5a1b3Sopenharmony_ci# the code including all documentation. 149753a5a1b3Sopenharmony_ci 149853a5a1b3Sopenharmony_ciGENERATE_XML = NO 149953a5a1b3Sopenharmony_ci 150053a5a1b3Sopenharmony_ci# The XML_OUTPUT tag is used to specify where the XML pages will be put. 150153a5a1b3Sopenharmony_ci# If a relative path is entered the value of OUTPUT_DIRECTORY will be 150253a5a1b3Sopenharmony_ci# put in front of it. If left blank `xml' will be used as the default path. 150353a5a1b3Sopenharmony_ci 150453a5a1b3Sopenharmony_ciXML_OUTPUT = xml 150553a5a1b3Sopenharmony_ci 150653a5a1b3Sopenharmony_ci# The XML_SCHEMA tag can be used to specify an XML schema, 150753a5a1b3Sopenharmony_ci# which can be used by a validating XML parser to check the 150853a5a1b3Sopenharmony_ci# syntax of the XML files. 150953a5a1b3Sopenharmony_ci 151053a5a1b3Sopenharmony_ciXML_SCHEMA = 151153a5a1b3Sopenharmony_ci 151253a5a1b3Sopenharmony_ci# The XML_DTD tag can be used to specify an XML DTD, 151353a5a1b3Sopenharmony_ci# which can be used by a validating XML parser to check the 151453a5a1b3Sopenharmony_ci# syntax of the XML files. 151553a5a1b3Sopenharmony_ci 151653a5a1b3Sopenharmony_ciXML_DTD = 151753a5a1b3Sopenharmony_ci 151853a5a1b3Sopenharmony_ci# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 151953a5a1b3Sopenharmony_ci# dump the program listings (including syntax highlighting 152053a5a1b3Sopenharmony_ci# and cross-referencing information) to the XML output. Note that 152153a5a1b3Sopenharmony_ci# enabling this will significantly increase the size of the XML output. 152253a5a1b3Sopenharmony_ci 152353a5a1b3Sopenharmony_ciXML_PROGRAMLISTING = YES 152453a5a1b3Sopenharmony_ci 152553a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 152653a5a1b3Sopenharmony_ci# configuration options for the AutoGen Definitions output 152753a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 152853a5a1b3Sopenharmony_ci 152953a5a1b3Sopenharmony_ci# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 153053a5a1b3Sopenharmony_ci# generate an AutoGen Definitions (see autogen.sf.net) file 153153a5a1b3Sopenharmony_ci# that captures the structure of the code including all 153253a5a1b3Sopenharmony_ci# documentation. Note that this feature is still experimental 153353a5a1b3Sopenharmony_ci# and incomplete at the moment. 153453a5a1b3Sopenharmony_ci 153553a5a1b3Sopenharmony_ciGENERATE_AUTOGEN_DEF = NO 153653a5a1b3Sopenharmony_ci 153753a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 153853a5a1b3Sopenharmony_ci# configuration options related to the Perl module output 153953a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 154053a5a1b3Sopenharmony_ci 154153a5a1b3Sopenharmony_ci# If the GENERATE_PERLMOD tag is set to YES Doxygen will 154253a5a1b3Sopenharmony_ci# generate a Perl module file that captures the structure of 154353a5a1b3Sopenharmony_ci# the code including all documentation. Note that this 154453a5a1b3Sopenharmony_ci# feature is still experimental and incomplete at the 154553a5a1b3Sopenharmony_ci# moment. 154653a5a1b3Sopenharmony_ci 154753a5a1b3Sopenharmony_ciGENERATE_PERLMOD = NO 154853a5a1b3Sopenharmony_ci 154953a5a1b3Sopenharmony_ci# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 155053a5a1b3Sopenharmony_ci# the necessary Makefile rules, Perl scripts and LaTeX code to be able 155153a5a1b3Sopenharmony_ci# to generate PDF and DVI output from the Perl module output. 155253a5a1b3Sopenharmony_ci 155353a5a1b3Sopenharmony_ciPERLMOD_LATEX = NO 155453a5a1b3Sopenharmony_ci 155553a5a1b3Sopenharmony_ci# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 155653a5a1b3Sopenharmony_ci# nicely formatted so it can be parsed by a human reader. 155753a5a1b3Sopenharmony_ci# This is useful 155853a5a1b3Sopenharmony_ci# if you want to understand what is going on. 155953a5a1b3Sopenharmony_ci# On the other hand, if this 156053a5a1b3Sopenharmony_ci# tag is set to NO the size of the Perl module output will be much smaller 156153a5a1b3Sopenharmony_ci# and Perl will parse it just the same. 156253a5a1b3Sopenharmony_ci 156353a5a1b3Sopenharmony_ciPERLMOD_PRETTY = YES 156453a5a1b3Sopenharmony_ci 156553a5a1b3Sopenharmony_ci# The names of the make variables in the generated doxyrules.make file 156653a5a1b3Sopenharmony_ci# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 156753a5a1b3Sopenharmony_ci# This is useful so different doxyrules.make files included by the same 156853a5a1b3Sopenharmony_ci# Makefile don't overwrite each other's variables. 156953a5a1b3Sopenharmony_ci 157053a5a1b3Sopenharmony_ciPERLMOD_MAKEVAR_PREFIX = 157153a5a1b3Sopenharmony_ci 157253a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 157353a5a1b3Sopenharmony_ci# Configuration options related to the preprocessor 157453a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 157553a5a1b3Sopenharmony_ci 157653a5a1b3Sopenharmony_ci# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 157753a5a1b3Sopenharmony_ci# evaluate all C-preprocessor directives found in the sources and include 157853a5a1b3Sopenharmony_ci# files. 157953a5a1b3Sopenharmony_ci 158053a5a1b3Sopenharmony_ciENABLE_PREPROCESSING = YES 158153a5a1b3Sopenharmony_ci 158253a5a1b3Sopenharmony_ci# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 158353a5a1b3Sopenharmony_ci# names in the source code. If set to NO (the default) only conditional 158453a5a1b3Sopenharmony_ci# compilation will be performed. Macro expansion can be done in a controlled 158553a5a1b3Sopenharmony_ci# way by setting EXPAND_ONLY_PREDEF to YES. 158653a5a1b3Sopenharmony_ci 158753a5a1b3Sopenharmony_ciMACRO_EXPANSION = YES 158853a5a1b3Sopenharmony_ci 158953a5a1b3Sopenharmony_ci# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 159053a5a1b3Sopenharmony_ci# then the macro expansion is limited to the macros specified with the 159153a5a1b3Sopenharmony_ci# PREDEFINED and EXPAND_AS_DEFINED tags. 159253a5a1b3Sopenharmony_ci 159353a5a1b3Sopenharmony_ciEXPAND_ONLY_PREDEF = YES 159453a5a1b3Sopenharmony_ci 159553a5a1b3Sopenharmony_ci# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 159653a5a1b3Sopenharmony_ci# pointed to by INCLUDE_PATH will be searched when a #include is found. 159753a5a1b3Sopenharmony_ci 159853a5a1b3Sopenharmony_ciSEARCH_INCLUDES = YES 159953a5a1b3Sopenharmony_ci 160053a5a1b3Sopenharmony_ci# The INCLUDE_PATH tag can be used to specify one or more directories that 160153a5a1b3Sopenharmony_ci# contain include files that are not input files but should be processed by 160253a5a1b3Sopenharmony_ci# the preprocessor. 160353a5a1b3Sopenharmony_ci 160453a5a1b3Sopenharmony_ciINCLUDE_PATH = 160553a5a1b3Sopenharmony_ci 160653a5a1b3Sopenharmony_ci# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 160753a5a1b3Sopenharmony_ci# patterns (like *.h and *.hpp) to filter out the header-files in the 160853a5a1b3Sopenharmony_ci# directories. If left blank, the patterns specified with FILE_PATTERNS will 160953a5a1b3Sopenharmony_ci# be used. 161053a5a1b3Sopenharmony_ci 161153a5a1b3Sopenharmony_ciINCLUDE_FILE_PATTERNS = 161253a5a1b3Sopenharmony_ci 161353a5a1b3Sopenharmony_ci# The PREDEFINED tag can be used to specify one or more macro names that 161453a5a1b3Sopenharmony_ci# are defined before the preprocessor is started (similar to the -D option of 161553a5a1b3Sopenharmony_ci# gcc). The argument of the tag is a list of macros of the form: name 161653a5a1b3Sopenharmony_ci# or name=definition (no spaces). If the definition and the = are 161753a5a1b3Sopenharmony_ci# omitted =1 is assumed. To prevent a macro definition from being 161853a5a1b3Sopenharmony_ci# undefined via #undef or recursively expanded use the := operator 161953a5a1b3Sopenharmony_ci# instead of the = operator. 162053a5a1b3Sopenharmony_ci 162153a5a1b3Sopenharmony_ciPREDEFINED = PA_C_DECL_BEGIN= \ 162253a5a1b3Sopenharmony_ci PA_C_DECL_END= 162353a5a1b3Sopenharmony_ci 162453a5a1b3Sopenharmony_ci# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 162553a5a1b3Sopenharmony_ci# this tag can be used to specify a list of macro names that should be expanded. 162653a5a1b3Sopenharmony_ci# The macro definition that is found in the sources will be used. 162753a5a1b3Sopenharmony_ci# Use the PREDEFINED tag if you want to use a different macro definition that 162853a5a1b3Sopenharmony_ci# overrules the definition found in the source code. 162953a5a1b3Sopenharmony_ci 163053a5a1b3Sopenharmony_ciEXPAND_AS_DEFINED = 163153a5a1b3Sopenharmony_ci 163253a5a1b3Sopenharmony_ci# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 163353a5a1b3Sopenharmony_ci# doxygen's preprocessor will remove all references to function-like macros 163453a5a1b3Sopenharmony_ci# that are alone on a line, have an all uppercase name, and do not end with a 163553a5a1b3Sopenharmony_ci# semicolon, because these will confuse the parser if not removed. 163653a5a1b3Sopenharmony_ci 163753a5a1b3Sopenharmony_ciSKIP_FUNCTION_MACROS = YES 163853a5a1b3Sopenharmony_ci 163953a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 164053a5a1b3Sopenharmony_ci# Configuration::additions related to external references 164153a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 164253a5a1b3Sopenharmony_ci 164353a5a1b3Sopenharmony_ci# The TAGFILES option can be used to specify one or more tagfiles. For each 164453a5a1b3Sopenharmony_ci# tag file the location of the external documentation should be added. The 164553a5a1b3Sopenharmony_ci# format of a tag file without this location is as follows: 164653a5a1b3Sopenharmony_ci# 164753a5a1b3Sopenharmony_ci# TAGFILES = file1 file2 ... 164853a5a1b3Sopenharmony_ci# Adding location for the tag files is done as follows: 164953a5a1b3Sopenharmony_ci# 165053a5a1b3Sopenharmony_ci# TAGFILES = file1=loc1 "file2 = loc2" ... 165153a5a1b3Sopenharmony_ci# where "loc1" and "loc2" can be relative or absolute paths 165253a5a1b3Sopenharmony_ci# or URLs. Note that each tag file must have a unique name (where the name does 165353a5a1b3Sopenharmony_ci# NOT include the path). If a tag file is not located in the directory in which 165453a5a1b3Sopenharmony_ci# doxygen is run, you must also specify the path to the tagfile here. 165553a5a1b3Sopenharmony_ci 165653a5a1b3Sopenharmony_ciTAGFILES = 165753a5a1b3Sopenharmony_ci 165853a5a1b3Sopenharmony_ci# When a file name is specified after GENERATE_TAGFILE, doxygen will create 165953a5a1b3Sopenharmony_ci# a tag file that is based on the input files it reads. 166053a5a1b3Sopenharmony_ci 166153a5a1b3Sopenharmony_ciGENERATE_TAGFILE = 166253a5a1b3Sopenharmony_ci 166353a5a1b3Sopenharmony_ci# If the ALLEXTERNALS tag is set to YES all external classes will be listed 166453a5a1b3Sopenharmony_ci# in the class index. If set to NO only the inherited external classes 166553a5a1b3Sopenharmony_ci# will be listed. 166653a5a1b3Sopenharmony_ci 166753a5a1b3Sopenharmony_ciALLEXTERNALS = NO 166853a5a1b3Sopenharmony_ci 166953a5a1b3Sopenharmony_ci# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 167053a5a1b3Sopenharmony_ci# in the modules index. If set to NO, only the current project's groups will 167153a5a1b3Sopenharmony_ci# be listed. 167253a5a1b3Sopenharmony_ci 167353a5a1b3Sopenharmony_ciEXTERNAL_GROUPS = YES 167453a5a1b3Sopenharmony_ci 167553a5a1b3Sopenharmony_ci# The PERL_PATH should be the absolute path and name of the perl script 167653a5a1b3Sopenharmony_ci# interpreter (i.e. the result of `which perl'). 167753a5a1b3Sopenharmony_ci 167853a5a1b3Sopenharmony_ciPERL_PATH = /usr/bin/perl 167953a5a1b3Sopenharmony_ci 168053a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 168153a5a1b3Sopenharmony_ci# Configuration options related to the dot tool 168253a5a1b3Sopenharmony_ci#--------------------------------------------------------------------------- 168353a5a1b3Sopenharmony_ci 168453a5a1b3Sopenharmony_ci# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 168553a5a1b3Sopenharmony_ci# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 168653a5a1b3Sopenharmony_ci# or super classes. Setting the tag to NO turns the diagrams off. Note that 168753a5a1b3Sopenharmony_ci# this option also works with HAVE_DOT disabled, but it is recommended to 168853a5a1b3Sopenharmony_ci# install and use dot, since it yields more powerful graphs. 168953a5a1b3Sopenharmony_ci 169053a5a1b3Sopenharmony_ciCLASS_DIAGRAMS = YES 169153a5a1b3Sopenharmony_ci 169253a5a1b3Sopenharmony_ci# You can define message sequence charts within doxygen comments using the \msc 169353a5a1b3Sopenharmony_ci# command. Doxygen will then run the mscgen tool (see 169453a5a1b3Sopenharmony_ci# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 169553a5a1b3Sopenharmony_ci# documentation. The MSCGEN_PATH tag allows you to specify the directory where 169653a5a1b3Sopenharmony_ci# the mscgen tool resides. If left empty the tool is assumed to be found in the 169753a5a1b3Sopenharmony_ci# default search path. 169853a5a1b3Sopenharmony_ci 169953a5a1b3Sopenharmony_ciMSCGEN_PATH = 170053a5a1b3Sopenharmony_ci 170153a5a1b3Sopenharmony_ci# If set to YES, the inheritance and collaboration graphs will hide 170253a5a1b3Sopenharmony_ci# inheritance and usage relations if the target is undocumented 170353a5a1b3Sopenharmony_ci# or is not a class. 170453a5a1b3Sopenharmony_ci 170553a5a1b3Sopenharmony_ciHIDE_UNDOC_RELATIONS = YES 170653a5a1b3Sopenharmony_ci 170753a5a1b3Sopenharmony_ci# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 170853a5a1b3Sopenharmony_ci# available from the path. This tool is part of Graphviz, a graph visualization 170953a5a1b3Sopenharmony_ci# toolkit from AT&T and Lucent Bell Labs. The other options in this section 171053a5a1b3Sopenharmony_ci# have no effect if this option is set to NO (the default) 171153a5a1b3Sopenharmony_ci 171253a5a1b3Sopenharmony_ciHAVE_DOT = NO 171353a5a1b3Sopenharmony_ci 171453a5a1b3Sopenharmony_ci# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 171553a5a1b3Sopenharmony_ci# allowed to run in parallel. When set to 0 (the default) doxygen will 171653a5a1b3Sopenharmony_ci# base this on the number of processors available in the system. You can set it 171753a5a1b3Sopenharmony_ci# explicitly to a value larger than 0 to get control over the balance 171853a5a1b3Sopenharmony_ci# between CPU load and processing speed. 171953a5a1b3Sopenharmony_ci 172053a5a1b3Sopenharmony_ciDOT_NUM_THREADS = 0 172153a5a1b3Sopenharmony_ci 172253a5a1b3Sopenharmony_ci# By default doxygen will use the Helvetica font for all dot files that 172353a5a1b3Sopenharmony_ci# doxygen generates. When you want a differently looking font you can specify 172453a5a1b3Sopenharmony_ci# the font name using DOT_FONTNAME. You need to make sure dot is able to find 172553a5a1b3Sopenharmony_ci# the font, which can be done by putting it in a standard location or by setting 172653a5a1b3Sopenharmony_ci# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the 172753a5a1b3Sopenharmony_ci# directory containing the font. 172853a5a1b3Sopenharmony_ci 172953a5a1b3Sopenharmony_ciDOT_FONTNAME = Helvetica 173053a5a1b3Sopenharmony_ci 173153a5a1b3Sopenharmony_ci# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 173253a5a1b3Sopenharmony_ci# The default size is 10pt. 173353a5a1b3Sopenharmony_ci 173453a5a1b3Sopenharmony_ciDOT_FONTSIZE = 10 173553a5a1b3Sopenharmony_ci 173653a5a1b3Sopenharmony_ci# By default doxygen will tell dot to use the Helvetica font. 173753a5a1b3Sopenharmony_ci# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to 173853a5a1b3Sopenharmony_ci# set the path where dot can find it. 173953a5a1b3Sopenharmony_ci 174053a5a1b3Sopenharmony_ciDOT_FONTPATH = 174153a5a1b3Sopenharmony_ci 174253a5a1b3Sopenharmony_ci# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 174353a5a1b3Sopenharmony_ci# will generate a graph for each documented class showing the direct and 174453a5a1b3Sopenharmony_ci# indirect inheritance relations. Setting this tag to YES will force the 174553a5a1b3Sopenharmony_ci# CLASS_DIAGRAMS tag to NO. 174653a5a1b3Sopenharmony_ci 174753a5a1b3Sopenharmony_ciCLASS_GRAPH = YES 174853a5a1b3Sopenharmony_ci 174953a5a1b3Sopenharmony_ci# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 175053a5a1b3Sopenharmony_ci# will generate a graph for each documented class showing the direct and 175153a5a1b3Sopenharmony_ci# indirect implementation dependencies (inheritance, containment, and 175253a5a1b3Sopenharmony_ci# class references variables) of the class with other documented classes. 175353a5a1b3Sopenharmony_ci 175453a5a1b3Sopenharmony_ciCOLLABORATION_GRAPH = YES 175553a5a1b3Sopenharmony_ci 175653a5a1b3Sopenharmony_ci# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 175753a5a1b3Sopenharmony_ci# will generate a graph for groups, showing the direct groups dependencies 175853a5a1b3Sopenharmony_ci 175953a5a1b3Sopenharmony_ciGROUP_GRAPHS = YES 176053a5a1b3Sopenharmony_ci 176153a5a1b3Sopenharmony_ci# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 176253a5a1b3Sopenharmony_ci# collaboration diagrams in a style similar to the OMG's Unified Modeling 176353a5a1b3Sopenharmony_ci# Language. 176453a5a1b3Sopenharmony_ci 176553a5a1b3Sopenharmony_ciUML_LOOK = NO 176653a5a1b3Sopenharmony_ci 176753a5a1b3Sopenharmony_ci# If the UML_LOOK tag is enabled, the fields and methods are shown inside 176853a5a1b3Sopenharmony_ci# the class node. If there are many fields or methods and many nodes the 176953a5a1b3Sopenharmony_ci# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS 177053a5a1b3Sopenharmony_ci# threshold limits the number of items for each type to make the size more 177153a5a1b3Sopenharmony_ci# manageable. Set this to 0 for no limit. Note that the threshold may be 177253a5a1b3Sopenharmony_ci# exceeded by 50% before the limit is enforced. 177353a5a1b3Sopenharmony_ci 177453a5a1b3Sopenharmony_ciUML_LIMIT_NUM_FIELDS = 10 177553a5a1b3Sopenharmony_ci 177653a5a1b3Sopenharmony_ci# If set to YES, the inheritance and collaboration graphs will show the 177753a5a1b3Sopenharmony_ci# relations between templates and their instances. 177853a5a1b3Sopenharmony_ci 177953a5a1b3Sopenharmony_ciTEMPLATE_RELATIONS = NO 178053a5a1b3Sopenharmony_ci 178153a5a1b3Sopenharmony_ci# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 178253a5a1b3Sopenharmony_ci# tags are set to YES then doxygen will generate a graph for each documented 178353a5a1b3Sopenharmony_ci# file showing the direct and indirect include dependencies of the file with 178453a5a1b3Sopenharmony_ci# other documented files. 178553a5a1b3Sopenharmony_ci 178653a5a1b3Sopenharmony_ciINCLUDE_GRAPH = YES 178753a5a1b3Sopenharmony_ci 178853a5a1b3Sopenharmony_ci# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 178953a5a1b3Sopenharmony_ci# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 179053a5a1b3Sopenharmony_ci# documented header file showing the documented files that directly or 179153a5a1b3Sopenharmony_ci# indirectly include this file. 179253a5a1b3Sopenharmony_ci 179353a5a1b3Sopenharmony_ciINCLUDED_BY_GRAPH = YES 179453a5a1b3Sopenharmony_ci 179553a5a1b3Sopenharmony_ci# If the CALL_GRAPH and HAVE_DOT options are set to YES then 179653a5a1b3Sopenharmony_ci# doxygen will generate a call dependency graph for every global function 179753a5a1b3Sopenharmony_ci# or class method. Note that enabling this option will significantly increase 179853a5a1b3Sopenharmony_ci# the time of a run. So in most cases it will be better to enable call graphs 179953a5a1b3Sopenharmony_ci# for selected functions only using the \callgraph command. 180053a5a1b3Sopenharmony_ci 180153a5a1b3Sopenharmony_ciCALL_GRAPH = NO 180253a5a1b3Sopenharmony_ci 180353a5a1b3Sopenharmony_ci# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 180453a5a1b3Sopenharmony_ci# doxygen will generate a caller dependency graph for every global function 180553a5a1b3Sopenharmony_ci# or class method. Note that enabling this option will significantly increase 180653a5a1b3Sopenharmony_ci# the time of a run. So in most cases it will be better to enable caller 180753a5a1b3Sopenharmony_ci# graphs for selected functions only using the \callergraph command. 180853a5a1b3Sopenharmony_ci 180953a5a1b3Sopenharmony_ciCALLER_GRAPH = NO 181053a5a1b3Sopenharmony_ci 181153a5a1b3Sopenharmony_ci# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 181253a5a1b3Sopenharmony_ci# will generate a graphical hierarchy of all classes instead of a textual one. 181353a5a1b3Sopenharmony_ci 181453a5a1b3Sopenharmony_ciGRAPHICAL_HIERARCHY = YES 181553a5a1b3Sopenharmony_ci 181653a5a1b3Sopenharmony_ci# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES 181753a5a1b3Sopenharmony_ci# then doxygen will show the dependencies a directory has on other directories 181853a5a1b3Sopenharmony_ci# in a graphical way. The dependency relations are determined by the #include 181953a5a1b3Sopenharmony_ci# relations between the files in the directories. 182053a5a1b3Sopenharmony_ci 182153a5a1b3Sopenharmony_ciDIRECTORY_GRAPH = YES 182253a5a1b3Sopenharmony_ci 182353a5a1b3Sopenharmony_ci# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 182453a5a1b3Sopenharmony_ci# generated by dot. Possible values are svg, png, jpg, or gif. 182553a5a1b3Sopenharmony_ci# If left blank png will be used. If you choose svg you need to set 182653a5a1b3Sopenharmony_ci# HTML_FILE_EXTENSION to xhtml in order to make the SVG files 182753a5a1b3Sopenharmony_ci# visible in IE 9+ (other browsers do not have this requirement). 182853a5a1b3Sopenharmony_ci 182953a5a1b3Sopenharmony_ciDOT_IMAGE_FORMAT = png 183053a5a1b3Sopenharmony_ci 183153a5a1b3Sopenharmony_ci# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 183253a5a1b3Sopenharmony_ci# enable generation of interactive SVG images that allow zooming and panning. 183353a5a1b3Sopenharmony_ci# Note that this requires a modern browser other than Internet Explorer. 183453a5a1b3Sopenharmony_ci# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you 183553a5a1b3Sopenharmony_ci# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files 183653a5a1b3Sopenharmony_ci# visible. Older versions of IE do not have SVG support. 183753a5a1b3Sopenharmony_ci 183853a5a1b3Sopenharmony_ciINTERACTIVE_SVG = NO 183953a5a1b3Sopenharmony_ci 184053a5a1b3Sopenharmony_ci# The tag DOT_PATH can be used to specify the path where the dot tool can be 184153a5a1b3Sopenharmony_ci# found. If left blank, it is assumed the dot tool can be found in the path. 184253a5a1b3Sopenharmony_ci 184353a5a1b3Sopenharmony_ciDOT_PATH = 184453a5a1b3Sopenharmony_ci 184553a5a1b3Sopenharmony_ci# The DOTFILE_DIRS tag can be used to specify one or more directories that 184653a5a1b3Sopenharmony_ci# contain dot files that are included in the documentation (see the 184753a5a1b3Sopenharmony_ci# \dotfile command). 184853a5a1b3Sopenharmony_ci 184953a5a1b3Sopenharmony_ciDOTFILE_DIRS = 185053a5a1b3Sopenharmony_ci 185153a5a1b3Sopenharmony_ci# The MSCFILE_DIRS tag can be used to specify one or more directories that 185253a5a1b3Sopenharmony_ci# contain msc files that are included in the documentation (see the 185353a5a1b3Sopenharmony_ci# \mscfile command). 185453a5a1b3Sopenharmony_ci 185553a5a1b3Sopenharmony_ciMSCFILE_DIRS = 185653a5a1b3Sopenharmony_ci 185753a5a1b3Sopenharmony_ci# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 185853a5a1b3Sopenharmony_ci# nodes that will be shown in the graph. If the number of nodes in a graph 185953a5a1b3Sopenharmony_ci# becomes larger than this value, doxygen will truncate the graph, which is 186053a5a1b3Sopenharmony_ci# visualized by representing a node as a red box. Note that doxygen if the 186153a5a1b3Sopenharmony_ci# number of direct children of the root node in a graph is already larger than 186253a5a1b3Sopenharmony_ci# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 186353a5a1b3Sopenharmony_ci# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 186453a5a1b3Sopenharmony_ci 186553a5a1b3Sopenharmony_ciDOT_GRAPH_MAX_NODES = 50 186653a5a1b3Sopenharmony_ci 186753a5a1b3Sopenharmony_ci# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 186853a5a1b3Sopenharmony_ci# graphs generated by dot. A depth value of 3 means that only nodes reachable 186953a5a1b3Sopenharmony_ci# from the root by following a path via at most 3 edges will be shown. Nodes 187053a5a1b3Sopenharmony_ci# that lay further from the root node will be omitted. Note that setting this 187153a5a1b3Sopenharmony_ci# option to 1 or 2 may greatly reduce the computation time needed for large 187253a5a1b3Sopenharmony_ci# code bases. Also note that the size of a graph can be further restricted by 187353a5a1b3Sopenharmony_ci# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 187453a5a1b3Sopenharmony_ci 187553a5a1b3Sopenharmony_ciMAX_DOT_GRAPH_DEPTH = 0 187653a5a1b3Sopenharmony_ci 187753a5a1b3Sopenharmony_ci# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 187853a5a1b3Sopenharmony_ci# background. This is disabled by default, because dot on Windows does not 187953a5a1b3Sopenharmony_ci# seem to support this out of the box. Warning: Depending on the platform used, 188053a5a1b3Sopenharmony_ci# enabling this option may lead to badly anti-aliased labels on the edges of 188153a5a1b3Sopenharmony_ci# a graph (i.e. they become hard to read). 188253a5a1b3Sopenharmony_ci 188353a5a1b3Sopenharmony_ciDOT_TRANSPARENT = NO 188453a5a1b3Sopenharmony_ci 188553a5a1b3Sopenharmony_ci# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 188653a5a1b3Sopenharmony_ci# files in one run (i.e. multiple -o and -T options on the command line). This 188753a5a1b3Sopenharmony_ci# makes dot run faster, but since only newer versions of dot (>1.8.10) 188853a5a1b3Sopenharmony_ci# support this, this feature is disabled by default. 188953a5a1b3Sopenharmony_ci 189053a5a1b3Sopenharmony_ciDOT_MULTI_TARGETS = NO 189153a5a1b3Sopenharmony_ci 189253a5a1b3Sopenharmony_ci# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 189353a5a1b3Sopenharmony_ci# generate a legend page explaining the meaning of the various boxes and 189453a5a1b3Sopenharmony_ci# arrows in the dot generated graphs. 189553a5a1b3Sopenharmony_ci 189653a5a1b3Sopenharmony_ciGENERATE_LEGEND = YES 189753a5a1b3Sopenharmony_ci 189853a5a1b3Sopenharmony_ci# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 189953a5a1b3Sopenharmony_ci# remove the intermediate dot files that are used to generate 190053a5a1b3Sopenharmony_ci# the various graphs. 190153a5a1b3Sopenharmony_ci 190253a5a1b3Sopenharmony_ciDOT_CLEANUP = YES 1903