1*38e8c45fSAndroid Build Coastguard Worker# Doxyfile 1.8.3.1 2*38e8c45fSAndroid Build Coastguard Worker 3*38e8c45fSAndroid Build Coastguard Worker# This file describes the settings to be used by the documentation system 4*38e8c45fSAndroid Build Coastguard Worker# doxygen (www.doxygen.org) for a project 5*38e8c45fSAndroid Build Coastguard Worker# 6*38e8c45fSAndroid Build Coastguard Worker# All text after a hash (#) is considered a comment and will be ignored 7*38e8c45fSAndroid Build Coastguard Worker# The format is: 8*38e8c45fSAndroid Build Coastguard Worker# TAG = value [value, ...] 9*38e8c45fSAndroid Build Coastguard Worker# For lists items can also be appended using: 10*38e8c45fSAndroid Build Coastguard Worker# TAG += value [value, ...] 11*38e8c45fSAndroid Build Coastguard Worker# Values that contain spaces should be placed between quotes (" ") 12*38e8c45fSAndroid Build Coastguard Worker 13*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 14*38e8c45fSAndroid Build Coastguard Worker# Project related configuration options 15*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 16*38e8c45fSAndroid Build Coastguard Worker 17*38e8c45fSAndroid Build Coastguard Worker# This tag specifies the encoding used for all characters in the config file 18*38e8c45fSAndroid Build Coastguard Worker# that follow. The default is UTF-8 which is also the encoding used for all 19*38e8c45fSAndroid Build Coastguard Worker# text before the first occurrence of this tag. Doxygen uses libiconv (or the 20*38e8c45fSAndroid Build Coastguard Worker# iconv built into libc) for the transcoding. See 21*38e8c45fSAndroid Build Coastguard Worker# http://www.gnu.org/software/libiconv for the list of possible encodings. 22*38e8c45fSAndroid Build Coastguard Worker 23*38e8c45fSAndroid Build Coastguard WorkerDOXYFILE_ENCODING = UTF-8 24*38e8c45fSAndroid Build Coastguard Worker 25*38e8c45fSAndroid Build Coastguard Worker# The PROJECT_NAME tag is a single word (or sequence of words) that should 26*38e8c45fSAndroid Build Coastguard Worker# identify the project. Note that if you do not use Doxywizard you need 27*38e8c45fSAndroid Build Coastguard Worker# to put quotes around the project name if it contains spaces. 28*38e8c45fSAndroid Build Coastguard Worker 29*38e8c45fSAndroid Build Coastguard WorkerPROJECT_NAME = "NDK API" 30*38e8c45fSAndroid Build Coastguard Worker 31*38e8c45fSAndroid Build Coastguard Worker# The PROJECT_NUMBER tag can be used to enter a project or revision number. 32*38e8c45fSAndroid Build Coastguard Worker# This could be handy for archiving the generated documentation or 33*38e8c45fSAndroid Build Coastguard Worker# if some version control system is used. 34*38e8c45fSAndroid Build Coastguard Worker 35*38e8c45fSAndroid Build Coastguard WorkerPROJECT_NUMBER = 36*38e8c45fSAndroid Build Coastguard Worker 37*38e8c45fSAndroid Build Coastguard Worker# Using the PROJECT_BRIEF tag one can provide an optional one line description 38*38e8c45fSAndroid Build Coastguard Worker# for a project that appears at the top of each page and should give viewer 39*38e8c45fSAndroid Build Coastguard Worker# a quick idea about the purpose of the project. Keep the description short. 40*38e8c45fSAndroid Build Coastguard Worker 41*38e8c45fSAndroid Build Coastguard WorkerPROJECT_BRIEF = "" 42*38e8c45fSAndroid Build Coastguard Worker 43*38e8c45fSAndroid Build Coastguard Worker# With the PROJECT_LOGO tag one can specify an logo or icon that is 44*38e8c45fSAndroid Build Coastguard Worker# included in the documentation. The maximum height of the logo should not 45*38e8c45fSAndroid Build Coastguard Worker# exceed 55 pixels and the maximum width should not exceed 200 pixels. 46*38e8c45fSAndroid Build Coastguard Worker# Doxygen will copy the logo to the output directory. 47*38e8c45fSAndroid Build Coastguard Worker 48*38e8c45fSAndroid Build Coastguard WorkerPROJECT_LOGO = logo.png 49*38e8c45fSAndroid Build Coastguard Worker 50*38e8c45fSAndroid Build Coastguard Worker# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 51*38e8c45fSAndroid Build Coastguard Worker# base path where the generated documentation will be put. 52*38e8c45fSAndroid Build Coastguard Worker# If a relative path is entered, it will be relative to the location 53*38e8c45fSAndroid Build Coastguard Worker# where doxygen was started. If left blank the current directory will be used. 54*38e8c45fSAndroid Build Coastguard Worker 55*38e8c45fSAndroid Build Coastguard WorkerOUTPUT_DIRECTORY = 56*38e8c45fSAndroid Build Coastguard Worker 57*38e8c45fSAndroid Build Coastguard Worker# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 58*38e8c45fSAndroid Build Coastguard Worker# 4096 sub-directories (in 2 levels) under the output directory of each output 59*38e8c45fSAndroid Build Coastguard Worker# format and will distribute the generated files over these directories. 60*38e8c45fSAndroid Build Coastguard Worker# Enabling this option can be useful when feeding doxygen a huge amount of 61*38e8c45fSAndroid Build Coastguard Worker# source files, where putting all generated files in the same directory would 62*38e8c45fSAndroid Build Coastguard Worker# otherwise cause performance problems for the file system. 63*38e8c45fSAndroid Build Coastguard Worker 64*38e8c45fSAndroid Build Coastguard WorkerCREATE_SUBDIRS = NO 65*38e8c45fSAndroid Build Coastguard Worker 66*38e8c45fSAndroid Build Coastguard Worker# The OUTPUT_LANGUAGE tag is used to specify the language in which all 67*38e8c45fSAndroid Build Coastguard Worker# documentation generated by doxygen is written. Doxygen will use this 68*38e8c45fSAndroid Build Coastguard Worker# information to generate all constant output in the proper language. 69*38e8c45fSAndroid Build Coastguard Worker# The default language is English, other supported languages are: 70*38e8c45fSAndroid Build Coastguard Worker# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 71*38e8c45fSAndroid Build Coastguard Worker# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 72*38e8c45fSAndroid Build Coastguard Worker# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 73*38e8c45fSAndroid Build Coastguard Worker# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 74*38e8c45fSAndroid Build Coastguard Worker# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, 75*38e8c45fSAndroid Build Coastguard Worker# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 76*38e8c45fSAndroid Build Coastguard Worker 77*38e8c45fSAndroid Build Coastguard WorkerOUTPUT_LANGUAGE = English 78*38e8c45fSAndroid Build Coastguard Worker 79*38e8c45fSAndroid Build Coastguard Worker# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 80*38e8c45fSAndroid Build Coastguard Worker# include brief member descriptions after the members that are listed in 81*38e8c45fSAndroid Build Coastguard Worker# the file and class documentation (similar to JavaDoc). 82*38e8c45fSAndroid Build Coastguard Worker# Set to NO to disable this. 83*38e8c45fSAndroid Build Coastguard Worker 84*38e8c45fSAndroid Build Coastguard WorkerBRIEF_MEMBER_DESC = YES 85*38e8c45fSAndroid Build Coastguard Worker 86*38e8c45fSAndroid Build Coastguard Worker# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 87*38e8c45fSAndroid Build Coastguard Worker# the brief description of a member or function before the detailed description. 88*38e8c45fSAndroid Build Coastguard Worker# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 89*38e8c45fSAndroid Build Coastguard Worker# brief descriptions will be completely suppressed. 90*38e8c45fSAndroid Build Coastguard Worker 91*38e8c45fSAndroid Build Coastguard WorkerREPEAT_BRIEF = YES 92*38e8c45fSAndroid Build Coastguard Worker 93*38e8c45fSAndroid Build Coastguard Worker# This tag implements a quasi-intelligent brief description abbreviator 94*38e8c45fSAndroid Build Coastguard Worker# that is used to form the text in various listings. Each string 95*38e8c45fSAndroid Build Coastguard Worker# in this list, if found as the leading text of the brief description, will be 96*38e8c45fSAndroid Build Coastguard Worker# stripped from the text and the result after processing the whole list, is 97*38e8c45fSAndroid Build Coastguard Worker# used as the annotated text. Otherwise, the brief description is used as-is. 98*38e8c45fSAndroid Build Coastguard Worker# If left blank, the following values are used ("$name" is automatically 99*38e8c45fSAndroid Build Coastguard Worker# replaced with the name of the entity): "The $name class" "The $name widget" 100*38e8c45fSAndroid Build Coastguard Worker# "The $name file" "is" "provides" "specifies" "contains" 101*38e8c45fSAndroid Build Coastguard Worker# "represents" "a" "an" "the" 102*38e8c45fSAndroid Build Coastguard Worker 103*38e8c45fSAndroid Build Coastguard WorkerABBREVIATE_BRIEF = "The $name class" \ 104*38e8c45fSAndroid Build Coastguard Worker "The $name widget" \ 105*38e8c45fSAndroid Build Coastguard Worker "The $name file" \ 106*38e8c45fSAndroid Build Coastguard Worker is \ 107*38e8c45fSAndroid Build Coastguard Worker provides \ 108*38e8c45fSAndroid Build Coastguard Worker specifies \ 109*38e8c45fSAndroid Build Coastguard Worker contains \ 110*38e8c45fSAndroid Build Coastguard Worker represents \ 111*38e8c45fSAndroid Build Coastguard Worker a \ 112*38e8c45fSAndroid Build Coastguard Worker an \ 113*38e8c45fSAndroid Build Coastguard Worker the 114*38e8c45fSAndroid Build Coastguard Worker 115*38e8c45fSAndroid Build Coastguard Worker# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 116*38e8c45fSAndroid Build Coastguard Worker# Doxygen will generate a detailed section even if there is only a brief 117*38e8c45fSAndroid Build Coastguard Worker# description. 118*38e8c45fSAndroid Build Coastguard Worker 119*38e8c45fSAndroid Build Coastguard WorkerALWAYS_DETAILED_SEC = NO 120*38e8c45fSAndroid Build Coastguard Worker 121*38e8c45fSAndroid Build Coastguard Worker# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 122*38e8c45fSAndroid Build Coastguard Worker# inherited members of a class in the documentation of that class as if those 123*38e8c45fSAndroid Build Coastguard Worker# members were ordinary class members. Constructors, destructors and assignment 124*38e8c45fSAndroid Build Coastguard Worker# operators of the base classes will not be shown. 125*38e8c45fSAndroid Build Coastguard Worker 126*38e8c45fSAndroid Build Coastguard WorkerINLINE_INHERITED_MEMB = NO 127*38e8c45fSAndroid Build Coastguard Worker 128*38e8c45fSAndroid Build Coastguard Worker# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 129*38e8c45fSAndroid Build Coastguard Worker# path before files name in the file list and in the header files. If set 130*38e8c45fSAndroid Build Coastguard Worker# to NO the shortest path that makes the file name unique will be used. 131*38e8c45fSAndroid Build Coastguard Worker 132*38e8c45fSAndroid Build Coastguard WorkerFULL_PATH_NAMES = NO 133*38e8c45fSAndroid Build Coastguard Worker 134*38e8c45fSAndroid Build Coastguard Worker# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 135*38e8c45fSAndroid Build Coastguard Worker# can be used to strip a user-defined part of the path. Stripping is 136*38e8c45fSAndroid Build Coastguard Worker# only done if one of the specified strings matches the left-hand part of 137*38e8c45fSAndroid Build Coastguard Worker# the path. The tag can be used to show relative paths in the file list. 138*38e8c45fSAndroid Build Coastguard Worker# If left blank the directory from which doxygen is run is used as the 139*38e8c45fSAndroid Build Coastguard Worker# path to strip. Note that you specify absolute paths here, but also 140*38e8c45fSAndroid Build Coastguard Worker# relative paths, which will be relative from the directory where doxygen is 141*38e8c45fSAndroid Build Coastguard Worker# started. 142*38e8c45fSAndroid Build Coastguard Worker 143*38e8c45fSAndroid Build Coastguard WorkerSTRIP_FROM_PATH = 144*38e8c45fSAndroid Build Coastguard Worker 145*38e8c45fSAndroid Build Coastguard Worker# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 146*38e8c45fSAndroid Build Coastguard Worker# the path mentioned in the documentation of a class, which tells 147*38e8c45fSAndroid Build Coastguard Worker# the reader which header file to include in order to use a class. 148*38e8c45fSAndroid Build Coastguard Worker# If left blank only the name of the header file containing the class 149*38e8c45fSAndroid Build Coastguard Worker# definition is used. Otherwise one should specify the include paths that 150*38e8c45fSAndroid Build Coastguard Worker# are normally passed to the compiler using the -I flag. 151*38e8c45fSAndroid Build Coastguard Worker 152*38e8c45fSAndroid Build Coastguard WorkerSTRIP_FROM_INC_PATH = 153*38e8c45fSAndroid Build Coastguard Worker 154*38e8c45fSAndroid Build Coastguard Worker# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 155*38e8c45fSAndroid Build Coastguard Worker# (but less readable) file names. This can be useful if your file system 156*38e8c45fSAndroid Build Coastguard Worker# doesn't support long names like on DOS, Mac, or CD-ROM. 157*38e8c45fSAndroid Build Coastguard Worker 158*38e8c45fSAndroid Build Coastguard WorkerSHORT_NAMES = NO 159*38e8c45fSAndroid Build Coastguard Worker 160*38e8c45fSAndroid Build Coastguard Worker# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 161*38e8c45fSAndroid Build Coastguard Worker# will interpret the first line (until the first dot) of a JavaDoc-style 162*38e8c45fSAndroid Build Coastguard Worker# comment as the brief description. If set to NO, the JavaDoc 163*38e8c45fSAndroid Build Coastguard Worker# comments will behave just like regular Qt-style comments 164*38e8c45fSAndroid Build Coastguard Worker# (thus requiring an explicit @brief command for a brief description.) 165*38e8c45fSAndroid Build Coastguard Worker 166*38e8c45fSAndroid Build Coastguard WorkerJAVADOC_AUTOBRIEF = NO 167*38e8c45fSAndroid Build Coastguard Worker 168*38e8c45fSAndroid Build Coastguard Worker# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 169*38e8c45fSAndroid Build Coastguard Worker# interpret the first line (until the first dot) of a Qt-style 170*38e8c45fSAndroid Build Coastguard Worker# comment as the brief description. If set to NO, the comments 171*38e8c45fSAndroid Build Coastguard Worker# will behave just like regular Qt-style comments (thus requiring 172*38e8c45fSAndroid Build Coastguard Worker# an explicit \brief command for a brief description.) 173*38e8c45fSAndroid Build Coastguard Worker 174*38e8c45fSAndroid Build Coastguard WorkerQT_AUTOBRIEF = NO 175*38e8c45fSAndroid Build Coastguard Worker 176*38e8c45fSAndroid Build Coastguard Worker# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 177*38e8c45fSAndroid Build Coastguard Worker# treat a multi-line C++ special comment block (i.e. a block of //! or /// 178*38e8c45fSAndroid Build Coastguard Worker# comments) as a brief description. This used to be the default behaviour. 179*38e8c45fSAndroid Build Coastguard Worker# The new default is to treat a multi-line C++ comment block as a detailed 180*38e8c45fSAndroid Build Coastguard Worker# description. Set this tag to YES if you prefer the old behaviour instead. 181*38e8c45fSAndroid Build Coastguard Worker 182*38e8c45fSAndroid Build Coastguard WorkerMULTILINE_CPP_IS_BRIEF = NO 183*38e8c45fSAndroid Build Coastguard Worker 184*38e8c45fSAndroid Build Coastguard Worker# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 185*38e8c45fSAndroid Build Coastguard Worker# member inherits the documentation from any documented member that it 186*38e8c45fSAndroid Build Coastguard Worker# re-implements. 187*38e8c45fSAndroid Build Coastguard Worker 188*38e8c45fSAndroid Build Coastguard WorkerINHERIT_DOCS = YES 189*38e8c45fSAndroid Build Coastguard Worker 190*38e8c45fSAndroid Build Coastguard Worker# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 191*38e8c45fSAndroid Build Coastguard Worker# a new page for each member. If set to NO, the documentation of a member will 192*38e8c45fSAndroid Build Coastguard Worker# be part of the file/class/namespace that contains it. 193*38e8c45fSAndroid Build Coastguard Worker 194*38e8c45fSAndroid Build Coastguard WorkerSEPARATE_MEMBER_PAGES = NO 195*38e8c45fSAndroid Build Coastguard Worker 196*38e8c45fSAndroid Build Coastguard Worker# The TAB_SIZE tag can be used to set the number of spaces in a tab. 197*38e8c45fSAndroid Build Coastguard Worker# Doxygen uses this value to replace tabs by spaces in code fragments. 198*38e8c45fSAndroid Build Coastguard Worker 199*38e8c45fSAndroid Build Coastguard WorkerTAB_SIZE = 4 200*38e8c45fSAndroid Build Coastguard Worker 201*38e8c45fSAndroid Build Coastguard Worker# This tag can be used to specify a number of aliases that acts 202*38e8c45fSAndroid Build Coastguard Worker# as commands in the documentation. An alias has the form "name=value". 203*38e8c45fSAndroid Build Coastguard Worker# For example adding "sideeffect=\par Side Effects:\n" will allow you to 204*38e8c45fSAndroid Build Coastguard Worker# put the command \sideeffect (or @sideeffect) in the documentation, which 205*38e8c45fSAndroid Build Coastguard Worker# will result in a user-defined paragraph with heading "Side Effects:". 206*38e8c45fSAndroid Build Coastguard Worker# You can put \n's in the value part of an alias to insert newlines. 207*38e8c45fSAndroid Build Coastguard Worker 208*38e8c45fSAndroid Build Coastguard WorkerALIASES = 209*38e8c45fSAndroid Build Coastguard Worker 210*38e8c45fSAndroid Build Coastguard Worker# This tag can be used to specify a number of word-keyword mappings (TCL only). 211*38e8c45fSAndroid Build Coastguard Worker# A mapping has the form "name=value". For example adding 212*38e8c45fSAndroid Build Coastguard Worker# "class=itcl::class" will allow you to use the command class in the 213*38e8c45fSAndroid Build Coastguard Worker# itcl::class meaning. 214*38e8c45fSAndroid Build Coastguard Worker 215*38e8c45fSAndroid Build Coastguard WorkerTCL_SUBST = 216*38e8c45fSAndroid Build Coastguard Worker 217*38e8c45fSAndroid Build Coastguard Worker# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 218*38e8c45fSAndroid Build Coastguard Worker# sources only. Doxygen will then generate output that is more tailored for C. 219*38e8c45fSAndroid Build Coastguard Worker# For instance, some of the names that are used will be different. The list 220*38e8c45fSAndroid Build Coastguard Worker# of all members will be omitted, etc. 221*38e8c45fSAndroid Build Coastguard Worker 222*38e8c45fSAndroid Build Coastguard WorkerOPTIMIZE_OUTPUT_FOR_C = YES 223*38e8c45fSAndroid Build Coastguard Worker 224*38e8c45fSAndroid Build Coastguard Worker# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 225*38e8c45fSAndroid Build Coastguard Worker# sources only. Doxygen will then generate output that is more tailored for 226*38e8c45fSAndroid Build Coastguard Worker# Java. For instance, namespaces will be presented as packages, qualified 227*38e8c45fSAndroid Build Coastguard Worker# scopes will look different, etc. 228*38e8c45fSAndroid Build Coastguard Worker 229*38e8c45fSAndroid Build Coastguard WorkerOPTIMIZE_OUTPUT_JAVA = NO 230*38e8c45fSAndroid Build Coastguard Worker 231*38e8c45fSAndroid Build Coastguard Worker# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 232*38e8c45fSAndroid Build Coastguard Worker# sources only. Doxygen will then generate output that is more tailored for 233*38e8c45fSAndroid Build Coastguard Worker# Fortran. 234*38e8c45fSAndroid Build Coastguard Worker 235*38e8c45fSAndroid Build Coastguard WorkerOPTIMIZE_FOR_FORTRAN = NO 236*38e8c45fSAndroid Build Coastguard Worker 237*38e8c45fSAndroid Build Coastguard Worker# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 238*38e8c45fSAndroid Build Coastguard Worker# sources. Doxygen will then generate output that is tailored for 239*38e8c45fSAndroid Build Coastguard Worker# VHDL. 240*38e8c45fSAndroid Build Coastguard Worker 241*38e8c45fSAndroid Build Coastguard WorkerOPTIMIZE_OUTPUT_VHDL = NO 242*38e8c45fSAndroid Build Coastguard Worker 243*38e8c45fSAndroid Build Coastguard Worker# Doxygen selects the parser to use depending on the extension of the files it 244*38e8c45fSAndroid Build Coastguard Worker# parses. With this tag you can assign which parser to use for a given 245*38e8c45fSAndroid Build Coastguard Worker# extension. Doxygen has a built-in mapping, but you can override or extend it 246*38e8c45fSAndroid Build Coastguard Worker# using this tag. The format is ext=language, where ext is a file extension, 247*38e8c45fSAndroid Build Coastguard Worker# and language is one of the parsers supported by doxygen: IDL, Java, 248*38e8c45fSAndroid Build Coastguard Worker# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, 249*38e8c45fSAndroid Build Coastguard Worker# C++. For instance to make doxygen treat .inc files as Fortran files (default 250*38e8c45fSAndroid Build Coastguard Worker# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note 251*38e8c45fSAndroid Build Coastguard Worker# that for custom extensions you also need to set FILE_PATTERNS otherwise the 252*38e8c45fSAndroid Build Coastguard Worker# files are not read by doxygen. 253*38e8c45fSAndroid Build Coastguard Worker 254*38e8c45fSAndroid Build Coastguard WorkerEXTENSION_MAPPING = 255*38e8c45fSAndroid Build Coastguard Worker 256*38e8c45fSAndroid Build Coastguard Worker# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all 257*38e8c45fSAndroid Build Coastguard Worker# comments according to the Markdown format, which allows for more readable 258*38e8c45fSAndroid Build Coastguard Worker# documentation. See http://daringfireball.net/projects/markdown/ for details. 259*38e8c45fSAndroid Build Coastguard Worker# The output of markdown processing is further processed by doxygen, so you 260*38e8c45fSAndroid Build Coastguard Worker# can mix doxygen, HTML, and XML commands with Markdown formatting. 261*38e8c45fSAndroid Build Coastguard Worker# Disable only in case of backward compatibilities issues. 262*38e8c45fSAndroid Build Coastguard Worker 263*38e8c45fSAndroid Build Coastguard WorkerMARKDOWN_SUPPORT = YES 264*38e8c45fSAndroid Build Coastguard Worker 265*38e8c45fSAndroid Build Coastguard Worker# When enabled doxygen tries to link words that correspond to documented classes, 266*38e8c45fSAndroid Build Coastguard Worker# or namespaces to their corresponding documentation. Such a link can be 267*38e8c45fSAndroid Build Coastguard Worker# prevented in individual cases by by putting a % sign in front of the word or 268*38e8c45fSAndroid Build Coastguard Worker# globally by setting AUTOLINK_SUPPORT to NO. 269*38e8c45fSAndroid Build Coastguard Worker 270*38e8c45fSAndroid Build Coastguard WorkerAUTOLINK_SUPPORT = YES 271*38e8c45fSAndroid Build Coastguard Worker 272*38e8c45fSAndroid Build Coastguard Worker# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 273*38e8c45fSAndroid Build Coastguard Worker# to include (a tag file for) the STL sources as input, then you should 274*38e8c45fSAndroid Build Coastguard Worker# set this tag to YES in order to let doxygen match functions declarations and 275*38e8c45fSAndroid Build Coastguard Worker# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 276*38e8c45fSAndroid Build Coastguard Worker# func(std::string) {}). This also makes the inheritance and collaboration 277*38e8c45fSAndroid Build Coastguard Worker# diagrams that involve STL classes more complete and accurate. 278*38e8c45fSAndroid Build Coastguard Worker 279*38e8c45fSAndroid Build Coastguard WorkerBUILTIN_STL_SUPPORT = NO 280*38e8c45fSAndroid Build Coastguard Worker 281*38e8c45fSAndroid Build Coastguard Worker# If you use Microsoft's C++/CLI language, you should set this option to YES to 282*38e8c45fSAndroid Build Coastguard Worker# enable parsing support. 283*38e8c45fSAndroid Build Coastguard Worker 284*38e8c45fSAndroid Build Coastguard WorkerCPP_CLI_SUPPORT = NO 285*38e8c45fSAndroid Build Coastguard Worker 286*38e8c45fSAndroid Build Coastguard Worker# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 287*38e8c45fSAndroid Build Coastguard Worker# Doxygen will parse them like normal C++ but will assume all classes use public 288*38e8c45fSAndroid Build Coastguard Worker# instead of private inheritance when no explicit protection keyword is present. 289*38e8c45fSAndroid Build Coastguard Worker 290*38e8c45fSAndroid Build Coastguard WorkerSIP_SUPPORT = NO 291*38e8c45fSAndroid Build Coastguard Worker 292*38e8c45fSAndroid Build Coastguard Worker# For Microsoft's IDL there are propget and propput attributes to indicate 293*38e8c45fSAndroid Build Coastguard Worker# getter and setter methods for a property. Setting this option to YES (the 294*38e8c45fSAndroid Build Coastguard Worker# default) will make doxygen replace the get and set methods by a property in 295*38e8c45fSAndroid Build Coastguard Worker# the documentation. This will only work if the methods are indeed getting or 296*38e8c45fSAndroid Build Coastguard Worker# setting a simple type. If this is not the case, or you want to show the 297*38e8c45fSAndroid Build Coastguard Worker# methods anyway, you should set this option to NO. 298*38e8c45fSAndroid Build Coastguard Worker 299*38e8c45fSAndroid Build Coastguard WorkerIDL_PROPERTY_SUPPORT = YES 300*38e8c45fSAndroid Build Coastguard Worker 301*38e8c45fSAndroid Build Coastguard Worker# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 302*38e8c45fSAndroid Build Coastguard Worker# tag is set to YES, then doxygen will reuse the documentation of the first 303*38e8c45fSAndroid Build Coastguard Worker# member in the group (if any) for the other members of the group. By default 304*38e8c45fSAndroid Build Coastguard Worker# all members of a group must be documented explicitly. 305*38e8c45fSAndroid Build Coastguard Worker 306*38e8c45fSAndroid Build Coastguard WorkerDISTRIBUTE_GROUP_DOC = NO 307*38e8c45fSAndroid Build Coastguard Worker 308*38e8c45fSAndroid Build Coastguard Worker# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 309*38e8c45fSAndroid Build Coastguard Worker# the same type (for instance a group of public functions) to be put as a 310*38e8c45fSAndroid Build Coastguard Worker# subgroup of that type (e.g. under the Public Functions section). Set it to 311*38e8c45fSAndroid Build Coastguard Worker# NO to prevent subgrouping. Alternatively, this can be done per class using 312*38e8c45fSAndroid Build Coastguard Worker# the \nosubgrouping command. 313*38e8c45fSAndroid Build Coastguard Worker 314*38e8c45fSAndroid Build Coastguard WorkerSUBGROUPING = YES 315*38e8c45fSAndroid Build Coastguard Worker 316*38e8c45fSAndroid Build Coastguard Worker# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and 317*38e8c45fSAndroid Build Coastguard Worker# unions are shown inside the group in which they are included (e.g. using 318*38e8c45fSAndroid Build Coastguard Worker# @ingroup) instead of on a separate page (for HTML and Man pages) or 319*38e8c45fSAndroid Build Coastguard Worker# section (for LaTeX and RTF). 320*38e8c45fSAndroid Build Coastguard Worker 321*38e8c45fSAndroid Build Coastguard WorkerINLINE_GROUPED_CLASSES = NO 322*38e8c45fSAndroid Build Coastguard Worker 323*38e8c45fSAndroid Build Coastguard Worker# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and 324*38e8c45fSAndroid Build Coastguard Worker# unions with only public data fields will be shown inline in the documentation 325*38e8c45fSAndroid Build Coastguard Worker# of the scope in which they are defined (i.e. file, namespace, or group 326*38e8c45fSAndroid Build Coastguard Worker# documentation), provided this scope is documented. If set to NO (the default), 327*38e8c45fSAndroid Build Coastguard Worker# structs, classes, and unions are shown on a separate page (for HTML and Man 328*38e8c45fSAndroid Build Coastguard Worker# pages) or section (for LaTeX and RTF). 329*38e8c45fSAndroid Build Coastguard Worker 330*38e8c45fSAndroid Build Coastguard WorkerINLINE_SIMPLE_STRUCTS = NO 331*38e8c45fSAndroid Build Coastguard Worker 332*38e8c45fSAndroid Build Coastguard Worker# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 333*38e8c45fSAndroid Build Coastguard Worker# is documented as struct, union, or enum with the name of the typedef. So 334*38e8c45fSAndroid Build Coastguard Worker# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 335*38e8c45fSAndroid Build Coastguard Worker# with name TypeT. When disabled the typedef will appear as a member of a file, 336*38e8c45fSAndroid Build Coastguard Worker# namespace, or class. And the struct will be named TypeS. This can typically 337*38e8c45fSAndroid Build Coastguard Worker# be useful for C code in case the coding convention dictates that all compound 338*38e8c45fSAndroid Build Coastguard Worker# types are typedef'ed and only the typedef is referenced, never the tag name. 339*38e8c45fSAndroid Build Coastguard Worker 340*38e8c45fSAndroid Build Coastguard WorkerTYPEDEF_HIDES_STRUCT = NO 341*38e8c45fSAndroid Build Coastguard Worker 342*38e8c45fSAndroid Build Coastguard Worker# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 343*38e8c45fSAndroid Build Coastguard Worker# determine which symbols to keep in memory and which to flush to disk. 344*38e8c45fSAndroid Build Coastguard Worker# When the cache is full, less often used symbols will be written to disk. 345*38e8c45fSAndroid Build Coastguard Worker# For small to medium size projects (<1000 input files) the default value is 346*38e8c45fSAndroid Build Coastguard Worker# probably good enough. For larger projects a too small cache size can cause 347*38e8c45fSAndroid Build Coastguard Worker# doxygen to be busy swapping symbols to and from disk most of the time 348*38e8c45fSAndroid Build Coastguard Worker# causing a significant performance penalty. 349*38e8c45fSAndroid Build Coastguard Worker# If the system has enough physical memory increasing the cache will improve the 350*38e8c45fSAndroid Build Coastguard Worker# performance by keeping more symbols in memory. Note that the value works on 351*38e8c45fSAndroid Build Coastguard Worker# a logarithmic scale so increasing the size by one will roughly double the 352*38e8c45fSAndroid Build Coastguard Worker# memory usage. The cache size is given by this formula: 353*38e8c45fSAndroid Build Coastguard Worker# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 354*38e8c45fSAndroid Build Coastguard Worker# corresponding to a cache size of 2^16 = 65536 symbols. 355*38e8c45fSAndroid Build Coastguard Worker 356*38e8c45fSAndroid Build Coastguard WorkerSYMBOL_CACHE_SIZE = 0 357*38e8c45fSAndroid Build Coastguard Worker 358*38e8c45fSAndroid Build Coastguard Worker# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be 359*38e8c45fSAndroid Build Coastguard Worker# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given 360*38e8c45fSAndroid Build Coastguard Worker# their name and scope. Since this can be an expensive process and often the 361*38e8c45fSAndroid Build Coastguard Worker# same symbol appear multiple times in the code, doxygen keeps a cache of 362*38e8c45fSAndroid Build Coastguard Worker# pre-resolved symbols. If the cache is too small doxygen will become slower. 363*38e8c45fSAndroid Build Coastguard Worker# If the cache is too large, memory is wasted. The cache size is given by this 364*38e8c45fSAndroid Build Coastguard Worker# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, 365*38e8c45fSAndroid Build Coastguard Worker# corresponding to a cache size of 2^16 = 65536 symbols. 366*38e8c45fSAndroid Build Coastguard Worker 367*38e8c45fSAndroid Build Coastguard WorkerLOOKUP_CACHE_SIZE = 0 368*38e8c45fSAndroid Build Coastguard Worker 369*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 370*38e8c45fSAndroid Build Coastguard Worker# Build related configuration options 371*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 372*38e8c45fSAndroid Build Coastguard Worker 373*38e8c45fSAndroid Build Coastguard Worker# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 374*38e8c45fSAndroid Build Coastguard Worker# documentation are documented, even if no documentation was available. 375*38e8c45fSAndroid Build Coastguard Worker# Private class members and static file members will be hidden unless 376*38e8c45fSAndroid Build Coastguard Worker# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 377*38e8c45fSAndroid Build Coastguard Worker 378*38e8c45fSAndroid Build Coastguard WorkerEXTRACT_ALL = YES 379*38e8c45fSAndroid Build Coastguard Worker 380*38e8c45fSAndroid Build Coastguard Worker# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 381*38e8c45fSAndroid Build Coastguard Worker# will be included in the documentation. 382*38e8c45fSAndroid Build Coastguard Worker 383*38e8c45fSAndroid Build Coastguard WorkerEXTRACT_PRIVATE = NO 384*38e8c45fSAndroid Build Coastguard Worker 385*38e8c45fSAndroid Build Coastguard Worker# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal 386*38e8c45fSAndroid Build Coastguard Worker# scope will be included in the documentation. 387*38e8c45fSAndroid Build Coastguard Worker 388*38e8c45fSAndroid Build Coastguard WorkerEXTRACT_PACKAGE = NO 389*38e8c45fSAndroid Build Coastguard Worker 390*38e8c45fSAndroid Build Coastguard Worker# If the EXTRACT_STATIC tag is set to YES all static members of a file 391*38e8c45fSAndroid Build Coastguard Worker# will be included in the documentation. 392*38e8c45fSAndroid Build Coastguard Worker 393*38e8c45fSAndroid Build Coastguard WorkerEXTRACT_STATIC = NO 394*38e8c45fSAndroid Build Coastguard Worker 395*38e8c45fSAndroid Build Coastguard Worker# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 396*38e8c45fSAndroid Build Coastguard Worker# defined locally in source files will be included in the documentation. 397*38e8c45fSAndroid Build Coastguard Worker# If set to NO only classes defined in header files are included. 398*38e8c45fSAndroid Build Coastguard Worker 399*38e8c45fSAndroid Build Coastguard WorkerEXTRACT_LOCAL_CLASSES = YES 400*38e8c45fSAndroid Build Coastguard Worker 401*38e8c45fSAndroid Build Coastguard Worker# This flag is only useful for Objective-C code. When set to YES local 402*38e8c45fSAndroid Build Coastguard Worker# methods, which are defined in the implementation section but not in 403*38e8c45fSAndroid Build Coastguard Worker# the interface are included in the documentation. 404*38e8c45fSAndroid Build Coastguard Worker# If set to NO (the default) only methods in the interface are included. 405*38e8c45fSAndroid Build Coastguard Worker 406*38e8c45fSAndroid Build Coastguard WorkerEXTRACT_LOCAL_METHODS = NO 407*38e8c45fSAndroid Build Coastguard Worker 408*38e8c45fSAndroid Build Coastguard Worker# If this flag is set to YES, the members of anonymous namespaces will be 409*38e8c45fSAndroid Build Coastguard Worker# extracted and appear in the documentation as a namespace called 410*38e8c45fSAndroid Build Coastguard Worker# 'anonymous_namespace{file}', where file will be replaced with the base 411*38e8c45fSAndroid Build Coastguard Worker# name of the file that contains the anonymous namespace. By default 412*38e8c45fSAndroid Build Coastguard Worker# anonymous namespaces are hidden. 413*38e8c45fSAndroid Build Coastguard Worker 414*38e8c45fSAndroid Build Coastguard WorkerEXTRACT_ANON_NSPACES = NO 415*38e8c45fSAndroid Build Coastguard Worker 416*38e8c45fSAndroid Build Coastguard Worker# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 417*38e8c45fSAndroid Build Coastguard Worker# undocumented members of documented classes, files or namespaces. 418*38e8c45fSAndroid Build Coastguard Worker# If set to NO (the default) these members will be included in the 419*38e8c45fSAndroid Build Coastguard Worker# various overviews, but no documentation section is generated. 420*38e8c45fSAndroid Build Coastguard Worker# This option has no effect if EXTRACT_ALL is enabled. 421*38e8c45fSAndroid Build Coastguard Worker 422*38e8c45fSAndroid Build Coastguard WorkerHIDE_UNDOC_MEMBERS = NO 423*38e8c45fSAndroid Build Coastguard Worker 424*38e8c45fSAndroid Build Coastguard Worker# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 425*38e8c45fSAndroid Build Coastguard Worker# undocumented classes that are normally visible in the class hierarchy. 426*38e8c45fSAndroid Build Coastguard Worker# If set to NO (the default) these classes will be included in the various 427*38e8c45fSAndroid Build Coastguard Worker# overviews. This option has no effect if EXTRACT_ALL is enabled. 428*38e8c45fSAndroid Build Coastguard Worker 429*38e8c45fSAndroid Build Coastguard WorkerHIDE_UNDOC_CLASSES = NO 430*38e8c45fSAndroid Build Coastguard Worker 431*38e8c45fSAndroid Build Coastguard Worker# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 432*38e8c45fSAndroid Build Coastguard Worker# friend (class|struct|union) declarations. 433*38e8c45fSAndroid Build Coastguard Worker# If set to NO (the default) these declarations will be included in the 434*38e8c45fSAndroid Build Coastguard Worker# documentation. 435*38e8c45fSAndroid Build Coastguard Worker 436*38e8c45fSAndroid Build Coastguard WorkerHIDE_FRIEND_COMPOUNDS = NO 437*38e8c45fSAndroid Build Coastguard Worker 438*38e8c45fSAndroid Build Coastguard Worker# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 439*38e8c45fSAndroid Build Coastguard Worker# documentation blocks found inside the body of a function. 440*38e8c45fSAndroid Build Coastguard Worker# If set to NO (the default) these blocks will be appended to the 441*38e8c45fSAndroid Build Coastguard Worker# function's detailed documentation block. 442*38e8c45fSAndroid Build Coastguard Worker 443*38e8c45fSAndroid Build Coastguard WorkerHIDE_IN_BODY_DOCS = NO 444*38e8c45fSAndroid Build Coastguard Worker 445*38e8c45fSAndroid Build Coastguard Worker# The INTERNAL_DOCS tag determines if documentation 446*38e8c45fSAndroid Build Coastguard Worker# that is typed after a \internal command is included. If the tag is set 447*38e8c45fSAndroid Build Coastguard Worker# to NO (the default) then the documentation will be excluded. 448*38e8c45fSAndroid Build Coastguard Worker# Set it to YES to include the internal documentation. 449*38e8c45fSAndroid Build Coastguard Worker 450*38e8c45fSAndroid Build Coastguard WorkerINTERNAL_DOCS = NO 451*38e8c45fSAndroid Build Coastguard Worker 452*38e8c45fSAndroid Build Coastguard Worker# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 453*38e8c45fSAndroid Build Coastguard Worker# file names in lower-case letters. If set to YES upper-case letters are also 454*38e8c45fSAndroid Build Coastguard Worker# allowed. This is useful if you have classes or files whose names only differ 455*38e8c45fSAndroid Build Coastguard Worker# in case and if your file system supports case sensitive file names. Windows 456*38e8c45fSAndroid Build Coastguard Worker# and Mac users are advised to set this option to NO. 457*38e8c45fSAndroid Build Coastguard Worker 458*38e8c45fSAndroid Build Coastguard WorkerCASE_SENSE_NAMES = NO 459*38e8c45fSAndroid Build Coastguard Worker 460*38e8c45fSAndroid Build Coastguard Worker# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 461*38e8c45fSAndroid Build Coastguard Worker# will show members with their full class and namespace scopes in the 462*38e8c45fSAndroid Build Coastguard Worker# documentation. If set to YES the scope will be hidden. 463*38e8c45fSAndroid Build Coastguard Worker 464*38e8c45fSAndroid Build Coastguard WorkerHIDE_SCOPE_NAMES = YES 465*38e8c45fSAndroid Build Coastguard Worker 466*38e8c45fSAndroid Build Coastguard Worker# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 467*38e8c45fSAndroid Build Coastguard Worker# will put a list of the files that are included by a file in the documentation 468*38e8c45fSAndroid Build Coastguard Worker# of that file. 469*38e8c45fSAndroid Build Coastguard Worker 470*38e8c45fSAndroid Build Coastguard WorkerSHOW_INCLUDE_FILES = YES 471*38e8c45fSAndroid Build Coastguard Worker 472*38e8c45fSAndroid Build Coastguard Worker# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 473*38e8c45fSAndroid Build Coastguard Worker# will list include files with double quotes in the documentation 474*38e8c45fSAndroid Build Coastguard Worker# rather than with sharp brackets. 475*38e8c45fSAndroid Build Coastguard Worker 476*38e8c45fSAndroid Build Coastguard WorkerFORCE_LOCAL_INCLUDES = NO 477*38e8c45fSAndroid Build Coastguard Worker 478*38e8c45fSAndroid Build Coastguard Worker# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 479*38e8c45fSAndroid Build Coastguard Worker# is inserted in the documentation for inline members. 480*38e8c45fSAndroid Build Coastguard Worker 481*38e8c45fSAndroid Build Coastguard WorkerINLINE_INFO = YES 482*38e8c45fSAndroid Build Coastguard Worker 483*38e8c45fSAndroid Build Coastguard Worker# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 484*38e8c45fSAndroid Build Coastguard Worker# will sort the (detailed) documentation of file and class members 485*38e8c45fSAndroid Build Coastguard Worker# alphabetically by member name. If set to NO the members will appear in 486*38e8c45fSAndroid Build Coastguard Worker# declaration order. 487*38e8c45fSAndroid Build Coastguard Worker 488*38e8c45fSAndroid Build Coastguard WorkerSORT_MEMBER_DOCS = YES 489*38e8c45fSAndroid Build Coastguard Worker 490*38e8c45fSAndroid Build Coastguard Worker# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 491*38e8c45fSAndroid Build Coastguard Worker# brief documentation of file, namespace and class members alphabetically 492*38e8c45fSAndroid Build Coastguard Worker# by member name. If set to NO (the default) the members will appear in 493*38e8c45fSAndroid Build Coastguard Worker# declaration order. 494*38e8c45fSAndroid Build Coastguard Worker 495*38e8c45fSAndroid Build Coastguard WorkerSORT_BRIEF_DOCS = NO 496*38e8c45fSAndroid Build Coastguard Worker 497*38e8c45fSAndroid Build Coastguard Worker# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 498*38e8c45fSAndroid Build Coastguard Worker# will sort the (brief and detailed) documentation of class members so that 499*38e8c45fSAndroid Build Coastguard Worker# constructors and destructors are listed first. If set to NO (the default) 500*38e8c45fSAndroid Build Coastguard Worker# the constructors will appear in the respective orders defined by 501*38e8c45fSAndroid Build Coastguard Worker# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 502*38e8c45fSAndroid Build Coastguard Worker# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 503*38e8c45fSAndroid Build Coastguard Worker# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. 504*38e8c45fSAndroid Build Coastguard Worker 505*38e8c45fSAndroid Build Coastguard WorkerSORT_MEMBERS_CTORS_1ST = NO 506*38e8c45fSAndroid Build Coastguard Worker 507*38e8c45fSAndroid Build Coastguard Worker# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 508*38e8c45fSAndroid Build Coastguard Worker# hierarchy of group names into alphabetical order. If set to NO (the default) 509*38e8c45fSAndroid Build Coastguard Worker# the group names will appear in their defined order. 510*38e8c45fSAndroid Build Coastguard Worker 511*38e8c45fSAndroid Build Coastguard WorkerSORT_GROUP_NAMES = NO 512*38e8c45fSAndroid Build Coastguard Worker 513*38e8c45fSAndroid Build Coastguard Worker# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 514*38e8c45fSAndroid Build Coastguard Worker# sorted by fully-qualified names, including namespaces. If set to 515*38e8c45fSAndroid Build Coastguard Worker# NO (the default), the class list will be sorted only by class name, 516*38e8c45fSAndroid Build Coastguard Worker# not including the namespace part. 517*38e8c45fSAndroid Build Coastguard Worker# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 518*38e8c45fSAndroid Build Coastguard Worker# Note: This option applies only to the class list, not to the 519*38e8c45fSAndroid Build Coastguard Worker# alphabetical list. 520*38e8c45fSAndroid Build Coastguard Worker 521*38e8c45fSAndroid Build Coastguard WorkerSORT_BY_SCOPE_NAME = NO 522*38e8c45fSAndroid Build Coastguard Worker 523*38e8c45fSAndroid Build Coastguard Worker# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 524*38e8c45fSAndroid Build Coastguard Worker# do proper type resolution of all parameters of a function it will reject a 525*38e8c45fSAndroid Build Coastguard Worker# match between the prototype and the implementation of a member function even 526*38e8c45fSAndroid Build Coastguard Worker# if there is only one candidate or it is obvious which candidate to choose 527*38e8c45fSAndroid Build Coastguard Worker# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 528*38e8c45fSAndroid Build Coastguard Worker# will still accept a match between prototype and implementation in such cases. 529*38e8c45fSAndroid Build Coastguard Worker 530*38e8c45fSAndroid Build Coastguard WorkerSTRICT_PROTO_MATCHING = NO 531*38e8c45fSAndroid Build Coastguard Worker 532*38e8c45fSAndroid Build Coastguard Worker# The GENERATE_TODOLIST tag can be used to enable (YES) or 533*38e8c45fSAndroid Build Coastguard Worker# disable (NO) the todo list. This list is created by putting \todo 534*38e8c45fSAndroid Build Coastguard Worker# commands in the documentation. 535*38e8c45fSAndroid Build Coastguard Worker 536*38e8c45fSAndroid Build Coastguard WorkerGENERATE_TODOLIST = YES 537*38e8c45fSAndroid Build Coastguard Worker 538*38e8c45fSAndroid Build Coastguard Worker# The GENERATE_TESTLIST tag can be used to enable (YES) or 539*38e8c45fSAndroid Build Coastguard Worker# disable (NO) the test list. This list is created by putting \test 540*38e8c45fSAndroid Build Coastguard Worker# commands in the documentation. 541*38e8c45fSAndroid Build Coastguard Worker 542*38e8c45fSAndroid Build Coastguard WorkerGENERATE_TESTLIST = YES 543*38e8c45fSAndroid Build Coastguard Worker 544*38e8c45fSAndroid Build Coastguard Worker# The GENERATE_BUGLIST tag can be used to enable (YES) or 545*38e8c45fSAndroid Build Coastguard Worker# disable (NO) the bug list. This list is created by putting \bug 546*38e8c45fSAndroid Build Coastguard Worker# commands in the documentation. 547*38e8c45fSAndroid Build Coastguard Worker 548*38e8c45fSAndroid Build Coastguard WorkerGENERATE_BUGLIST = YES 549*38e8c45fSAndroid Build Coastguard Worker 550*38e8c45fSAndroid Build Coastguard Worker# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 551*38e8c45fSAndroid Build Coastguard Worker# disable (NO) the deprecated list. This list is created by putting 552*38e8c45fSAndroid Build Coastguard Worker# \deprecated commands in the documentation. 553*38e8c45fSAndroid Build Coastguard Worker 554*38e8c45fSAndroid Build Coastguard WorkerGENERATE_DEPRECATEDLIST= YES 555*38e8c45fSAndroid Build Coastguard Worker 556*38e8c45fSAndroid Build Coastguard Worker# The ENABLED_SECTIONS tag can be used to enable conditional 557*38e8c45fSAndroid Build Coastguard Worker# documentation sections, marked by \if section-label ... \endif 558*38e8c45fSAndroid Build Coastguard Worker# and \cond section-label ... \endcond blocks. 559*38e8c45fSAndroid Build Coastguard Worker 560*38e8c45fSAndroid Build Coastguard WorkerENABLED_SECTIONS = 561*38e8c45fSAndroid Build Coastguard Worker 562*38e8c45fSAndroid Build Coastguard Worker# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 563*38e8c45fSAndroid Build Coastguard Worker# the initial value of a variable or macro consists of for it to appear in 564*38e8c45fSAndroid Build Coastguard Worker# the documentation. If the initializer consists of more lines than specified 565*38e8c45fSAndroid Build Coastguard Worker# here it will be hidden. Use a value of 0 to hide initializers completely. 566*38e8c45fSAndroid Build Coastguard Worker# The appearance of the initializer of individual variables and macros in the 567*38e8c45fSAndroid Build Coastguard Worker# documentation can be controlled using \showinitializer or \hideinitializer 568*38e8c45fSAndroid Build Coastguard Worker# command in the documentation regardless of this setting. 569*38e8c45fSAndroid Build Coastguard Worker 570*38e8c45fSAndroid Build Coastguard WorkerMAX_INITIALIZER_LINES = 26 571*38e8c45fSAndroid Build Coastguard Worker 572*38e8c45fSAndroid Build Coastguard Worker# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 573*38e8c45fSAndroid Build Coastguard Worker# at the bottom of the documentation of classes and structs. If set to YES the 574*38e8c45fSAndroid Build Coastguard Worker# list will mention the files that were used to generate the documentation. 575*38e8c45fSAndroid Build Coastguard Worker 576*38e8c45fSAndroid Build Coastguard WorkerSHOW_USED_FILES = YES 577*38e8c45fSAndroid Build Coastguard Worker 578*38e8c45fSAndroid Build Coastguard Worker# Set the SHOW_FILES tag to NO to disable the generation of the Files page. 579*38e8c45fSAndroid Build Coastguard Worker# This will remove the Files entry from the Quick Index and from the 580*38e8c45fSAndroid Build Coastguard Worker# Folder Tree View (if specified). The default is YES. 581*38e8c45fSAndroid Build Coastguard Worker 582*38e8c45fSAndroid Build Coastguard WorkerSHOW_FILES = YES 583*38e8c45fSAndroid Build Coastguard Worker 584*38e8c45fSAndroid Build Coastguard Worker# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 585*38e8c45fSAndroid Build Coastguard Worker# Namespaces page. This will remove the Namespaces entry from the Quick Index 586*38e8c45fSAndroid Build Coastguard Worker# and from the Folder Tree View (if specified). The default is YES. 587*38e8c45fSAndroid Build Coastguard Worker 588*38e8c45fSAndroid Build Coastguard WorkerSHOW_NAMESPACES = YES 589*38e8c45fSAndroid Build Coastguard Worker 590*38e8c45fSAndroid Build Coastguard Worker# The FILE_VERSION_FILTER tag can be used to specify a program or script that 591*38e8c45fSAndroid Build Coastguard Worker# doxygen should invoke to get the current version for each file (typically from 592*38e8c45fSAndroid Build Coastguard Worker# the version control system). Doxygen will invoke the program by executing (via 593*38e8c45fSAndroid Build Coastguard Worker# popen()) the command <command> <input-file>, where <command> is the value of 594*38e8c45fSAndroid Build Coastguard Worker# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 595*38e8c45fSAndroid Build Coastguard Worker# provided by doxygen. Whatever the program writes to standard output 596*38e8c45fSAndroid Build Coastguard Worker# is used as the file version. See the manual for examples. 597*38e8c45fSAndroid Build Coastguard Worker 598*38e8c45fSAndroid Build Coastguard WorkerFILE_VERSION_FILTER = 599*38e8c45fSAndroid Build Coastguard Worker 600*38e8c45fSAndroid Build Coastguard Worker# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 601*38e8c45fSAndroid Build Coastguard Worker# by doxygen. The layout file controls the global structure of the generated 602*38e8c45fSAndroid Build Coastguard Worker# output files in an output format independent way. To create the layout file 603*38e8c45fSAndroid Build Coastguard Worker# that represents doxygen's defaults, run doxygen with the -l option. 604*38e8c45fSAndroid Build Coastguard Worker# You can optionally specify a file name after the option, if omitted 605*38e8c45fSAndroid Build Coastguard Worker# DoxygenLayout.xml will be used as the name of the layout file. 606*38e8c45fSAndroid Build Coastguard Worker 607*38e8c45fSAndroid Build Coastguard WorkerLAYOUT_FILE = 608*38e8c45fSAndroid Build Coastguard Worker 609*38e8c45fSAndroid Build Coastguard Worker# The CITE_BIB_FILES tag can be used to specify one or more bib files 610*38e8c45fSAndroid Build Coastguard Worker# containing the references data. This must be a list of .bib files. The 611*38e8c45fSAndroid Build Coastguard Worker# .bib extension is automatically appended if omitted. Using this command 612*38e8c45fSAndroid Build Coastguard Worker# requires the bibtex tool to be installed. See also 613*38e8c45fSAndroid Build Coastguard Worker# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style 614*38e8c45fSAndroid Build Coastguard Worker# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this 615*38e8c45fSAndroid Build Coastguard Worker# feature you need bibtex and perl available in the search path. Do not use 616*38e8c45fSAndroid Build Coastguard Worker# file names with spaces, bibtex cannot handle them. 617*38e8c45fSAndroid Build Coastguard Worker 618*38e8c45fSAndroid Build Coastguard WorkerCITE_BIB_FILES = 619*38e8c45fSAndroid Build Coastguard Worker 620*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 621*38e8c45fSAndroid Build Coastguard Worker# configuration options related to warning and progress messages 622*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 623*38e8c45fSAndroid Build Coastguard Worker 624*38e8c45fSAndroid Build Coastguard Worker# The QUIET tag can be used to turn on/off the messages that are generated 625*38e8c45fSAndroid Build Coastguard Worker# by doxygen. Possible values are YES and NO. If left blank NO is used. 626*38e8c45fSAndroid Build Coastguard Worker 627*38e8c45fSAndroid Build Coastguard WorkerQUIET = NO 628*38e8c45fSAndroid Build Coastguard Worker 629*38e8c45fSAndroid Build Coastguard Worker# The WARNINGS tag can be used to turn on/off the warning messages that are 630*38e8c45fSAndroid Build Coastguard Worker# generated by doxygen. Possible values are YES and NO. If left blank 631*38e8c45fSAndroid Build Coastguard Worker# NO is used. 632*38e8c45fSAndroid Build Coastguard Worker 633*38e8c45fSAndroid Build Coastguard WorkerWARNINGS = YES 634*38e8c45fSAndroid Build Coastguard Worker 635*38e8c45fSAndroid Build Coastguard Worker# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 636*38e8c45fSAndroid Build Coastguard Worker# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 637*38e8c45fSAndroid Build Coastguard Worker# automatically be disabled. 638*38e8c45fSAndroid Build Coastguard Worker 639*38e8c45fSAndroid Build Coastguard WorkerWARN_IF_UNDOCUMENTED = YES 640*38e8c45fSAndroid Build Coastguard Worker 641*38e8c45fSAndroid Build Coastguard Worker# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 642*38e8c45fSAndroid Build Coastguard Worker# potential errors in the documentation, such as not documenting some 643*38e8c45fSAndroid Build Coastguard Worker# parameters in a documented function, or documenting parameters that 644*38e8c45fSAndroid Build Coastguard Worker# don't exist or using markup commands wrongly. 645*38e8c45fSAndroid Build Coastguard Worker 646*38e8c45fSAndroid Build Coastguard WorkerWARN_IF_DOC_ERROR = YES 647*38e8c45fSAndroid Build Coastguard Worker 648*38e8c45fSAndroid Build Coastguard Worker# The WARN_NO_PARAMDOC option can be enabled to get warnings for 649*38e8c45fSAndroid Build Coastguard Worker# functions that are documented, but have no documentation for their parameters 650*38e8c45fSAndroid Build Coastguard Worker# or return value. If set to NO (the default) doxygen will only warn about 651*38e8c45fSAndroid Build Coastguard Worker# wrong or incomplete parameter documentation, but not about the absence of 652*38e8c45fSAndroid Build Coastguard Worker# documentation. 653*38e8c45fSAndroid Build Coastguard Worker 654*38e8c45fSAndroid Build Coastguard WorkerWARN_NO_PARAMDOC = NO 655*38e8c45fSAndroid Build Coastguard Worker 656*38e8c45fSAndroid Build Coastguard Worker# The WARN_FORMAT tag determines the format of the warning messages that 657*38e8c45fSAndroid Build Coastguard Worker# doxygen can produce. The string should contain the $file, $line, and $text 658*38e8c45fSAndroid Build Coastguard Worker# tags, which will be replaced by the file and line number from which the 659*38e8c45fSAndroid Build Coastguard Worker# warning originated and the warning text. Optionally the format may contain 660*38e8c45fSAndroid Build Coastguard Worker# $version, which will be replaced by the version of the file (if it could 661*38e8c45fSAndroid Build Coastguard Worker# be obtained via FILE_VERSION_FILTER) 662*38e8c45fSAndroid Build Coastguard Worker 663*38e8c45fSAndroid Build Coastguard WorkerWARN_FORMAT = "$file:$line: $text" 664*38e8c45fSAndroid Build Coastguard Worker 665*38e8c45fSAndroid Build Coastguard Worker# The WARN_LOGFILE tag can be used to specify a file to which warning 666*38e8c45fSAndroid Build Coastguard Worker# and error messages should be written. If left blank the output is written 667*38e8c45fSAndroid Build Coastguard Worker# to stderr. 668*38e8c45fSAndroid Build Coastguard Worker 669*38e8c45fSAndroid Build Coastguard WorkerWARN_LOGFILE = 670*38e8c45fSAndroid Build Coastguard Worker 671*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 672*38e8c45fSAndroid Build Coastguard Worker# configuration options related to the input files 673*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 674*38e8c45fSAndroid Build Coastguard Worker 675*38e8c45fSAndroid Build Coastguard Worker# The INPUT tag can be used to specify the files and/or directories that contain 676*38e8c45fSAndroid Build Coastguard Worker# documented source files. You may enter file names like "myfile.cpp" or 677*38e8c45fSAndroid Build Coastguard Worker# directories like "/usr/src/myproject". Separate the files or directories 678*38e8c45fSAndroid Build Coastguard Worker# with spaces. 679*38e8c45fSAndroid Build Coastguard Worker 680*38e8c45fSAndroid Build Coastguard WorkerINPUT = ../include/android ../../av/media/ndk/include ../../av/camera/ndk/include 681*38e8c45fSAndroid Build Coastguard Worker 682*38e8c45fSAndroid Build Coastguard Worker# This tag can be used to specify the character encoding of the source files 683*38e8c45fSAndroid Build Coastguard Worker# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 684*38e8c45fSAndroid Build Coastguard Worker# also the default input encoding. Doxygen uses libiconv (or the iconv built 685*38e8c45fSAndroid Build Coastguard Worker# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 686*38e8c45fSAndroid Build Coastguard Worker# the list of possible encodings. 687*38e8c45fSAndroid Build Coastguard Worker 688*38e8c45fSAndroid Build Coastguard WorkerINPUT_ENCODING = UTF-8 689*38e8c45fSAndroid Build Coastguard Worker 690*38e8c45fSAndroid Build Coastguard Worker# If the value of the INPUT tag contains directories, you can use the 691*38e8c45fSAndroid Build Coastguard Worker# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 692*38e8c45fSAndroid Build Coastguard Worker# and *.h) to filter out the source-files in the directories. If left 693*38e8c45fSAndroid Build Coastguard Worker# blank the following patterns are tested: 694*38e8c45fSAndroid Build Coastguard Worker# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 695*38e8c45fSAndroid Build Coastguard Worker# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 696*38e8c45fSAndroid Build Coastguard Worker# *.f90 *.f *.for *.vhd *.vhdl 697*38e8c45fSAndroid Build Coastguard Worker 698*38e8c45fSAndroid Build Coastguard WorkerFILE_PATTERNS = *.c \ 699*38e8c45fSAndroid Build Coastguard Worker *.cc \ 700*38e8c45fSAndroid Build Coastguard Worker *.cxx \ 701*38e8c45fSAndroid Build Coastguard Worker *.cpp \ 702*38e8c45fSAndroid Build Coastguard Worker *.c++ \ 703*38e8c45fSAndroid Build Coastguard Worker *.d \ 704*38e8c45fSAndroid Build Coastguard Worker *.java \ 705*38e8c45fSAndroid Build Coastguard Worker *.ii \ 706*38e8c45fSAndroid Build Coastguard Worker *.ixx \ 707*38e8c45fSAndroid Build Coastguard Worker *.ipp \ 708*38e8c45fSAndroid Build Coastguard Worker *.i++ \ 709*38e8c45fSAndroid Build Coastguard Worker *.inl \ 710*38e8c45fSAndroid Build Coastguard Worker *.h \ 711*38e8c45fSAndroid Build Coastguard Worker *.hh \ 712*38e8c45fSAndroid Build Coastguard Worker *.hxx \ 713*38e8c45fSAndroid Build Coastguard Worker *.hpp \ 714*38e8c45fSAndroid Build Coastguard Worker *.h++ \ 715*38e8c45fSAndroid Build Coastguard Worker *.idl \ 716*38e8c45fSAndroid Build Coastguard Worker *.odl \ 717*38e8c45fSAndroid Build Coastguard Worker *.cs \ 718*38e8c45fSAndroid Build Coastguard Worker *.php \ 719*38e8c45fSAndroid Build Coastguard Worker *.php3 \ 720*38e8c45fSAndroid Build Coastguard Worker *.inc \ 721*38e8c45fSAndroid Build Coastguard Worker *.m \ 722*38e8c45fSAndroid Build Coastguard Worker *.markdown \ 723*38e8c45fSAndroid Build Coastguard Worker *.md \ 724*38e8c45fSAndroid Build Coastguard Worker *.mm \ 725*38e8c45fSAndroid Build Coastguard Worker *.dox \ 726*38e8c45fSAndroid Build Coastguard Worker *.py \ 727*38e8c45fSAndroid Build Coastguard Worker *.f90 \ 728*38e8c45fSAndroid Build Coastguard Worker *.f \ 729*38e8c45fSAndroid Build Coastguard Worker *.for \ 730*38e8c45fSAndroid Build Coastguard Worker *.vhd \ 731*38e8c45fSAndroid Build Coastguard Worker *.vhdl 732*38e8c45fSAndroid Build Coastguard Worker 733*38e8c45fSAndroid Build Coastguard Worker# The RECURSIVE tag can be used to turn specify whether or not subdirectories 734*38e8c45fSAndroid Build Coastguard Worker# should be searched for input files as well. Possible values are YES and NO. 735*38e8c45fSAndroid Build Coastguard Worker# If left blank NO is used. 736*38e8c45fSAndroid Build Coastguard Worker 737*38e8c45fSAndroid Build Coastguard WorkerRECURSIVE = YES 738*38e8c45fSAndroid Build Coastguard Worker 739*38e8c45fSAndroid Build Coastguard Worker# The EXCLUDE tag can be used to specify files and/or directories that should be 740*38e8c45fSAndroid Build Coastguard Worker# excluded from the INPUT source files. This way you can easily exclude a 741*38e8c45fSAndroid Build Coastguard Worker# subdirectory from a directory tree whose root is specified with the INPUT tag. 742*38e8c45fSAndroid Build Coastguard Worker# Note that relative paths are relative to the directory from which doxygen is 743*38e8c45fSAndroid Build Coastguard Worker# run. 744*38e8c45fSAndroid Build Coastguard Worker 745*38e8c45fSAndroid Build Coastguard WorkerEXCLUDE = 746*38e8c45fSAndroid Build Coastguard Worker 747*38e8c45fSAndroid Build Coastguard Worker# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 748*38e8c45fSAndroid Build Coastguard Worker# directories that are symbolic links (a Unix file system feature) are excluded 749*38e8c45fSAndroid Build Coastguard Worker# from the input. 750*38e8c45fSAndroid Build Coastguard Worker 751*38e8c45fSAndroid Build Coastguard WorkerEXCLUDE_SYMLINKS = NO 752*38e8c45fSAndroid Build Coastguard Worker 753*38e8c45fSAndroid Build Coastguard Worker# If the value of the INPUT tag contains directories, you can use the 754*38e8c45fSAndroid Build Coastguard Worker# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 755*38e8c45fSAndroid Build Coastguard Worker# certain files from those directories. Note that the wildcards are matched 756*38e8c45fSAndroid Build Coastguard Worker# against the file with absolute path, so to exclude all test directories 757*38e8c45fSAndroid Build Coastguard Worker# for example use the pattern */test/* 758*38e8c45fSAndroid Build Coastguard Worker 759*38e8c45fSAndroid Build Coastguard WorkerEXCLUDE_PATTERNS = 760*38e8c45fSAndroid Build Coastguard Worker 761*38e8c45fSAndroid Build Coastguard Worker# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 762*38e8c45fSAndroid Build Coastguard Worker# (namespaces, classes, functions, etc.) that should be excluded from the 763*38e8c45fSAndroid Build Coastguard Worker# output. The symbol name can be a fully qualified name, a word, or if the 764*38e8c45fSAndroid Build Coastguard Worker# wildcard * is used, a substring. Examples: ANamespace, AClass, 765*38e8c45fSAndroid Build Coastguard Worker# AClass::ANamespace, ANamespace::*Test 766*38e8c45fSAndroid Build Coastguard Worker 767*38e8c45fSAndroid Build Coastguard WorkerEXCLUDE_SYMBOLS = 768*38e8c45fSAndroid Build Coastguard Worker 769*38e8c45fSAndroid Build Coastguard Worker# The EXAMPLE_PATH tag can be used to specify one or more files or 770*38e8c45fSAndroid Build Coastguard Worker# directories that contain example code fragments that are included (see 771*38e8c45fSAndroid Build Coastguard Worker# the \include command). 772*38e8c45fSAndroid Build Coastguard Worker 773*38e8c45fSAndroid Build Coastguard WorkerEXAMPLE_PATH = 774*38e8c45fSAndroid Build Coastguard Worker 775*38e8c45fSAndroid Build Coastguard Worker# If the value of the EXAMPLE_PATH tag contains directories, you can use the 776*38e8c45fSAndroid Build Coastguard Worker# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 777*38e8c45fSAndroid Build Coastguard Worker# and *.h) to filter out the source-files in the directories. If left 778*38e8c45fSAndroid Build Coastguard Worker# blank all files are included. 779*38e8c45fSAndroid Build Coastguard Worker 780*38e8c45fSAndroid Build Coastguard WorkerEXAMPLE_PATTERNS = * 781*38e8c45fSAndroid Build Coastguard Worker 782*38e8c45fSAndroid Build Coastguard Worker# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 783*38e8c45fSAndroid Build Coastguard Worker# searched for input files to be used with the \include or \dontinclude 784*38e8c45fSAndroid Build Coastguard Worker# commands irrespective of the value of the RECURSIVE tag. 785*38e8c45fSAndroid Build Coastguard Worker# Possible values are YES and NO. If left blank NO is used. 786*38e8c45fSAndroid Build Coastguard Worker 787*38e8c45fSAndroid Build Coastguard WorkerEXAMPLE_RECURSIVE = NO 788*38e8c45fSAndroid Build Coastguard Worker 789*38e8c45fSAndroid Build Coastguard Worker# The IMAGE_PATH tag can be used to specify one or more files or 790*38e8c45fSAndroid Build Coastguard Worker# directories that contain image that are included in the documentation (see 791*38e8c45fSAndroid Build Coastguard Worker# the \image command). 792*38e8c45fSAndroid Build Coastguard Worker 793*38e8c45fSAndroid Build Coastguard WorkerIMAGE_PATH = 794*38e8c45fSAndroid Build Coastguard Worker 795*38e8c45fSAndroid Build Coastguard Worker# The INPUT_FILTER tag can be used to specify a program that doxygen should 796*38e8c45fSAndroid Build Coastguard Worker# invoke to filter for each input file. Doxygen will invoke the filter program 797*38e8c45fSAndroid Build Coastguard Worker# by executing (via popen()) the command <filter> <input-file>, where <filter> 798*38e8c45fSAndroid Build Coastguard Worker# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 799*38e8c45fSAndroid Build Coastguard Worker# input file. Doxygen will then use the output that the filter program writes 800*38e8c45fSAndroid Build Coastguard Worker# to standard output. If FILTER_PATTERNS is specified, this tag will be 801*38e8c45fSAndroid Build Coastguard Worker# ignored. 802*38e8c45fSAndroid Build Coastguard Worker 803*38e8c45fSAndroid Build Coastguard WorkerINPUT_FILTER = 804*38e8c45fSAndroid Build Coastguard Worker 805*38e8c45fSAndroid Build Coastguard Worker# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 806*38e8c45fSAndroid Build Coastguard Worker# basis. Doxygen will compare the file name with each pattern and apply the 807*38e8c45fSAndroid Build Coastguard Worker# filter if there is a match. The filters are a list of the form: 808*38e8c45fSAndroid Build Coastguard Worker# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 809*38e8c45fSAndroid Build Coastguard Worker# info on how filters are used. If FILTER_PATTERNS is empty or if 810*38e8c45fSAndroid Build Coastguard Worker# non of the patterns match the file name, INPUT_FILTER is applied. 811*38e8c45fSAndroid Build Coastguard Worker 812*38e8c45fSAndroid Build Coastguard WorkerFILTER_PATTERNS = 813*38e8c45fSAndroid Build Coastguard Worker 814*38e8c45fSAndroid Build Coastguard Worker# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 815*38e8c45fSAndroid Build Coastguard Worker# INPUT_FILTER) will be used to filter the input files when producing source 816*38e8c45fSAndroid Build Coastguard Worker# files to browse (i.e. when SOURCE_BROWSER is set to YES). 817*38e8c45fSAndroid Build Coastguard Worker 818*38e8c45fSAndroid Build Coastguard WorkerFILTER_SOURCE_FILES = NO 819*38e8c45fSAndroid Build Coastguard Worker 820*38e8c45fSAndroid Build Coastguard Worker# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 821*38e8c45fSAndroid Build Coastguard Worker# pattern. A pattern will override the setting for FILTER_PATTERN (if any) 822*38e8c45fSAndroid Build Coastguard Worker# and it is also possible to disable source filtering for a specific pattern 823*38e8c45fSAndroid Build Coastguard Worker# using *.ext= (so without naming a filter). This option only has effect when 824*38e8c45fSAndroid Build Coastguard Worker# FILTER_SOURCE_FILES is enabled. 825*38e8c45fSAndroid Build Coastguard Worker 826*38e8c45fSAndroid Build Coastguard WorkerFILTER_SOURCE_PATTERNS = 827*38e8c45fSAndroid Build Coastguard Worker 828*38e8c45fSAndroid Build Coastguard Worker# If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that 829*38e8c45fSAndroid Build Coastguard Worker# is part of the input, its contents will be placed on the main page (index.html). 830*38e8c45fSAndroid Build Coastguard Worker# This can be useful if you have a project on for instance GitHub and want reuse 831*38e8c45fSAndroid Build Coastguard Worker# the introduction page also for the doxygen output. 832*38e8c45fSAndroid Build Coastguard Worker 833*38e8c45fSAndroid Build Coastguard WorkerUSE_MDFILE_AS_MAINPAGE = 834*38e8c45fSAndroid Build Coastguard Worker 835*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 836*38e8c45fSAndroid Build Coastguard Worker# configuration options related to source browsing 837*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 838*38e8c45fSAndroid Build Coastguard Worker 839*38e8c45fSAndroid Build Coastguard Worker# If the SOURCE_BROWSER tag is set to YES then a list of source files will 840*38e8c45fSAndroid Build Coastguard Worker# be generated. Documented entities will be cross-referenced with these sources. 841*38e8c45fSAndroid Build Coastguard Worker# Note: To get rid of all source code in the generated output, make sure also 842*38e8c45fSAndroid Build Coastguard Worker# VERBATIM_HEADERS is set to NO. 843*38e8c45fSAndroid Build Coastguard Worker 844*38e8c45fSAndroid Build Coastguard WorkerSOURCE_BROWSER = NO 845*38e8c45fSAndroid Build Coastguard Worker 846*38e8c45fSAndroid Build Coastguard Worker# Setting the INLINE_SOURCES tag to YES will include the body 847*38e8c45fSAndroid Build Coastguard Worker# of functions and classes directly in the documentation. 848*38e8c45fSAndroid Build Coastguard Worker 849*38e8c45fSAndroid Build Coastguard WorkerINLINE_SOURCES = NO 850*38e8c45fSAndroid Build Coastguard Worker 851*38e8c45fSAndroid Build Coastguard Worker# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 852*38e8c45fSAndroid Build Coastguard Worker# doxygen to hide any special comment blocks from generated source code 853*38e8c45fSAndroid Build Coastguard Worker# fragments. Normal C, C++ and Fortran comments will always remain visible. 854*38e8c45fSAndroid Build Coastguard Worker 855*38e8c45fSAndroid Build Coastguard WorkerSTRIP_CODE_COMMENTS = NO 856*38e8c45fSAndroid Build Coastguard Worker 857*38e8c45fSAndroid Build Coastguard Worker# If the REFERENCED_BY_RELATION tag is set to YES 858*38e8c45fSAndroid Build Coastguard Worker# then for each documented function all documented 859*38e8c45fSAndroid Build Coastguard Worker# functions referencing it will be listed. 860*38e8c45fSAndroid Build Coastguard Worker 861*38e8c45fSAndroid Build Coastguard WorkerREFERENCED_BY_RELATION = NO 862*38e8c45fSAndroid Build Coastguard Worker 863*38e8c45fSAndroid Build Coastguard Worker# If the REFERENCES_RELATION tag is set to YES 864*38e8c45fSAndroid Build Coastguard Worker# then for each documented function all documented entities 865*38e8c45fSAndroid Build Coastguard Worker# called/used by that function will be listed. 866*38e8c45fSAndroid Build Coastguard Worker 867*38e8c45fSAndroid Build Coastguard WorkerREFERENCES_RELATION = NO 868*38e8c45fSAndroid Build Coastguard Worker 869*38e8c45fSAndroid Build Coastguard Worker# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 870*38e8c45fSAndroid Build Coastguard Worker# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 871*38e8c45fSAndroid Build Coastguard Worker# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 872*38e8c45fSAndroid Build Coastguard Worker# link to the source code. Otherwise they will link to the documentation. 873*38e8c45fSAndroid Build Coastguard Worker 874*38e8c45fSAndroid Build Coastguard WorkerREFERENCES_LINK_SOURCE = YES 875*38e8c45fSAndroid Build Coastguard Worker 876*38e8c45fSAndroid Build Coastguard Worker# If the USE_HTAGS tag is set to YES then the references to source code 877*38e8c45fSAndroid Build Coastguard Worker# will point to the HTML generated by the htags(1) tool instead of doxygen 878*38e8c45fSAndroid Build Coastguard Worker# built-in source browser. The htags tool is part of GNU's global source 879*38e8c45fSAndroid Build Coastguard Worker# tagging system (see http://www.gnu.org/software/global/global.html). You 880*38e8c45fSAndroid Build Coastguard Worker# will need version 4.8.6 or higher. 881*38e8c45fSAndroid Build Coastguard Worker 882*38e8c45fSAndroid Build Coastguard WorkerUSE_HTAGS = NO 883*38e8c45fSAndroid Build Coastguard Worker 884*38e8c45fSAndroid Build Coastguard Worker# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 885*38e8c45fSAndroid Build Coastguard Worker# will generate a verbatim copy of the header file for each class for 886*38e8c45fSAndroid Build Coastguard Worker# which an include is specified. Set to NO to disable this. 887*38e8c45fSAndroid Build Coastguard Worker 888*38e8c45fSAndroid Build Coastguard WorkerVERBATIM_HEADERS = NO 889*38e8c45fSAndroid Build Coastguard Worker 890*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 891*38e8c45fSAndroid Build Coastguard Worker# configuration options related to the alphabetical class index 892*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 893*38e8c45fSAndroid Build Coastguard Worker 894*38e8c45fSAndroid Build Coastguard Worker# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 895*38e8c45fSAndroid Build Coastguard Worker# of all compounds will be generated. Enable this if the project 896*38e8c45fSAndroid Build Coastguard Worker# contains a lot of classes, structs, unions or interfaces. 897*38e8c45fSAndroid Build Coastguard Worker 898*38e8c45fSAndroid Build Coastguard WorkerALPHABETICAL_INDEX = NO 899*38e8c45fSAndroid Build Coastguard Worker 900*38e8c45fSAndroid Build Coastguard Worker# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 901*38e8c45fSAndroid Build Coastguard Worker# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 902*38e8c45fSAndroid Build Coastguard Worker# in which this list will be split (can be a number in the range [1..20]) 903*38e8c45fSAndroid Build Coastguard Worker 904*38e8c45fSAndroid Build Coastguard WorkerCOLS_IN_ALPHA_INDEX = 5 905*38e8c45fSAndroid Build Coastguard Worker 906*38e8c45fSAndroid Build Coastguard Worker# In case all classes in a project start with a common prefix, all 907*38e8c45fSAndroid Build Coastguard Worker# classes will be put under the same header in the alphabetical index. 908*38e8c45fSAndroid Build Coastguard Worker# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 909*38e8c45fSAndroid Build Coastguard Worker# should be ignored while generating the index headers. 910*38e8c45fSAndroid Build Coastguard Worker 911*38e8c45fSAndroid Build Coastguard WorkerIGNORE_PREFIX = 912*38e8c45fSAndroid Build Coastguard Worker 913*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 914*38e8c45fSAndroid Build Coastguard Worker# configuration options related to the HTML output 915*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 916*38e8c45fSAndroid Build Coastguard Worker 917*38e8c45fSAndroid Build Coastguard Worker# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 918*38e8c45fSAndroid Build Coastguard Worker# generate HTML output. 919*38e8c45fSAndroid Build Coastguard Worker 920*38e8c45fSAndroid Build Coastguard WorkerGENERATE_HTML = YES 921*38e8c45fSAndroid Build Coastguard Worker 922*38e8c45fSAndroid Build Coastguard Worker# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 923*38e8c45fSAndroid Build Coastguard Worker# If a relative path is entered the value of OUTPUT_DIRECTORY will be 924*38e8c45fSAndroid Build Coastguard Worker# put in front of it. If left blank `html' will be used as the default path. 925*38e8c45fSAndroid Build Coastguard Worker 926*38e8c45fSAndroid Build Coastguard WorkerHTML_OUTPUT = $(HTML_OUTPUT) 927*38e8c45fSAndroid Build Coastguard Worker 928*38e8c45fSAndroid Build Coastguard Worker# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 929*38e8c45fSAndroid Build Coastguard Worker# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 930*38e8c45fSAndroid Build Coastguard Worker# doxygen will generate files with .html extension. 931*38e8c45fSAndroid Build Coastguard Worker 932*38e8c45fSAndroid Build Coastguard WorkerHTML_FILE_EXTENSION = .html 933*38e8c45fSAndroid Build Coastguard Worker 934*38e8c45fSAndroid Build Coastguard Worker# The HTML_HEADER tag can be used to specify a personal HTML header for 935*38e8c45fSAndroid Build Coastguard Worker# each generated HTML page. If it is left blank doxygen will generate a 936*38e8c45fSAndroid Build Coastguard Worker# standard header. Note that when using a custom header you are responsible 937*38e8c45fSAndroid Build Coastguard Worker# for the proper inclusion of any scripts and style sheets that doxygen 938*38e8c45fSAndroid Build Coastguard Worker# needs, which is dependent on the configuration options used. 939*38e8c45fSAndroid Build Coastguard Worker# It is advised to generate a default header using "doxygen -w html 940*38e8c45fSAndroid Build Coastguard Worker# header.html footer.html stylesheet.css YourConfigFile" and then modify 941*38e8c45fSAndroid Build Coastguard Worker# that header. Note that the header is subject to change so you typically 942*38e8c45fSAndroid Build Coastguard Worker# have to redo this when upgrading to a newer version of doxygen or when 943*38e8c45fSAndroid Build Coastguard Worker# changing the value of configuration settings such as GENERATE_TREEVIEW! 944*38e8c45fSAndroid Build Coastguard Worker 945*38e8c45fSAndroid Build Coastguard WorkerHTML_HEADER = $(HTML_HEADER) 946*38e8c45fSAndroid Build Coastguard Worker 947*38e8c45fSAndroid Build Coastguard Worker# The HTML_FOOTER tag can be used to specify a personal HTML footer for 948*38e8c45fSAndroid Build Coastguard Worker# each generated HTML page. If it is left blank doxygen will generate a 949*38e8c45fSAndroid Build Coastguard Worker# standard footer. 950*38e8c45fSAndroid Build Coastguard Worker 951*38e8c45fSAndroid Build Coastguard WorkerHTML_FOOTER = $(HTML_FOOTER) 952*38e8c45fSAndroid Build Coastguard Worker 953*38e8c45fSAndroid Build Coastguard Worker# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 954*38e8c45fSAndroid Build Coastguard Worker# style sheet that is used by each HTML page. It can be used to 955*38e8c45fSAndroid Build Coastguard Worker# fine-tune the look of the HTML output. If left blank doxygen will 956*38e8c45fSAndroid Build Coastguard Worker# generate a default style sheet. Note that it is recommended to use 957*38e8c45fSAndroid Build Coastguard Worker# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this 958*38e8c45fSAndroid Build Coastguard Worker# tag will in the future become obsolete. 959*38e8c45fSAndroid Build Coastguard Worker 960*38e8c45fSAndroid Build Coastguard WorkerHTML_STYLESHEET = 961*38e8c45fSAndroid Build Coastguard Worker 962*38e8c45fSAndroid Build Coastguard Worker# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional 963*38e8c45fSAndroid Build Coastguard Worker# user-defined cascading style sheet that is included after the standard 964*38e8c45fSAndroid Build Coastguard Worker# style sheets created by doxygen. Using this option one can overrule 965*38e8c45fSAndroid Build Coastguard Worker# certain style aspects. This is preferred over using HTML_STYLESHEET 966*38e8c45fSAndroid Build Coastguard Worker# since it does not replace the standard style sheet and is therefor more 967*38e8c45fSAndroid Build Coastguard Worker# robust against future updates. Doxygen will copy the style sheet file to 968*38e8c45fSAndroid Build Coastguard Worker# the output directory. 969*38e8c45fSAndroid Build Coastguard Worker 970*38e8c45fSAndroid Build Coastguard WorkerHTML_EXTRA_STYLESHEET = 971*38e8c45fSAndroid Build Coastguard Worker 972*38e8c45fSAndroid Build Coastguard Worker# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 973*38e8c45fSAndroid Build Coastguard Worker# other source files which should be copied to the HTML output directory. Note 974*38e8c45fSAndroid Build Coastguard Worker# that these files will be copied to the base HTML output directory. Use the 975*38e8c45fSAndroid Build Coastguard Worker# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 976*38e8c45fSAndroid Build Coastguard Worker# files. In the HTML_STYLESHEET file, use the file name only. Also note that 977*38e8c45fSAndroid Build Coastguard Worker# the files will be copied as-is; there are no commands or markers available. 978*38e8c45fSAndroid Build Coastguard Worker 979*38e8c45fSAndroid Build Coastguard WorkerHTML_EXTRA_FILES = 980*38e8c45fSAndroid Build Coastguard Worker 981*38e8c45fSAndroid Build Coastguard Worker# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 982*38e8c45fSAndroid Build Coastguard Worker# Doxygen will adjust the colors in the style sheet and background images 983*38e8c45fSAndroid Build Coastguard Worker# according to this color. Hue is specified as an angle on a colorwheel, 984*38e8c45fSAndroid Build Coastguard Worker# see http://en.wikipedia.org/wiki/Hue for more information. 985*38e8c45fSAndroid Build Coastguard Worker# For instance the value 0 represents red, 60 is yellow, 120 is green, 986*38e8c45fSAndroid Build Coastguard Worker# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 987*38e8c45fSAndroid Build Coastguard Worker# The allowed range is 0 to 359. 988*38e8c45fSAndroid Build Coastguard Worker 989*38e8c45fSAndroid Build Coastguard WorkerHTML_COLORSTYLE_HUE = 220 990*38e8c45fSAndroid Build Coastguard Worker 991*38e8c45fSAndroid Build Coastguard Worker# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 992*38e8c45fSAndroid Build Coastguard Worker# the colors in the HTML output. For a value of 0 the output will use 993*38e8c45fSAndroid Build Coastguard Worker# grayscales only. A value of 255 will produce the most vivid colors. 994*38e8c45fSAndroid Build Coastguard Worker 995*38e8c45fSAndroid Build Coastguard WorkerHTML_COLORSTYLE_SAT = 0 996*38e8c45fSAndroid Build Coastguard Worker 997*38e8c45fSAndroid Build Coastguard Worker# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 998*38e8c45fSAndroid Build Coastguard Worker# the luminance component of the colors in the HTML output. Values below 999*38e8c45fSAndroid Build Coastguard Worker# 100 gradually make the output lighter, whereas values above 100 make 1000*38e8c45fSAndroid Build Coastguard Worker# the output darker. The value divided by 100 is the actual gamma applied, 1001*38e8c45fSAndroid Build Coastguard Worker# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 1002*38e8c45fSAndroid Build Coastguard Worker# and 100 does not change the gamma. 1003*38e8c45fSAndroid Build Coastguard Worker 1004*38e8c45fSAndroid Build Coastguard WorkerHTML_COLORSTYLE_GAMMA = 80 1005*38e8c45fSAndroid Build Coastguard Worker 1006*38e8c45fSAndroid Build Coastguard Worker# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1007*38e8c45fSAndroid Build Coastguard Worker# page will contain the date and time when the page was generated. Setting 1008*38e8c45fSAndroid Build Coastguard Worker# this to NO can help when comparing the output of multiple runs. 1009*38e8c45fSAndroid Build Coastguard Worker 1010*38e8c45fSAndroid Build Coastguard WorkerHTML_TIMESTAMP = YES 1011*38e8c45fSAndroid Build Coastguard Worker 1012*38e8c45fSAndroid Build Coastguard Worker# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1013*38e8c45fSAndroid Build Coastguard Worker# documentation will contain sections that can be hidden and shown after the 1014*38e8c45fSAndroid Build Coastguard Worker# page has loaded. 1015*38e8c45fSAndroid Build Coastguard Worker 1016*38e8c45fSAndroid Build Coastguard WorkerHTML_DYNAMIC_SECTIONS = NO 1017*38e8c45fSAndroid Build Coastguard Worker 1018*38e8c45fSAndroid Build Coastguard Worker# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of 1019*38e8c45fSAndroid Build Coastguard Worker# entries shown in the various tree structured indices initially; the user 1020*38e8c45fSAndroid Build Coastguard Worker# can expand and collapse entries dynamically later on. Doxygen will expand 1021*38e8c45fSAndroid Build Coastguard Worker# the tree to such a level that at most the specified number of entries are 1022*38e8c45fSAndroid Build Coastguard Worker# visible (unless a fully collapsed tree already exceeds this amount). 1023*38e8c45fSAndroid Build Coastguard Worker# So setting the number of entries 1 will produce a full collapsed tree by 1024*38e8c45fSAndroid Build Coastguard Worker# default. 0 is a special value representing an infinite number of entries 1025*38e8c45fSAndroid Build Coastguard Worker# and will result in a full expanded tree by default. 1026*38e8c45fSAndroid Build Coastguard Worker 1027*38e8c45fSAndroid Build Coastguard WorkerHTML_INDEX_NUM_ENTRIES = 100 1028*38e8c45fSAndroid Build Coastguard Worker 1029*38e8c45fSAndroid Build Coastguard Worker# If the GENERATE_DOCSET tag is set to YES, additional index files 1030*38e8c45fSAndroid Build Coastguard Worker# will be generated that can be used as input for Apple's Xcode 3 1031*38e8c45fSAndroid Build Coastguard Worker# integrated development environment, introduced with OSX 10.5 (Leopard). 1032*38e8c45fSAndroid Build Coastguard Worker# To create a documentation set, doxygen will generate a Makefile in the 1033*38e8c45fSAndroid Build Coastguard Worker# HTML output directory. Running make will produce the docset in that 1034*38e8c45fSAndroid Build Coastguard Worker# directory and running "make install" will install the docset in 1035*38e8c45fSAndroid Build Coastguard Worker# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 1036*38e8c45fSAndroid Build Coastguard Worker# it at startup. 1037*38e8c45fSAndroid Build Coastguard Worker# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1038*38e8c45fSAndroid Build Coastguard Worker# for more information. 1039*38e8c45fSAndroid Build Coastguard Worker 1040*38e8c45fSAndroid Build Coastguard WorkerGENERATE_DOCSET = NO 1041*38e8c45fSAndroid Build Coastguard Worker 1042*38e8c45fSAndroid Build Coastguard Worker# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 1043*38e8c45fSAndroid Build Coastguard Worker# feed. A documentation feed provides an umbrella under which multiple 1044*38e8c45fSAndroid Build Coastguard Worker# documentation sets from a single provider (such as a company or product suite) 1045*38e8c45fSAndroid Build Coastguard Worker# can be grouped. 1046*38e8c45fSAndroid Build Coastguard Worker 1047*38e8c45fSAndroid Build Coastguard WorkerDOCSET_FEEDNAME = "Doxygen generated docs" 1048*38e8c45fSAndroid Build Coastguard Worker 1049*38e8c45fSAndroid Build Coastguard Worker# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 1050*38e8c45fSAndroid Build Coastguard Worker# should uniquely identify the documentation set bundle. This should be a 1051*38e8c45fSAndroid Build Coastguard Worker# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 1052*38e8c45fSAndroid Build Coastguard Worker# will append .docset to the name. 1053*38e8c45fSAndroid Build Coastguard Worker 1054*38e8c45fSAndroid Build Coastguard WorkerDOCSET_BUNDLE_ID = org.doxygen.Project 1055*38e8c45fSAndroid Build Coastguard Worker 1056*38e8c45fSAndroid Build Coastguard Worker# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely 1057*38e8c45fSAndroid Build Coastguard Worker# identify the documentation publisher. This should be a reverse domain-name 1058*38e8c45fSAndroid Build Coastguard Worker# style string, e.g. com.mycompany.MyDocSet.documentation. 1059*38e8c45fSAndroid Build Coastguard Worker 1060*38e8c45fSAndroid Build Coastguard WorkerDOCSET_PUBLISHER_ID = org.doxygen.Publisher 1061*38e8c45fSAndroid Build Coastguard Worker 1062*38e8c45fSAndroid Build Coastguard Worker# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. 1063*38e8c45fSAndroid Build Coastguard Worker 1064*38e8c45fSAndroid Build Coastguard WorkerDOCSET_PUBLISHER_NAME = Publisher 1065*38e8c45fSAndroid Build Coastguard Worker 1066*38e8c45fSAndroid Build Coastguard Worker# If the GENERATE_HTMLHELP tag is set to YES, additional index files 1067*38e8c45fSAndroid Build Coastguard Worker# will be generated that can be used as input for tools like the 1068*38e8c45fSAndroid Build Coastguard Worker# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 1069*38e8c45fSAndroid Build Coastguard Worker# of the generated HTML documentation. 1070*38e8c45fSAndroid Build Coastguard Worker 1071*38e8c45fSAndroid Build Coastguard WorkerGENERATE_HTMLHELP = NO 1072*38e8c45fSAndroid Build Coastguard Worker 1073*38e8c45fSAndroid Build Coastguard Worker# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 1074*38e8c45fSAndroid Build Coastguard Worker# be used to specify the file name of the resulting .chm file. You 1075*38e8c45fSAndroid Build Coastguard Worker# can add a path in front of the file if the result should not be 1076*38e8c45fSAndroid Build Coastguard Worker# written to the html output directory. 1077*38e8c45fSAndroid Build Coastguard Worker 1078*38e8c45fSAndroid Build Coastguard WorkerCHM_FILE = 1079*38e8c45fSAndroid Build Coastguard Worker 1080*38e8c45fSAndroid Build Coastguard Worker# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 1081*38e8c45fSAndroid Build Coastguard Worker# be used to specify the location (absolute path including file name) of 1082*38e8c45fSAndroid Build Coastguard Worker# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 1083*38e8c45fSAndroid Build Coastguard Worker# the HTML help compiler on the generated index.hhp. 1084*38e8c45fSAndroid Build Coastguard Worker 1085*38e8c45fSAndroid Build Coastguard WorkerHHC_LOCATION = 1086*38e8c45fSAndroid Build Coastguard Worker 1087*38e8c45fSAndroid Build Coastguard Worker# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 1088*38e8c45fSAndroid Build Coastguard Worker# controls if a separate .chi index file is generated (YES) or that 1089*38e8c45fSAndroid Build Coastguard Worker# it should be included in the master .chm file (NO). 1090*38e8c45fSAndroid Build Coastguard Worker 1091*38e8c45fSAndroid Build Coastguard WorkerGENERATE_CHI = NO 1092*38e8c45fSAndroid Build Coastguard Worker 1093*38e8c45fSAndroid Build Coastguard Worker# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 1094*38e8c45fSAndroid Build Coastguard Worker# is used to encode HtmlHelp index (hhk), content (hhc) and project file 1095*38e8c45fSAndroid Build Coastguard Worker# content. 1096*38e8c45fSAndroid Build Coastguard Worker 1097*38e8c45fSAndroid Build Coastguard WorkerCHM_INDEX_ENCODING = 1098*38e8c45fSAndroid Build Coastguard Worker 1099*38e8c45fSAndroid Build Coastguard Worker# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 1100*38e8c45fSAndroid Build Coastguard Worker# controls whether a binary table of contents is generated (YES) or a 1101*38e8c45fSAndroid Build Coastguard Worker# normal table of contents (NO) in the .chm file. 1102*38e8c45fSAndroid Build Coastguard Worker 1103*38e8c45fSAndroid Build Coastguard WorkerBINARY_TOC = NO 1104*38e8c45fSAndroid Build Coastguard Worker 1105*38e8c45fSAndroid Build Coastguard Worker# The TOC_EXPAND flag can be set to YES to add extra items for group members 1106*38e8c45fSAndroid Build Coastguard Worker# to the contents of the HTML help documentation and to the tree view. 1107*38e8c45fSAndroid Build Coastguard Worker 1108*38e8c45fSAndroid Build Coastguard WorkerTOC_EXPAND = NO 1109*38e8c45fSAndroid Build Coastguard Worker 1110*38e8c45fSAndroid Build Coastguard Worker# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1111*38e8c45fSAndroid Build Coastguard Worker# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 1112*38e8c45fSAndroid Build Coastguard Worker# that can be used as input for Qt's qhelpgenerator to generate a 1113*38e8c45fSAndroid Build Coastguard Worker# Qt Compressed Help (.qch) of the generated HTML documentation. 1114*38e8c45fSAndroid Build Coastguard Worker 1115*38e8c45fSAndroid Build Coastguard WorkerGENERATE_QHP = NO 1116*38e8c45fSAndroid Build Coastguard Worker 1117*38e8c45fSAndroid Build Coastguard Worker# If the QHG_LOCATION tag is specified, the QCH_FILE tag can 1118*38e8c45fSAndroid Build Coastguard Worker# be used to specify the file name of the resulting .qch file. 1119*38e8c45fSAndroid Build Coastguard Worker# The path specified is relative to the HTML output folder. 1120*38e8c45fSAndroid Build Coastguard Worker 1121*38e8c45fSAndroid Build Coastguard WorkerQCH_FILE = 1122*38e8c45fSAndroid Build Coastguard Worker 1123*38e8c45fSAndroid Build Coastguard Worker# The QHP_NAMESPACE tag specifies the namespace to use when generating 1124*38e8c45fSAndroid Build Coastguard Worker# Qt Help Project output. For more information please see 1125*38e8c45fSAndroid Build Coastguard Worker# http://doc.trolltech.com/qthelpproject.html#namespace 1126*38e8c45fSAndroid Build Coastguard Worker 1127*38e8c45fSAndroid Build Coastguard WorkerQHP_NAMESPACE = org.doxygen.Project 1128*38e8c45fSAndroid Build Coastguard Worker 1129*38e8c45fSAndroid Build Coastguard Worker# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 1130*38e8c45fSAndroid Build Coastguard Worker# Qt Help Project output. For more information please see 1131*38e8c45fSAndroid Build Coastguard Worker# http://doc.trolltech.com/qthelpproject.html#virtual-folders 1132*38e8c45fSAndroid Build Coastguard Worker 1133*38e8c45fSAndroid Build Coastguard WorkerQHP_VIRTUAL_FOLDER = doc 1134*38e8c45fSAndroid Build Coastguard Worker 1135*38e8c45fSAndroid Build Coastguard Worker# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 1136*38e8c45fSAndroid Build Coastguard Worker# add. For more information please see 1137*38e8c45fSAndroid Build Coastguard Worker# http://doc.trolltech.com/qthelpproject.html#custom-filters 1138*38e8c45fSAndroid Build Coastguard Worker 1139*38e8c45fSAndroid Build Coastguard WorkerQHP_CUST_FILTER_NAME = 1140*38e8c45fSAndroid Build Coastguard Worker 1141*38e8c45fSAndroid Build Coastguard Worker# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 1142*38e8c45fSAndroid Build Coastguard Worker# custom filter to add. For more information please see 1143*38e8c45fSAndroid Build Coastguard Worker# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> 1144*38e8c45fSAndroid Build Coastguard Worker# Qt Help Project / Custom Filters</a>. 1145*38e8c45fSAndroid Build Coastguard Worker 1146*38e8c45fSAndroid Build Coastguard WorkerQHP_CUST_FILTER_ATTRS = 1147*38e8c45fSAndroid Build Coastguard Worker 1148*38e8c45fSAndroid Build Coastguard Worker# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1149*38e8c45fSAndroid Build Coastguard Worker# project's 1150*38e8c45fSAndroid Build Coastguard Worker# filter section matches. 1151*38e8c45fSAndroid Build Coastguard Worker# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> 1152*38e8c45fSAndroid Build Coastguard Worker# Qt Help Project / Filter Attributes</a>. 1153*38e8c45fSAndroid Build Coastguard Worker 1154*38e8c45fSAndroid Build Coastguard WorkerQHP_SECT_FILTER_ATTRS = 1155*38e8c45fSAndroid Build Coastguard Worker 1156*38e8c45fSAndroid Build Coastguard Worker# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 1157*38e8c45fSAndroid Build Coastguard Worker# be used to specify the location of Qt's qhelpgenerator. 1158*38e8c45fSAndroid Build Coastguard Worker# If non-empty doxygen will try to run qhelpgenerator on the generated 1159*38e8c45fSAndroid Build Coastguard Worker# .qhp file. 1160*38e8c45fSAndroid Build Coastguard Worker 1161*38e8c45fSAndroid Build Coastguard WorkerQHG_LOCATION = 1162*38e8c45fSAndroid Build Coastguard Worker 1163*38e8c45fSAndroid Build Coastguard Worker# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 1164*38e8c45fSAndroid Build Coastguard Worker# will be generated, which together with the HTML files, form an Eclipse help 1165*38e8c45fSAndroid Build Coastguard Worker# plugin. To install this plugin and make it available under the help contents 1166*38e8c45fSAndroid Build Coastguard Worker# menu in Eclipse, the contents of the directory containing the HTML and XML 1167*38e8c45fSAndroid Build Coastguard Worker# files needs to be copied into the plugins directory of eclipse. The name of 1168*38e8c45fSAndroid Build Coastguard Worker# the directory within the plugins directory should be the same as 1169*38e8c45fSAndroid Build Coastguard Worker# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 1170*38e8c45fSAndroid Build Coastguard Worker# the help appears. 1171*38e8c45fSAndroid Build Coastguard Worker 1172*38e8c45fSAndroid Build Coastguard WorkerGENERATE_ECLIPSEHELP = NO 1173*38e8c45fSAndroid Build Coastguard Worker 1174*38e8c45fSAndroid Build Coastguard Worker# A unique identifier for the eclipse help plugin. When installing the plugin 1175*38e8c45fSAndroid Build Coastguard Worker# the directory name containing the HTML and XML files should also have 1176*38e8c45fSAndroid Build Coastguard Worker# this name. 1177*38e8c45fSAndroid Build Coastguard Worker 1178*38e8c45fSAndroid Build Coastguard WorkerECLIPSE_DOC_ID = org.doxygen.Project 1179*38e8c45fSAndroid Build Coastguard Worker 1180*38e8c45fSAndroid Build Coastguard Worker# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) 1181*38e8c45fSAndroid Build Coastguard Worker# at top of each HTML page. The value NO (the default) enables the index and 1182*38e8c45fSAndroid Build Coastguard Worker# the value YES disables it. Since the tabs have the same information as the 1183*38e8c45fSAndroid Build Coastguard Worker# navigation tree you can set this option to NO if you already set 1184*38e8c45fSAndroid Build Coastguard Worker# GENERATE_TREEVIEW to YES. 1185*38e8c45fSAndroid Build Coastguard Worker 1186*38e8c45fSAndroid Build Coastguard WorkerDISABLE_INDEX = YES 1187*38e8c45fSAndroid Build Coastguard Worker 1188*38e8c45fSAndroid Build Coastguard Worker# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1189*38e8c45fSAndroid Build Coastguard Worker# structure should be generated to display hierarchical information. 1190*38e8c45fSAndroid Build Coastguard Worker# If the tag value is set to YES, a side panel will be generated 1191*38e8c45fSAndroid Build Coastguard Worker# containing a tree-like index structure (just like the one that 1192*38e8c45fSAndroid Build Coastguard Worker# is generated for HTML Help). For this to work a browser that supports 1193*38e8c45fSAndroid Build Coastguard Worker# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 1194*38e8c45fSAndroid Build Coastguard Worker# Windows users are probably better off using the HTML help feature. 1195*38e8c45fSAndroid Build Coastguard Worker# Since the tree basically has the same information as the tab index you 1196*38e8c45fSAndroid Build Coastguard Worker# could consider to set DISABLE_INDEX to NO when enabling this option. 1197*38e8c45fSAndroid Build Coastguard Worker 1198*38e8c45fSAndroid Build Coastguard WorkerGENERATE_TREEVIEW = NO 1199*38e8c45fSAndroid Build Coastguard Worker 1200*38e8c45fSAndroid Build Coastguard Worker# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 1201*38e8c45fSAndroid Build Coastguard Worker# (range [0,1..20]) that doxygen will group on one line in the generated HTML 1202*38e8c45fSAndroid Build Coastguard Worker# documentation. Note that a value of 0 will completely suppress the enum 1203*38e8c45fSAndroid Build Coastguard Worker# values from appearing in the overview section. 1204*38e8c45fSAndroid Build Coastguard Worker 1205*38e8c45fSAndroid Build Coastguard WorkerENUM_VALUES_PER_LINE = 4 1206*38e8c45fSAndroid Build Coastguard Worker 1207*38e8c45fSAndroid Build Coastguard Worker# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 1208*38e8c45fSAndroid Build Coastguard Worker# used to set the initial width (in pixels) of the frame in which the tree 1209*38e8c45fSAndroid Build Coastguard Worker# is shown. 1210*38e8c45fSAndroid Build Coastguard Worker 1211*38e8c45fSAndroid Build Coastguard WorkerTREEVIEW_WIDTH = 250 1212*38e8c45fSAndroid Build Coastguard Worker 1213*38e8c45fSAndroid Build Coastguard Worker# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 1214*38e8c45fSAndroid Build Coastguard Worker# links to external symbols imported via tag files in a separate window. 1215*38e8c45fSAndroid Build Coastguard Worker 1216*38e8c45fSAndroid Build Coastguard WorkerEXT_LINKS_IN_WINDOW = NO 1217*38e8c45fSAndroid Build Coastguard Worker 1218*38e8c45fSAndroid Build Coastguard Worker# Use this tag to change the font size of Latex formulas included 1219*38e8c45fSAndroid Build Coastguard Worker# as images in the HTML documentation. The default is 10. Note that 1220*38e8c45fSAndroid Build Coastguard Worker# when you change the font size after a successful doxygen run you need 1221*38e8c45fSAndroid Build Coastguard Worker# to manually remove any form_*.png images from the HTML output directory 1222*38e8c45fSAndroid Build Coastguard Worker# to force them to be regenerated. 1223*38e8c45fSAndroid Build Coastguard Worker 1224*38e8c45fSAndroid Build Coastguard WorkerFORMULA_FONTSIZE = 10 1225*38e8c45fSAndroid Build Coastguard Worker 1226*38e8c45fSAndroid Build Coastguard Worker# Use the FORMULA_TRANPARENT tag to determine whether or not the images 1227*38e8c45fSAndroid Build Coastguard Worker# generated for formulas are transparent PNGs. Transparent PNGs are 1228*38e8c45fSAndroid Build Coastguard Worker# not supported properly for IE 6.0, but are supported on all modern browsers. 1229*38e8c45fSAndroid Build Coastguard Worker# Note that when changing this option you need to delete any form_*.png files 1230*38e8c45fSAndroid Build Coastguard Worker# in the HTML output before the changes have effect. 1231*38e8c45fSAndroid Build Coastguard Worker 1232*38e8c45fSAndroid Build Coastguard WorkerFORMULA_TRANSPARENT = YES 1233*38e8c45fSAndroid Build Coastguard Worker 1234*38e8c45fSAndroid Build Coastguard Worker# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 1235*38e8c45fSAndroid Build Coastguard Worker# (see http://www.mathjax.org) which uses client side Javascript for the 1236*38e8c45fSAndroid Build Coastguard Worker# rendering instead of using prerendered bitmaps. Use this if you do not 1237*38e8c45fSAndroid Build Coastguard Worker# have LaTeX installed or if you want to formulas look prettier in the HTML 1238*38e8c45fSAndroid Build Coastguard Worker# output. When enabled you may also need to install MathJax separately and 1239*38e8c45fSAndroid Build Coastguard Worker# configure the path to it using the MATHJAX_RELPATH option. 1240*38e8c45fSAndroid Build Coastguard Worker 1241*38e8c45fSAndroid Build Coastguard WorkerUSE_MATHJAX = NO 1242*38e8c45fSAndroid Build Coastguard Worker 1243*38e8c45fSAndroid Build Coastguard Worker# When MathJax is enabled you can set the default output format to be used for 1244*38e8c45fSAndroid Build Coastguard Worker# thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and 1245*38e8c45fSAndroid Build Coastguard Worker# SVG. The default value is HTML-CSS, which is slower, but has the best 1246*38e8c45fSAndroid Build Coastguard Worker# compatibility. 1247*38e8c45fSAndroid Build Coastguard Worker 1248*38e8c45fSAndroid Build Coastguard WorkerMATHJAX_FORMAT = HTML-CSS 1249*38e8c45fSAndroid Build Coastguard Worker 1250*38e8c45fSAndroid Build Coastguard Worker# When MathJax is enabled you need to specify the location relative to the 1251*38e8c45fSAndroid Build Coastguard Worker# HTML output directory using the MATHJAX_RELPATH option. The destination 1252*38e8c45fSAndroid Build Coastguard Worker# directory should contain the MathJax.js script. For instance, if the mathjax 1253*38e8c45fSAndroid Build Coastguard Worker# directory is located at the same level as the HTML output directory, then 1254*38e8c45fSAndroid Build Coastguard Worker# MATHJAX_RELPATH should be ../mathjax. The default value points to 1255*38e8c45fSAndroid Build Coastguard Worker# the MathJax Content Delivery Network so you can quickly see the result without 1256*38e8c45fSAndroid Build Coastguard Worker# installing MathJax. However, it is strongly recommended to install a local 1257*38e8c45fSAndroid Build Coastguard Worker# copy of MathJax from http://www.mathjax.org before deployment. 1258*38e8c45fSAndroid Build Coastguard Worker 1259*38e8c45fSAndroid Build Coastguard WorkerMATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1260*38e8c45fSAndroid Build Coastguard Worker 1261*38e8c45fSAndroid Build Coastguard Worker# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension 1262*38e8c45fSAndroid Build Coastguard Worker# names that should be enabled during MathJax rendering. 1263*38e8c45fSAndroid Build Coastguard Worker 1264*38e8c45fSAndroid Build Coastguard WorkerMATHJAX_EXTENSIONS = 1265*38e8c45fSAndroid Build Coastguard Worker 1266*38e8c45fSAndroid Build Coastguard Worker# When the SEARCHENGINE tag is enabled doxygen will generate a search box 1267*38e8c45fSAndroid Build Coastguard Worker# for the HTML output. The underlying search engine uses javascript 1268*38e8c45fSAndroid Build Coastguard Worker# and DHTML and should work on any modern browser. Note that when using 1269*38e8c45fSAndroid Build Coastguard Worker# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 1270*38e8c45fSAndroid Build Coastguard Worker# (GENERATE_DOCSET) there is already a search function so this one should 1271*38e8c45fSAndroid Build Coastguard Worker# typically be disabled. For large projects the javascript based search engine 1272*38e8c45fSAndroid Build Coastguard Worker# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 1273*38e8c45fSAndroid Build Coastguard Worker 1274*38e8c45fSAndroid Build Coastguard WorkerSEARCHENGINE = NO 1275*38e8c45fSAndroid Build Coastguard Worker 1276*38e8c45fSAndroid Build Coastguard Worker# When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1277*38e8c45fSAndroid Build Coastguard Worker# implemented using a web server instead of a web client using Javascript. 1278*38e8c45fSAndroid Build Coastguard Worker# There are two flavours of web server based search depending on the 1279*38e8c45fSAndroid Build Coastguard Worker# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for 1280*38e8c45fSAndroid Build Coastguard Worker# searching and an index file used by the script. When EXTERNAL_SEARCH is 1281*38e8c45fSAndroid Build Coastguard Worker# enabled the indexing and searching needs to be provided by external tools. 1282*38e8c45fSAndroid Build Coastguard Worker# See the manual for details. 1283*38e8c45fSAndroid Build Coastguard Worker 1284*38e8c45fSAndroid Build Coastguard WorkerSERVER_BASED_SEARCH = NO 1285*38e8c45fSAndroid Build Coastguard Worker 1286*38e8c45fSAndroid Build Coastguard Worker# When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP 1287*38e8c45fSAndroid Build Coastguard Worker# script for searching. Instead the search results are written to an XML file 1288*38e8c45fSAndroid Build Coastguard Worker# which needs to be processed by an external indexer. Doxygen will invoke an 1289*38e8c45fSAndroid Build Coastguard Worker# external search engine pointed to by the SEARCHENGINE_URL option to obtain 1290*38e8c45fSAndroid Build Coastguard Worker# the search results. Doxygen ships with an example indexer (doxyindexer) and 1291*38e8c45fSAndroid Build Coastguard Worker# search engine (doxysearch.cgi) which are based on the open source search engine 1292*38e8c45fSAndroid Build Coastguard Worker# library Xapian. See the manual for configuration details. 1293*38e8c45fSAndroid Build Coastguard Worker 1294*38e8c45fSAndroid Build Coastguard WorkerEXTERNAL_SEARCH = NO 1295*38e8c45fSAndroid Build Coastguard Worker 1296*38e8c45fSAndroid Build Coastguard Worker# The SEARCHENGINE_URL should point to a search engine hosted by a web server 1297*38e8c45fSAndroid Build Coastguard Worker# which will returned the search results when EXTERNAL_SEARCH is enabled. 1298*38e8c45fSAndroid Build Coastguard Worker# Doxygen ships with an example search engine (doxysearch) which is based on 1299*38e8c45fSAndroid Build Coastguard Worker# the open source search engine library Xapian. See the manual for configuration 1300*38e8c45fSAndroid Build Coastguard Worker# details. 1301*38e8c45fSAndroid Build Coastguard Worker 1302*38e8c45fSAndroid Build Coastguard WorkerSEARCHENGINE_URL = 1303*38e8c45fSAndroid Build Coastguard Worker 1304*38e8c45fSAndroid Build Coastguard Worker# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed 1305*38e8c45fSAndroid Build Coastguard Worker# search data is written to a file for indexing by an external tool. With the 1306*38e8c45fSAndroid Build Coastguard Worker# SEARCHDATA_FILE tag the name of this file can be specified. 1307*38e8c45fSAndroid Build Coastguard Worker 1308*38e8c45fSAndroid Build Coastguard WorkerSEARCHDATA_FILE = searchdata.xml 1309*38e8c45fSAndroid Build Coastguard Worker 1310*38e8c45fSAndroid Build Coastguard Worker# When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the 1311*38e8c45fSAndroid Build Coastguard Worker# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is 1312*38e8c45fSAndroid Build Coastguard Worker# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple 1313*38e8c45fSAndroid Build Coastguard Worker# projects and redirect the results back to the right project. 1314*38e8c45fSAndroid Build Coastguard Worker 1315*38e8c45fSAndroid Build Coastguard WorkerEXTERNAL_SEARCH_ID = 1316*38e8c45fSAndroid Build Coastguard Worker 1317*38e8c45fSAndroid Build Coastguard Worker# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen 1318*38e8c45fSAndroid Build Coastguard Worker# projects other than the one defined by this configuration file, but that are 1319*38e8c45fSAndroid Build Coastguard Worker# all added to the same external search index. Each project needs to have a 1320*38e8c45fSAndroid Build Coastguard Worker# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id 1321*38e8c45fSAndroid Build Coastguard Worker# of to a relative location where the documentation can be found. 1322*38e8c45fSAndroid Build Coastguard Worker# The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ... 1323*38e8c45fSAndroid Build Coastguard Worker 1324*38e8c45fSAndroid Build Coastguard WorkerEXTRA_SEARCH_MAPPINGS = 1325*38e8c45fSAndroid Build Coastguard Worker 1326*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 1327*38e8c45fSAndroid Build Coastguard Worker# configuration options related to the LaTeX output 1328*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 1329*38e8c45fSAndroid Build Coastguard Worker 1330*38e8c45fSAndroid Build Coastguard Worker# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 1331*38e8c45fSAndroid Build Coastguard Worker# generate Latex output. 1332*38e8c45fSAndroid Build Coastguard Worker 1333*38e8c45fSAndroid Build Coastguard WorkerGENERATE_LATEX = NO 1334*38e8c45fSAndroid Build Coastguard Worker 1335*38e8c45fSAndroid Build Coastguard Worker# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 1336*38e8c45fSAndroid Build Coastguard Worker# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1337*38e8c45fSAndroid Build Coastguard Worker# put in front of it. If left blank `latex' will be used as the default path. 1338*38e8c45fSAndroid Build Coastguard Worker 1339*38e8c45fSAndroid Build Coastguard WorkerLATEX_OUTPUT = latex 1340*38e8c45fSAndroid Build Coastguard Worker 1341*38e8c45fSAndroid Build Coastguard Worker# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1342*38e8c45fSAndroid Build Coastguard Worker# invoked. If left blank `latex' will be used as the default command name. 1343*38e8c45fSAndroid Build Coastguard Worker# Note that when enabling USE_PDFLATEX this option is only used for 1344*38e8c45fSAndroid Build Coastguard Worker# generating bitmaps for formulas in the HTML output, but not in the 1345*38e8c45fSAndroid Build Coastguard Worker# Makefile that is written to the output directory. 1346*38e8c45fSAndroid Build Coastguard Worker 1347*38e8c45fSAndroid Build Coastguard WorkerLATEX_CMD_NAME = latex 1348*38e8c45fSAndroid Build Coastguard Worker 1349*38e8c45fSAndroid Build Coastguard Worker# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 1350*38e8c45fSAndroid Build Coastguard Worker# generate index for LaTeX. If left blank `makeindex' will be used as the 1351*38e8c45fSAndroid Build Coastguard Worker# default command name. 1352*38e8c45fSAndroid Build Coastguard Worker 1353*38e8c45fSAndroid Build Coastguard WorkerMAKEINDEX_CMD_NAME = makeindex 1354*38e8c45fSAndroid Build Coastguard Worker 1355*38e8c45fSAndroid Build Coastguard Worker# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 1356*38e8c45fSAndroid Build Coastguard Worker# LaTeX documents. This may be useful for small projects and may help to 1357*38e8c45fSAndroid Build Coastguard Worker# save some trees in general. 1358*38e8c45fSAndroid Build Coastguard Worker 1359*38e8c45fSAndroid Build Coastguard WorkerCOMPACT_LATEX = NO 1360*38e8c45fSAndroid Build Coastguard Worker 1361*38e8c45fSAndroid Build Coastguard Worker# The PAPER_TYPE tag can be used to set the paper type that is used 1362*38e8c45fSAndroid Build Coastguard Worker# by the printer. Possible values are: a4, letter, legal and 1363*38e8c45fSAndroid Build Coastguard Worker# executive. If left blank a4wide will be used. 1364*38e8c45fSAndroid Build Coastguard Worker 1365*38e8c45fSAndroid Build Coastguard WorkerPAPER_TYPE = a4 1366*38e8c45fSAndroid Build Coastguard Worker 1367*38e8c45fSAndroid Build Coastguard Worker# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 1368*38e8c45fSAndroid Build Coastguard Worker# packages that should be included in the LaTeX output. 1369*38e8c45fSAndroid Build Coastguard Worker 1370*38e8c45fSAndroid Build Coastguard WorkerEXTRA_PACKAGES = 1371*38e8c45fSAndroid Build Coastguard Worker 1372*38e8c45fSAndroid Build Coastguard Worker# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 1373*38e8c45fSAndroid Build Coastguard Worker# the generated latex document. The header should contain everything until 1374*38e8c45fSAndroid Build Coastguard Worker# the first chapter. If it is left blank doxygen will generate a 1375*38e8c45fSAndroid Build Coastguard Worker# standard header. Notice: only use this tag if you know what you are doing! 1376*38e8c45fSAndroid Build Coastguard Worker 1377*38e8c45fSAndroid Build Coastguard WorkerLATEX_HEADER = 1378*38e8c45fSAndroid Build Coastguard Worker 1379*38e8c45fSAndroid Build Coastguard Worker# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for 1380*38e8c45fSAndroid Build Coastguard Worker# the generated latex document. The footer should contain everything after 1381*38e8c45fSAndroid Build Coastguard Worker# the last chapter. If it is left blank doxygen will generate a 1382*38e8c45fSAndroid Build Coastguard Worker# standard footer. Notice: only use this tag if you know what you are doing! 1383*38e8c45fSAndroid Build Coastguard Worker 1384*38e8c45fSAndroid Build Coastguard WorkerLATEX_FOOTER = 1385*38e8c45fSAndroid Build Coastguard Worker 1386*38e8c45fSAndroid Build Coastguard Worker# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1387*38e8c45fSAndroid Build Coastguard Worker# is prepared for conversion to pdf (using ps2pdf). The pdf file will 1388*38e8c45fSAndroid Build Coastguard Worker# contain links (just like the HTML output) instead of page references 1389*38e8c45fSAndroid Build Coastguard Worker# This makes the output suitable for online browsing using a pdf viewer. 1390*38e8c45fSAndroid Build Coastguard Worker 1391*38e8c45fSAndroid Build Coastguard WorkerPDF_HYPERLINKS = YES 1392*38e8c45fSAndroid Build Coastguard Worker 1393*38e8c45fSAndroid Build Coastguard Worker# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 1394*38e8c45fSAndroid Build Coastguard Worker# plain latex in the generated Makefile. Set this option to YES to get a 1395*38e8c45fSAndroid Build Coastguard Worker# higher quality PDF documentation. 1396*38e8c45fSAndroid Build Coastguard Worker 1397*38e8c45fSAndroid Build Coastguard WorkerUSE_PDFLATEX = YES 1398*38e8c45fSAndroid Build Coastguard Worker 1399*38e8c45fSAndroid Build Coastguard Worker# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 1400*38e8c45fSAndroid Build Coastguard Worker# command to the generated LaTeX files. This will instruct LaTeX to keep 1401*38e8c45fSAndroid Build Coastguard Worker# running if errors occur, instead of asking the user for help. 1402*38e8c45fSAndroid Build Coastguard Worker# This option is also used when generating formulas in HTML. 1403*38e8c45fSAndroid Build Coastguard Worker 1404*38e8c45fSAndroid Build Coastguard WorkerLATEX_BATCHMODE = NO 1405*38e8c45fSAndroid Build Coastguard Worker 1406*38e8c45fSAndroid Build Coastguard Worker# If LATEX_HIDE_INDICES is set to YES then doxygen will not 1407*38e8c45fSAndroid Build Coastguard Worker# include the index chapters (such as File Index, Compound Index, etc.) 1408*38e8c45fSAndroid Build Coastguard Worker# in the output. 1409*38e8c45fSAndroid Build Coastguard Worker 1410*38e8c45fSAndroid Build Coastguard WorkerLATEX_HIDE_INDICES = NO 1411*38e8c45fSAndroid Build Coastguard Worker 1412*38e8c45fSAndroid Build Coastguard Worker# If LATEX_SOURCE_CODE is set to YES then doxygen will include 1413*38e8c45fSAndroid Build Coastguard Worker# source code with syntax highlighting in the LaTeX output. 1414*38e8c45fSAndroid Build Coastguard Worker# Note that which sources are shown also depends on other settings 1415*38e8c45fSAndroid Build Coastguard Worker# such as SOURCE_BROWSER. 1416*38e8c45fSAndroid Build Coastguard Worker 1417*38e8c45fSAndroid Build Coastguard WorkerLATEX_SOURCE_CODE = NO 1418*38e8c45fSAndroid Build Coastguard Worker 1419*38e8c45fSAndroid Build Coastguard Worker# The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1420*38e8c45fSAndroid Build Coastguard Worker# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See 1421*38e8c45fSAndroid Build Coastguard Worker# http://en.wikipedia.org/wiki/BibTeX for more info. 1422*38e8c45fSAndroid Build Coastguard Worker 1423*38e8c45fSAndroid Build Coastguard WorkerLATEX_BIB_STYLE = plain 1424*38e8c45fSAndroid Build Coastguard Worker 1425*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 1426*38e8c45fSAndroid Build Coastguard Worker# configuration options related to the RTF output 1427*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 1428*38e8c45fSAndroid Build Coastguard Worker 1429*38e8c45fSAndroid Build Coastguard Worker# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1430*38e8c45fSAndroid Build Coastguard Worker# The RTF output is optimized for Word 97 and may not look very pretty with 1431*38e8c45fSAndroid Build Coastguard Worker# other RTF readers or editors. 1432*38e8c45fSAndroid Build Coastguard Worker 1433*38e8c45fSAndroid Build Coastguard WorkerGENERATE_RTF = NO 1434*38e8c45fSAndroid Build Coastguard Worker 1435*38e8c45fSAndroid Build Coastguard Worker# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 1436*38e8c45fSAndroid Build Coastguard Worker# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1437*38e8c45fSAndroid Build Coastguard Worker# put in front of it. If left blank `rtf' will be used as the default path. 1438*38e8c45fSAndroid Build Coastguard Worker 1439*38e8c45fSAndroid Build Coastguard WorkerRTF_OUTPUT = rtf 1440*38e8c45fSAndroid Build Coastguard Worker 1441*38e8c45fSAndroid Build Coastguard Worker# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 1442*38e8c45fSAndroid Build Coastguard Worker# RTF documents. This may be useful for small projects and may help to 1443*38e8c45fSAndroid Build Coastguard Worker# save some trees in general. 1444*38e8c45fSAndroid Build Coastguard Worker 1445*38e8c45fSAndroid Build Coastguard WorkerCOMPACT_RTF = NO 1446*38e8c45fSAndroid Build Coastguard Worker 1447*38e8c45fSAndroid Build Coastguard Worker# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 1448*38e8c45fSAndroid Build Coastguard Worker# will contain hyperlink fields. The RTF file will 1449*38e8c45fSAndroid Build Coastguard Worker# contain links (just like the HTML output) instead of page references. 1450*38e8c45fSAndroid Build Coastguard Worker# This makes the output suitable for online browsing using WORD or other 1451*38e8c45fSAndroid Build Coastguard Worker# programs which support those fields. 1452*38e8c45fSAndroid Build Coastguard Worker# Note: wordpad (write) and others do not support links. 1453*38e8c45fSAndroid Build Coastguard Worker 1454*38e8c45fSAndroid Build Coastguard WorkerRTF_HYPERLINKS = NO 1455*38e8c45fSAndroid Build Coastguard Worker 1456*38e8c45fSAndroid Build Coastguard Worker# Load style sheet definitions from file. Syntax is similar to doxygen's 1457*38e8c45fSAndroid Build Coastguard Worker# config file, i.e. a series of assignments. You only have to provide 1458*38e8c45fSAndroid Build Coastguard Worker# replacements, missing definitions are set to their default value. 1459*38e8c45fSAndroid Build Coastguard Worker 1460*38e8c45fSAndroid Build Coastguard WorkerRTF_STYLESHEET_FILE = 1461*38e8c45fSAndroid Build Coastguard Worker 1462*38e8c45fSAndroid Build Coastguard Worker# Set optional variables used in the generation of an rtf document. 1463*38e8c45fSAndroid Build Coastguard Worker# Syntax is similar to doxygen's config file. 1464*38e8c45fSAndroid Build Coastguard Worker 1465*38e8c45fSAndroid Build Coastguard WorkerRTF_EXTENSIONS_FILE = 1466*38e8c45fSAndroid Build Coastguard Worker 1467*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 1468*38e8c45fSAndroid Build Coastguard Worker# configuration options related to the man page output 1469*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 1470*38e8c45fSAndroid Build Coastguard Worker 1471*38e8c45fSAndroid Build Coastguard Worker# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1472*38e8c45fSAndroid Build Coastguard Worker# generate man pages 1473*38e8c45fSAndroid Build Coastguard Worker 1474*38e8c45fSAndroid Build Coastguard WorkerGENERATE_MAN = NO 1475*38e8c45fSAndroid Build Coastguard Worker 1476*38e8c45fSAndroid Build Coastguard Worker# The MAN_OUTPUT tag is used to specify where the man pages will be put. 1477*38e8c45fSAndroid Build Coastguard Worker# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1478*38e8c45fSAndroid Build Coastguard Worker# put in front of it. If left blank `man' will be used as the default path. 1479*38e8c45fSAndroid Build Coastguard Worker 1480*38e8c45fSAndroid Build Coastguard WorkerMAN_OUTPUT = man 1481*38e8c45fSAndroid Build Coastguard Worker 1482*38e8c45fSAndroid Build Coastguard Worker# The MAN_EXTENSION tag determines the extension that is added to 1483*38e8c45fSAndroid Build Coastguard Worker# the generated man pages (default is the subroutine's section .3) 1484*38e8c45fSAndroid Build Coastguard Worker 1485*38e8c45fSAndroid Build Coastguard WorkerMAN_EXTENSION = .3 1486*38e8c45fSAndroid Build Coastguard Worker 1487*38e8c45fSAndroid Build Coastguard Worker# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 1488*38e8c45fSAndroid Build Coastguard Worker# then it will generate one additional man file for each entity 1489*38e8c45fSAndroid Build Coastguard Worker# documented in the real man page(s). These additional files 1490*38e8c45fSAndroid Build Coastguard Worker# only source the real man page, but without them the man command 1491*38e8c45fSAndroid Build Coastguard Worker# would be unable to find the correct page. The default is NO. 1492*38e8c45fSAndroid Build Coastguard Worker 1493*38e8c45fSAndroid Build Coastguard WorkerMAN_LINKS = NO 1494*38e8c45fSAndroid Build Coastguard Worker 1495*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 1496*38e8c45fSAndroid Build Coastguard Worker# configuration options related to the XML output 1497*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 1498*38e8c45fSAndroid Build Coastguard Worker 1499*38e8c45fSAndroid Build Coastguard Worker# If the GENERATE_XML tag is set to YES Doxygen will 1500*38e8c45fSAndroid Build Coastguard Worker# generate an XML file that captures the structure of 1501*38e8c45fSAndroid Build Coastguard Worker# the code including all documentation. 1502*38e8c45fSAndroid Build Coastguard Worker 1503*38e8c45fSAndroid Build Coastguard WorkerGENERATE_XML = NO 1504*38e8c45fSAndroid Build Coastguard Worker 1505*38e8c45fSAndroid Build Coastguard Worker# The XML_OUTPUT tag is used to specify where the XML pages will be put. 1506*38e8c45fSAndroid Build Coastguard Worker# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1507*38e8c45fSAndroid Build Coastguard Worker# put in front of it. If left blank `xml' will be used as the default path. 1508*38e8c45fSAndroid Build Coastguard Worker 1509*38e8c45fSAndroid Build Coastguard WorkerXML_OUTPUT = xml 1510*38e8c45fSAndroid Build Coastguard Worker 1511*38e8c45fSAndroid Build Coastguard Worker# The XML_SCHEMA tag can be used to specify an XML schema, 1512*38e8c45fSAndroid Build Coastguard Worker# which can be used by a validating XML parser to check the 1513*38e8c45fSAndroid Build Coastguard Worker# syntax of the XML files. 1514*38e8c45fSAndroid Build Coastguard Worker 1515*38e8c45fSAndroid Build Coastguard WorkerXML_SCHEMA = 1516*38e8c45fSAndroid Build Coastguard Worker 1517*38e8c45fSAndroid Build Coastguard Worker# The XML_DTD tag can be used to specify an XML DTD, 1518*38e8c45fSAndroid Build Coastguard Worker# which can be used by a validating XML parser to check the 1519*38e8c45fSAndroid Build Coastguard Worker# syntax of the XML files. 1520*38e8c45fSAndroid Build Coastguard Worker 1521*38e8c45fSAndroid Build Coastguard WorkerXML_DTD = 1522*38e8c45fSAndroid Build Coastguard Worker 1523*38e8c45fSAndroid Build Coastguard Worker# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1524*38e8c45fSAndroid Build Coastguard Worker# dump the program listings (including syntax highlighting 1525*38e8c45fSAndroid Build Coastguard Worker# and cross-referencing information) to the XML output. Note that 1526*38e8c45fSAndroid Build Coastguard Worker# enabling this will significantly increase the size of the XML output. 1527*38e8c45fSAndroid Build Coastguard Worker 1528*38e8c45fSAndroid Build Coastguard WorkerXML_PROGRAMLISTING = YES 1529*38e8c45fSAndroid Build Coastguard Worker 1530*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 1531*38e8c45fSAndroid Build Coastguard Worker# configuration options for the AutoGen Definitions output 1532*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 1533*38e8c45fSAndroid Build Coastguard Worker 1534*38e8c45fSAndroid Build Coastguard Worker# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1535*38e8c45fSAndroid Build Coastguard Worker# generate an AutoGen Definitions (see autogen.sf.net) file 1536*38e8c45fSAndroid Build Coastguard Worker# that captures the structure of the code including all 1537*38e8c45fSAndroid Build Coastguard Worker# documentation. Note that this feature is still experimental 1538*38e8c45fSAndroid Build Coastguard Worker# and incomplete at the moment. 1539*38e8c45fSAndroid Build Coastguard Worker 1540*38e8c45fSAndroid Build Coastguard WorkerGENERATE_AUTOGEN_DEF = NO 1541*38e8c45fSAndroid Build Coastguard Worker 1542*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 1543*38e8c45fSAndroid Build Coastguard Worker# configuration options related to the Perl module output 1544*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 1545*38e8c45fSAndroid Build Coastguard Worker 1546*38e8c45fSAndroid Build Coastguard Worker# If the GENERATE_PERLMOD tag is set to YES Doxygen will 1547*38e8c45fSAndroid Build Coastguard Worker# generate a Perl module file that captures the structure of 1548*38e8c45fSAndroid Build Coastguard Worker# the code including all documentation. Note that this 1549*38e8c45fSAndroid Build Coastguard Worker# feature is still experimental and incomplete at the 1550*38e8c45fSAndroid Build Coastguard Worker# moment. 1551*38e8c45fSAndroid Build Coastguard Worker 1552*38e8c45fSAndroid Build Coastguard WorkerGENERATE_PERLMOD = NO 1553*38e8c45fSAndroid Build Coastguard Worker 1554*38e8c45fSAndroid Build Coastguard Worker# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1555*38e8c45fSAndroid Build Coastguard Worker# the necessary Makefile rules, Perl scripts and LaTeX code to be able 1556*38e8c45fSAndroid Build Coastguard Worker# to generate PDF and DVI output from the Perl module output. 1557*38e8c45fSAndroid Build Coastguard Worker 1558*38e8c45fSAndroid Build Coastguard WorkerPERLMOD_LATEX = NO 1559*38e8c45fSAndroid Build Coastguard Worker 1560*38e8c45fSAndroid Build Coastguard Worker# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1561*38e8c45fSAndroid Build Coastguard Worker# nicely formatted so it can be parsed by a human reader. This is useful 1562*38e8c45fSAndroid Build Coastguard Worker# if you want to understand what is going on. On the other hand, if this 1563*38e8c45fSAndroid Build Coastguard Worker# tag is set to NO the size of the Perl module output will be much smaller 1564*38e8c45fSAndroid Build Coastguard Worker# and Perl will parse it just the same. 1565*38e8c45fSAndroid Build Coastguard Worker 1566*38e8c45fSAndroid Build Coastguard WorkerPERLMOD_PRETTY = YES 1567*38e8c45fSAndroid Build Coastguard Worker 1568*38e8c45fSAndroid Build Coastguard Worker# The names of the make variables in the generated doxyrules.make file 1569*38e8c45fSAndroid Build Coastguard Worker# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1570*38e8c45fSAndroid Build Coastguard Worker# This is useful so different doxyrules.make files included by the same 1571*38e8c45fSAndroid Build Coastguard Worker# Makefile don't overwrite each other's variables. 1572*38e8c45fSAndroid Build Coastguard Worker 1573*38e8c45fSAndroid Build Coastguard WorkerPERLMOD_MAKEVAR_PREFIX = 1574*38e8c45fSAndroid Build Coastguard Worker 1575*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 1576*38e8c45fSAndroid Build Coastguard Worker# Configuration options related to the preprocessor 1577*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 1578*38e8c45fSAndroid Build Coastguard Worker 1579*38e8c45fSAndroid Build Coastguard Worker# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1580*38e8c45fSAndroid Build Coastguard Worker# evaluate all C-preprocessor directives found in the sources and include 1581*38e8c45fSAndroid Build Coastguard Worker# files. 1582*38e8c45fSAndroid Build Coastguard Worker 1583*38e8c45fSAndroid Build Coastguard WorkerENABLE_PREPROCESSING = YES 1584*38e8c45fSAndroid Build Coastguard Worker 1585*38e8c45fSAndroid Build Coastguard Worker# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1586*38e8c45fSAndroid Build Coastguard Worker# names in the source code. If set to NO (the default) only conditional 1587*38e8c45fSAndroid Build Coastguard Worker# compilation will be performed. Macro expansion can be done in a controlled 1588*38e8c45fSAndroid Build Coastguard Worker# way by setting EXPAND_ONLY_PREDEF to YES. 1589*38e8c45fSAndroid Build Coastguard Worker 1590*38e8c45fSAndroid Build Coastguard WorkerMACRO_EXPANSION = YES 1591*38e8c45fSAndroid Build Coastguard Worker 1592*38e8c45fSAndroid Build Coastguard Worker# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1593*38e8c45fSAndroid Build Coastguard Worker# then the macro expansion is limited to the macros specified with the 1594*38e8c45fSAndroid Build Coastguard Worker# PREDEFINED and EXPAND_AS_DEFINED tags. 1595*38e8c45fSAndroid Build Coastguard Worker 1596*38e8c45fSAndroid Build Coastguard WorkerEXPAND_ONLY_PREDEF = YES 1597*38e8c45fSAndroid Build Coastguard Worker 1598*38e8c45fSAndroid Build Coastguard Worker# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1599*38e8c45fSAndroid Build Coastguard Worker# pointed to by INCLUDE_PATH will be searched when a #include is found. 1600*38e8c45fSAndroid Build Coastguard Worker 1601*38e8c45fSAndroid Build Coastguard WorkerSEARCH_INCLUDES = YES 1602*38e8c45fSAndroid Build Coastguard Worker 1603*38e8c45fSAndroid Build Coastguard Worker# The INCLUDE_PATH tag can be used to specify one or more directories that 1604*38e8c45fSAndroid Build Coastguard Worker# contain include files that are not input files but should be processed by 1605*38e8c45fSAndroid Build Coastguard Worker# the preprocessor. 1606*38e8c45fSAndroid Build Coastguard Worker 1607*38e8c45fSAndroid Build Coastguard WorkerINCLUDE_PATH = 1608*38e8c45fSAndroid Build Coastguard Worker 1609*38e8c45fSAndroid Build Coastguard Worker# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1610*38e8c45fSAndroid Build Coastguard Worker# patterns (like *.h and *.hpp) to filter out the header-files in the 1611*38e8c45fSAndroid Build Coastguard Worker# directories. If left blank, the patterns specified with FILE_PATTERNS will 1612*38e8c45fSAndroid Build Coastguard Worker# be used. 1613*38e8c45fSAndroid Build Coastguard Worker 1614*38e8c45fSAndroid Build Coastguard WorkerINCLUDE_FILE_PATTERNS = 1615*38e8c45fSAndroid Build Coastguard Worker 1616*38e8c45fSAndroid Build Coastguard Worker# The PREDEFINED tag can be used to specify one or more macro names that 1617*38e8c45fSAndroid Build Coastguard Worker# are defined before the preprocessor is started (similar to the -D option of 1618*38e8c45fSAndroid Build Coastguard Worker# gcc). The argument of the tag is a list of macros of the form: name 1619*38e8c45fSAndroid Build Coastguard Worker# or name=definition (no spaces). If the definition and the = are 1620*38e8c45fSAndroid Build Coastguard Worker# omitted =1 is assumed. To prevent a macro definition from being 1621*38e8c45fSAndroid Build Coastguard Worker# undefined via #undef or recursively expanded use the := operator 1622*38e8c45fSAndroid Build Coastguard Worker# instead of the = operator. 1623*38e8c45fSAndroid Build Coastguard Worker 1624*38e8c45fSAndroid Build Coastguard WorkerPREDEFINED = \ 1625*38e8c45fSAndroid Build Coastguard Worker "__ANDROID_API__=10000" \ 1626*38e8c45fSAndroid Build Coastguard Worker "__BEGIN_DECLS=" \ 1627*38e8c45fSAndroid Build Coastguard Worker "__END_DECLS=" \ 1628*38e8c45fSAndroid Build Coastguard Worker "__INTRODUCED_IN(x)=" \ 1629*38e8c45fSAndroid Build Coastguard Worker "__INTRODUCED_IN_32(x)=" \ 1630*38e8c45fSAndroid Build Coastguard Worker "__INTRODUCED_IN_64(x)=" \ 1631*38e8c45fSAndroid Build Coastguard Worker "__RENAME(x)=" \ 1632*38e8c45fSAndroid Build Coastguard Worker "__RENAME_LDBL(x,y,z)=" \ 1633*38e8c45fSAndroid Build Coastguard Worker "__printflike(x,y)=" \ 1634*38e8c45fSAndroid Build Coastguard Worker "__attribute__(x)=" \ 1635*38e8c45fSAndroid Build Coastguard Worker "__wur=" \ 1636*38e8c45fSAndroid Build Coastguard Worker "__mallocfunc=" \ 1637*38e8c45fSAndroid Build Coastguard Worker "__attribute_pure__=" \ 1638*38e8c45fSAndroid Build Coastguard Worker "__attribute__(x)=" \ 1639*38e8c45fSAndroid Build Coastguard Worker __ANDROID__ \ 1640*38e8c45fSAndroid Build Coastguard Worker __BIONIC__ \ 1641*38e8c45fSAndroid Build Coastguard Worker "U_IN_DOXYGEN=1" \ # Required by the ICU4C module only 1642*38e8c45fSAndroid Build Coastguard Worker 1643*38e8c45fSAndroid Build Coastguard Worker# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1644*38e8c45fSAndroid Build Coastguard Worker# this tag can be used to specify a list of macro names that should be expanded. 1645*38e8c45fSAndroid Build Coastguard Worker# The macro definition that is found in the sources will be used. 1646*38e8c45fSAndroid Build Coastguard Worker# Use the PREDEFINED tag if you want to use a different macro definition that 1647*38e8c45fSAndroid Build Coastguard Worker# overrules the definition found in the source code. 1648*38e8c45fSAndroid Build Coastguard Worker 1649*38e8c45fSAndroid Build Coastguard WorkerEXPAND_AS_DEFINED = 1650*38e8c45fSAndroid Build Coastguard Worker 1651*38e8c45fSAndroid Build Coastguard Worker# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1652*38e8c45fSAndroid Build Coastguard Worker# doxygen's preprocessor will remove all references to function-like macros 1653*38e8c45fSAndroid Build Coastguard Worker# that are alone on a line, have an all uppercase name, and do not end with a 1654*38e8c45fSAndroid Build Coastguard Worker# semicolon, because these will confuse the parser if not removed. 1655*38e8c45fSAndroid Build Coastguard Worker 1656*38e8c45fSAndroid Build Coastguard WorkerSKIP_FUNCTION_MACROS = YES 1657*38e8c45fSAndroid Build Coastguard Worker 1658*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 1659*38e8c45fSAndroid Build Coastguard Worker# Configuration::additions related to external references 1660*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 1661*38e8c45fSAndroid Build Coastguard Worker 1662*38e8c45fSAndroid Build Coastguard Worker# The TAGFILES option can be used to specify one or more tagfiles. For each 1663*38e8c45fSAndroid Build Coastguard Worker# tag file the location of the external documentation should be added. The 1664*38e8c45fSAndroid Build Coastguard Worker# format of a tag file without this location is as follows: 1665*38e8c45fSAndroid Build Coastguard Worker# TAGFILES = file1 file2 ... 1666*38e8c45fSAndroid Build Coastguard Worker# Adding location for the tag files is done as follows: 1667*38e8c45fSAndroid Build Coastguard Worker# TAGFILES = file1=loc1 "file2 = loc2" ... 1668*38e8c45fSAndroid Build Coastguard Worker# where "loc1" and "loc2" can be relative or absolute paths 1669*38e8c45fSAndroid Build Coastguard Worker# or URLs. Note that each tag file must have a unique name (where the name does 1670*38e8c45fSAndroid Build Coastguard Worker# NOT include the path). If a tag file is not located in the directory in which 1671*38e8c45fSAndroid Build Coastguard Worker# doxygen is run, you must also specify the path to the tagfile here. 1672*38e8c45fSAndroid Build Coastguard Worker 1673*38e8c45fSAndroid Build Coastguard WorkerTAGFILES = 1674*38e8c45fSAndroid Build Coastguard Worker 1675*38e8c45fSAndroid Build Coastguard Worker# When a file name is specified after GENERATE_TAGFILE, doxygen will create 1676*38e8c45fSAndroid Build Coastguard Worker# a tag file that is based on the input files it reads. 1677*38e8c45fSAndroid Build Coastguard Worker 1678*38e8c45fSAndroid Build Coastguard WorkerGENERATE_TAGFILE = 1679*38e8c45fSAndroid Build Coastguard Worker 1680*38e8c45fSAndroid Build Coastguard Worker# If the ALLEXTERNALS tag is set to YES all external classes will be listed 1681*38e8c45fSAndroid Build Coastguard Worker# in the class index. If set to NO only the inherited external classes 1682*38e8c45fSAndroid Build Coastguard Worker# will be listed. 1683*38e8c45fSAndroid Build Coastguard Worker 1684*38e8c45fSAndroid Build Coastguard WorkerALLEXTERNALS = NO 1685*38e8c45fSAndroid Build Coastguard Worker 1686*38e8c45fSAndroid Build Coastguard Worker# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1687*38e8c45fSAndroid Build Coastguard Worker# in the modules index. If set to NO, only the current project's groups will 1688*38e8c45fSAndroid Build Coastguard Worker# be listed. 1689*38e8c45fSAndroid Build Coastguard Worker 1690*38e8c45fSAndroid Build Coastguard WorkerEXTERNAL_GROUPS = YES 1691*38e8c45fSAndroid Build Coastguard Worker 1692*38e8c45fSAndroid Build Coastguard Worker# The PERL_PATH should be the absolute path and name of the perl script 1693*38e8c45fSAndroid Build Coastguard Worker# interpreter (i.e. the result of `which perl'). 1694*38e8c45fSAndroid Build Coastguard Worker 1695*38e8c45fSAndroid Build Coastguard WorkerPERL_PATH = /usr/bin/perl 1696*38e8c45fSAndroid Build Coastguard Worker 1697*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 1698*38e8c45fSAndroid Build Coastguard Worker# Configuration options related to the dot tool 1699*38e8c45fSAndroid Build Coastguard Worker#--------------------------------------------------------------------------- 1700*38e8c45fSAndroid Build Coastguard Worker 1701*38e8c45fSAndroid Build Coastguard Worker# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1702*38e8c45fSAndroid Build Coastguard Worker# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1703*38e8c45fSAndroid Build Coastguard Worker# or super classes. Setting the tag to NO turns the diagrams off. Note that 1704*38e8c45fSAndroid Build Coastguard Worker# this option also works with HAVE_DOT disabled, but it is recommended to 1705*38e8c45fSAndroid Build Coastguard Worker# install and use dot, since it yields more powerful graphs. 1706*38e8c45fSAndroid Build Coastguard Worker 1707*38e8c45fSAndroid Build Coastguard WorkerCLASS_DIAGRAMS = NO 1708*38e8c45fSAndroid Build Coastguard Worker 1709*38e8c45fSAndroid Build Coastguard Worker# You can define message sequence charts within doxygen comments using the \msc 1710*38e8c45fSAndroid Build Coastguard Worker# command. Doxygen will then run the mscgen tool (see 1711*38e8c45fSAndroid Build Coastguard Worker# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 1712*38e8c45fSAndroid Build Coastguard Worker# documentation. The MSCGEN_PATH tag allows you to specify the directory where 1713*38e8c45fSAndroid Build Coastguard Worker# the mscgen tool resides. If left empty the tool is assumed to be found in the 1714*38e8c45fSAndroid Build Coastguard Worker# default search path. 1715*38e8c45fSAndroid Build Coastguard Worker 1716*38e8c45fSAndroid Build Coastguard WorkerMSCGEN_PATH = 1717*38e8c45fSAndroid Build Coastguard Worker 1718*38e8c45fSAndroid Build Coastguard Worker# If set to YES, the inheritance and collaboration graphs will hide 1719*38e8c45fSAndroid Build Coastguard Worker# inheritance and usage relations if the target is undocumented 1720*38e8c45fSAndroid Build Coastguard Worker# or is not a class. 1721*38e8c45fSAndroid Build Coastguard Worker 1722*38e8c45fSAndroid Build Coastguard WorkerHIDE_UNDOC_RELATIONS = YES 1723*38e8c45fSAndroid Build Coastguard Worker 1724*38e8c45fSAndroid Build Coastguard Worker# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1725*38e8c45fSAndroid Build Coastguard Worker# available from the path. This tool is part of Graphviz, a graph visualization 1726*38e8c45fSAndroid Build Coastguard Worker# toolkit from AT&T and Lucent Bell Labs. The other options in this section 1727*38e8c45fSAndroid Build Coastguard Worker# have no effect if this option is set to NO (the default) 1728*38e8c45fSAndroid Build Coastguard Worker 1729*38e8c45fSAndroid Build Coastguard WorkerHAVE_DOT = NO 1730*38e8c45fSAndroid Build Coastguard Worker 1731*38e8c45fSAndroid Build Coastguard Worker# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 1732*38e8c45fSAndroid Build Coastguard Worker# allowed to run in parallel. When set to 0 (the default) doxygen will 1733*38e8c45fSAndroid Build Coastguard Worker# base this on the number of processors available in the system. You can set it 1734*38e8c45fSAndroid Build Coastguard Worker# explicitly to a value larger than 0 to get control over the balance 1735*38e8c45fSAndroid Build Coastguard Worker# between CPU load and processing speed. 1736*38e8c45fSAndroid Build Coastguard Worker 1737*38e8c45fSAndroid Build Coastguard WorkerDOT_NUM_THREADS = 0 1738*38e8c45fSAndroid Build Coastguard Worker 1739*38e8c45fSAndroid Build Coastguard Worker# By default doxygen will use the Helvetica font for all dot files that 1740*38e8c45fSAndroid Build Coastguard Worker# doxygen generates. When you want a differently looking font you can specify 1741*38e8c45fSAndroid Build Coastguard Worker# the font name using DOT_FONTNAME. You need to make sure dot is able to find 1742*38e8c45fSAndroid Build Coastguard Worker# the font, which can be done by putting it in a standard location or by setting 1743*38e8c45fSAndroid Build Coastguard Worker# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the 1744*38e8c45fSAndroid Build Coastguard Worker# directory containing the font. 1745*38e8c45fSAndroid Build Coastguard Worker 1746*38e8c45fSAndroid Build Coastguard WorkerDOT_FONTNAME = Helvetica 1747*38e8c45fSAndroid Build Coastguard Worker 1748*38e8c45fSAndroid Build Coastguard Worker# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 1749*38e8c45fSAndroid Build Coastguard Worker# The default size is 10pt. 1750*38e8c45fSAndroid Build Coastguard Worker 1751*38e8c45fSAndroid Build Coastguard WorkerDOT_FONTSIZE = 10 1752*38e8c45fSAndroid Build Coastguard Worker 1753*38e8c45fSAndroid Build Coastguard Worker# By default doxygen will tell dot to use the Helvetica font. 1754*38e8c45fSAndroid Build Coastguard Worker# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to 1755*38e8c45fSAndroid Build Coastguard Worker# set the path where dot can find it. 1756*38e8c45fSAndroid Build Coastguard Worker 1757*38e8c45fSAndroid Build Coastguard WorkerDOT_FONTPATH = 1758*38e8c45fSAndroid Build Coastguard Worker 1759*38e8c45fSAndroid Build Coastguard Worker# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1760*38e8c45fSAndroid Build Coastguard Worker# will generate a graph for each documented class showing the direct and 1761*38e8c45fSAndroid Build Coastguard Worker# indirect inheritance relations. Setting this tag to YES will force the 1762*38e8c45fSAndroid Build Coastguard Worker# CLASS_DIAGRAMS tag to NO. 1763*38e8c45fSAndroid Build Coastguard Worker 1764*38e8c45fSAndroid Build Coastguard WorkerCLASS_GRAPH = YES 1765*38e8c45fSAndroid Build Coastguard Worker 1766*38e8c45fSAndroid Build Coastguard Worker# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1767*38e8c45fSAndroid Build Coastguard Worker# will generate a graph for each documented class showing the direct and 1768*38e8c45fSAndroid Build Coastguard Worker# indirect implementation dependencies (inheritance, containment, and 1769*38e8c45fSAndroid Build Coastguard Worker# class references variables) of the class with other documented classes. 1770*38e8c45fSAndroid Build Coastguard Worker 1771*38e8c45fSAndroid Build Coastguard WorkerCOLLABORATION_GRAPH = YES 1772*38e8c45fSAndroid Build Coastguard Worker 1773*38e8c45fSAndroid Build Coastguard Worker# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1774*38e8c45fSAndroid Build Coastguard Worker# will generate a graph for groups, showing the direct groups dependencies 1775*38e8c45fSAndroid Build Coastguard Worker 1776*38e8c45fSAndroid Build Coastguard WorkerGROUP_GRAPHS = YES 1777*38e8c45fSAndroid Build Coastguard Worker 1778*38e8c45fSAndroid Build Coastguard Worker# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1779*38e8c45fSAndroid Build Coastguard Worker# collaboration diagrams in a style similar to the OMG's Unified Modeling 1780*38e8c45fSAndroid Build Coastguard Worker# Language. 1781*38e8c45fSAndroid Build Coastguard Worker 1782*38e8c45fSAndroid Build Coastguard WorkerUML_LOOK = NO 1783*38e8c45fSAndroid Build Coastguard Worker 1784*38e8c45fSAndroid Build Coastguard Worker# If the UML_LOOK tag is enabled, the fields and methods are shown inside 1785*38e8c45fSAndroid Build Coastguard Worker# the class node. If there are many fields or methods and many nodes the 1786*38e8c45fSAndroid Build Coastguard Worker# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS 1787*38e8c45fSAndroid Build Coastguard Worker# threshold limits the number of items for each type to make the size more 1788*38e8c45fSAndroid Build Coastguard Worker# managable. Set this to 0 for no limit. Note that the threshold may be 1789*38e8c45fSAndroid Build Coastguard Worker# exceeded by 50% before the limit is enforced. 1790*38e8c45fSAndroid Build Coastguard Worker 1791*38e8c45fSAndroid Build Coastguard WorkerUML_LIMIT_NUM_FIELDS = 10 1792*38e8c45fSAndroid Build Coastguard Worker 1793*38e8c45fSAndroid Build Coastguard Worker# If set to YES, the inheritance and collaboration graphs will show the 1794*38e8c45fSAndroid Build Coastguard Worker# relations between templates and their instances. 1795*38e8c45fSAndroid Build Coastguard Worker 1796*38e8c45fSAndroid Build Coastguard WorkerTEMPLATE_RELATIONS = NO 1797*38e8c45fSAndroid Build Coastguard Worker 1798*38e8c45fSAndroid Build Coastguard Worker# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1799*38e8c45fSAndroid Build Coastguard Worker# tags are set to YES then doxygen will generate a graph for each documented 1800*38e8c45fSAndroid Build Coastguard Worker# file showing the direct and indirect include dependencies of the file with 1801*38e8c45fSAndroid Build Coastguard Worker# other documented files. 1802*38e8c45fSAndroid Build Coastguard Worker 1803*38e8c45fSAndroid Build Coastguard WorkerINCLUDE_GRAPH = YES 1804*38e8c45fSAndroid Build Coastguard Worker 1805*38e8c45fSAndroid Build Coastguard Worker# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1806*38e8c45fSAndroid Build Coastguard Worker# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1807*38e8c45fSAndroid Build Coastguard Worker# documented header file showing the documented files that directly or 1808*38e8c45fSAndroid Build Coastguard Worker# indirectly include this file. 1809*38e8c45fSAndroid Build Coastguard Worker 1810*38e8c45fSAndroid Build Coastguard WorkerINCLUDED_BY_GRAPH = YES 1811*38e8c45fSAndroid Build Coastguard Worker 1812*38e8c45fSAndroid Build Coastguard Worker# If the CALL_GRAPH and HAVE_DOT options are set to YES then 1813*38e8c45fSAndroid Build Coastguard Worker# doxygen will generate a call dependency graph for every global function 1814*38e8c45fSAndroid Build Coastguard Worker# or class method. Note that enabling this option will significantly increase 1815*38e8c45fSAndroid Build Coastguard Worker# the time of a run. So in most cases it will be better to enable call graphs 1816*38e8c45fSAndroid Build Coastguard Worker# for selected functions only using the \callgraph command. 1817*38e8c45fSAndroid Build Coastguard Worker 1818*38e8c45fSAndroid Build Coastguard WorkerCALL_GRAPH = NO 1819*38e8c45fSAndroid Build Coastguard Worker 1820*38e8c45fSAndroid Build Coastguard Worker# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1821*38e8c45fSAndroid Build Coastguard Worker# doxygen will generate a caller dependency graph for every global function 1822*38e8c45fSAndroid Build Coastguard Worker# or class method. Note that enabling this option will significantly increase 1823*38e8c45fSAndroid Build Coastguard Worker# the time of a run. So in most cases it will be better to enable caller 1824*38e8c45fSAndroid Build Coastguard Worker# graphs for selected functions only using the \callergraph command. 1825*38e8c45fSAndroid Build Coastguard Worker 1826*38e8c45fSAndroid Build Coastguard WorkerCALLER_GRAPH = NO 1827*38e8c45fSAndroid Build Coastguard Worker 1828*38e8c45fSAndroid Build Coastguard Worker# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1829*38e8c45fSAndroid Build Coastguard Worker# will generate a graphical hierarchy of all classes instead of a textual one. 1830*38e8c45fSAndroid Build Coastguard Worker 1831*38e8c45fSAndroid Build Coastguard WorkerGRAPHICAL_HIERARCHY = YES 1832*38e8c45fSAndroid Build Coastguard Worker 1833*38e8c45fSAndroid Build Coastguard Worker# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES 1834*38e8c45fSAndroid Build Coastguard Worker# then doxygen will show the dependencies a directory has on other directories 1835*38e8c45fSAndroid Build Coastguard Worker# in a graphical way. The dependency relations are determined by the #include 1836*38e8c45fSAndroid Build Coastguard Worker# relations between the files in the directories. 1837*38e8c45fSAndroid Build Coastguard Worker 1838*38e8c45fSAndroid Build Coastguard WorkerDIRECTORY_GRAPH = YES 1839*38e8c45fSAndroid Build Coastguard Worker 1840*38e8c45fSAndroid Build Coastguard Worker# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1841*38e8c45fSAndroid Build Coastguard Worker# generated by dot. Possible values are svg, png, jpg, or gif. 1842*38e8c45fSAndroid Build Coastguard Worker# If left blank png will be used. If you choose svg you need to set 1843*38e8c45fSAndroid Build Coastguard Worker# HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1844*38e8c45fSAndroid Build Coastguard Worker# visible in IE 9+ (other browsers do not have this requirement). 1845*38e8c45fSAndroid Build Coastguard Worker 1846*38e8c45fSAndroid Build Coastguard WorkerDOT_IMAGE_FORMAT = png 1847*38e8c45fSAndroid Build Coastguard Worker 1848*38e8c45fSAndroid Build Coastguard Worker# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 1849*38e8c45fSAndroid Build Coastguard Worker# enable generation of interactive SVG images that allow zooming and panning. 1850*38e8c45fSAndroid Build Coastguard Worker# Note that this requires a modern browser other than Internet Explorer. 1851*38e8c45fSAndroid Build Coastguard Worker# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you 1852*38e8c45fSAndroid Build Coastguard Worker# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1853*38e8c45fSAndroid Build Coastguard Worker# visible. Older versions of IE do not have SVG support. 1854*38e8c45fSAndroid Build Coastguard Worker 1855*38e8c45fSAndroid Build Coastguard WorkerINTERACTIVE_SVG = NO 1856*38e8c45fSAndroid Build Coastguard Worker 1857*38e8c45fSAndroid Build Coastguard Worker# The tag DOT_PATH can be used to specify the path where the dot tool can be 1858*38e8c45fSAndroid Build Coastguard Worker# found. If left blank, it is assumed the dot tool can be found in the path. 1859*38e8c45fSAndroid Build Coastguard Worker 1860*38e8c45fSAndroid Build Coastguard WorkerDOT_PATH = 1861*38e8c45fSAndroid Build Coastguard Worker 1862*38e8c45fSAndroid Build Coastguard Worker# The DOTFILE_DIRS tag can be used to specify one or more directories that 1863*38e8c45fSAndroid Build Coastguard Worker# contain dot files that are included in the documentation (see the 1864*38e8c45fSAndroid Build Coastguard Worker# \dotfile command). 1865*38e8c45fSAndroid Build Coastguard Worker 1866*38e8c45fSAndroid Build Coastguard WorkerDOTFILE_DIRS = 1867*38e8c45fSAndroid Build Coastguard Worker 1868*38e8c45fSAndroid Build Coastguard Worker# The MSCFILE_DIRS tag can be used to specify one or more directories that 1869*38e8c45fSAndroid Build Coastguard Worker# contain msc files that are included in the documentation (see the 1870*38e8c45fSAndroid Build Coastguard Worker# \mscfile command). 1871*38e8c45fSAndroid Build Coastguard Worker 1872*38e8c45fSAndroid Build Coastguard WorkerMSCFILE_DIRS = 1873*38e8c45fSAndroid Build Coastguard Worker 1874*38e8c45fSAndroid Build Coastguard Worker# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1875*38e8c45fSAndroid Build Coastguard Worker# nodes that will be shown in the graph. If the number of nodes in a graph 1876*38e8c45fSAndroid Build Coastguard Worker# becomes larger than this value, doxygen will truncate the graph, which is 1877*38e8c45fSAndroid Build Coastguard Worker# visualized by representing a node as a red box. Note that doxygen if the 1878*38e8c45fSAndroid Build Coastguard Worker# number of direct children of the root node in a graph is already larger than 1879*38e8c45fSAndroid Build Coastguard Worker# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1880*38e8c45fSAndroid Build Coastguard Worker# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1881*38e8c45fSAndroid Build Coastguard Worker 1882*38e8c45fSAndroid Build Coastguard WorkerDOT_GRAPH_MAX_NODES = 50 1883*38e8c45fSAndroid Build Coastguard Worker 1884*38e8c45fSAndroid Build Coastguard Worker# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1885*38e8c45fSAndroid Build Coastguard Worker# graphs generated by dot. A depth value of 3 means that only nodes reachable 1886*38e8c45fSAndroid Build Coastguard Worker# from the root by following a path via at most 3 edges will be shown. Nodes 1887*38e8c45fSAndroid Build Coastguard Worker# that lay further from the root node will be omitted. Note that setting this 1888*38e8c45fSAndroid Build Coastguard Worker# option to 1 or 2 may greatly reduce the computation time needed for large 1889*38e8c45fSAndroid Build Coastguard Worker# code bases. Also note that the size of a graph can be further restricted by 1890*38e8c45fSAndroid Build Coastguard Worker# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1891*38e8c45fSAndroid Build Coastguard Worker 1892*38e8c45fSAndroid Build Coastguard WorkerMAX_DOT_GRAPH_DEPTH = 0 1893*38e8c45fSAndroid Build Coastguard Worker 1894*38e8c45fSAndroid Build Coastguard Worker# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1895*38e8c45fSAndroid Build Coastguard Worker# background. This is disabled by default, because dot on Windows does not 1896*38e8c45fSAndroid Build Coastguard Worker# seem to support this out of the box. Warning: Depending on the platform used, 1897*38e8c45fSAndroid Build Coastguard Worker# enabling this option may lead to badly anti-aliased labels on the edges of 1898*38e8c45fSAndroid Build Coastguard Worker# a graph (i.e. they become hard to read). 1899*38e8c45fSAndroid Build Coastguard Worker 1900*38e8c45fSAndroid Build Coastguard WorkerDOT_TRANSPARENT = NO 1901*38e8c45fSAndroid Build Coastguard Worker 1902*38e8c45fSAndroid Build Coastguard Worker# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1903*38e8c45fSAndroid Build Coastguard Worker# files in one run (i.e. multiple -o and -T options on the command line). This 1904*38e8c45fSAndroid Build Coastguard Worker# makes dot run faster, but since only newer versions of dot (>1.8.10) 1905*38e8c45fSAndroid Build Coastguard Worker# support this, this feature is disabled by default. 1906*38e8c45fSAndroid Build Coastguard Worker 1907*38e8c45fSAndroid Build Coastguard WorkerDOT_MULTI_TARGETS = NO 1908*38e8c45fSAndroid Build Coastguard Worker 1909*38e8c45fSAndroid Build Coastguard Worker# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1910*38e8c45fSAndroid Build Coastguard Worker# generate a legend page explaining the meaning of the various boxes and 1911*38e8c45fSAndroid Build Coastguard Worker# arrows in the dot generated graphs. 1912*38e8c45fSAndroid Build Coastguard Worker 1913*38e8c45fSAndroid Build Coastguard WorkerGENERATE_LEGEND = YES 1914*38e8c45fSAndroid Build Coastguard Worker 1915*38e8c45fSAndroid Build Coastguard Worker# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1916*38e8c45fSAndroid Build Coastguard Worker# remove the intermediate dot files that are used to generate 1917*38e8c45fSAndroid Build Coastguard Worker# the various graphs. 1918*38e8c45fSAndroid Build Coastguard Worker 1919*38e8c45fSAndroid Build Coastguard WorkerDOT_CLEANUP = YES 1920