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