xref: /freebsd/contrib/unbound/doc/unbound.doxygen (revision 64e33c5cb1e2ec64e0b1ce576eb53bbb27e93582)
1*64e33c5cSCy Schubert# Doxyfile 1.7.1
2*64e33c5cSCy Schubert
3*64e33c5cSCy Schubert# This file describes the settings to be used by the documentation system
4*64e33c5cSCy Schubert# doxygen (www.doxygen.org) for a project
5*64e33c5cSCy Schubert#
6*64e33c5cSCy Schubert# All text after a hash (#) is considered a comment and will be ignored
7*64e33c5cSCy Schubert# The format is:
8*64e33c5cSCy Schubert#       TAG = value [value, ...]
9*64e33c5cSCy Schubert# For lists items can also be appended using:
10*64e33c5cSCy Schubert#       TAG += value [value, ...]
11*64e33c5cSCy Schubert# Values that contain spaces should be placed between quotes (" ")
12*64e33c5cSCy Schubert
13*64e33c5cSCy Schubert#---------------------------------------------------------------------------
14*64e33c5cSCy Schubert# Project related configuration options
15*64e33c5cSCy Schubert#---------------------------------------------------------------------------
16*64e33c5cSCy Schubert
17*64e33c5cSCy Schubert# This tag specifies the encoding used for all characters in the config file
18*64e33c5cSCy Schubert# that follow. The default is UTF-8 which is also the encoding used for all
19*64e33c5cSCy Schubert# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20*64e33c5cSCy Schubert# iconv built into libc) for the transcoding. See
21*64e33c5cSCy Schubert# http://www.gnu.org/software/libiconv for the list of possible encodings.
22*64e33c5cSCy Schubert
23*64e33c5cSCy SchubertDOXYFILE_ENCODING      = UTF-8
24*64e33c5cSCy Schubert
25*64e33c5cSCy Schubert# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26*64e33c5cSCy Schubert# by quotes) that should identify the project.
27*64e33c5cSCy Schubert
28*64e33c5cSCy SchubertPROJECT_NAME           = unbound
29*64e33c5cSCy Schubert
30*64e33c5cSCy Schubert# The PROJECT_NUMBER tag can be used to enter a project or revision number.
31*64e33c5cSCy Schubert# This could be handy for archiving the generated documentation or
32*64e33c5cSCy Schubert# if some version control system is used.
33*64e33c5cSCy Schubert
34*64e33c5cSCy SchubertPROJECT_NUMBER         = 0.1
35*64e33c5cSCy Schubert
36*64e33c5cSCy Schubert# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37*64e33c5cSCy Schubert# base path where the generated documentation will be put.
38*64e33c5cSCy Schubert# If a relative path is entered, it will be relative to the location
39*64e33c5cSCy Schubert# where doxygen was started. If left blank the current directory will be used.
40*64e33c5cSCy Schubert
41*64e33c5cSCy SchubertOUTPUT_DIRECTORY       = doc
42*64e33c5cSCy Schubert
43*64e33c5cSCy Schubert# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44*64e33c5cSCy Schubert# 4096 sub-directories (in 2 levels) under the output directory of each output
45*64e33c5cSCy Schubert# format and will distribute the generated files over these directories.
46*64e33c5cSCy Schubert# Enabling this option can be useful when feeding doxygen a huge amount of
47*64e33c5cSCy Schubert# source files, where putting all generated files in the same directory would
48*64e33c5cSCy Schubert# otherwise cause performance problems for the file system.
49*64e33c5cSCy Schubert
50*64e33c5cSCy SchubertCREATE_SUBDIRS         = NO
51*64e33c5cSCy Schubert
52*64e33c5cSCy Schubert# The OUTPUT_LANGUAGE tag is used to specify the language in which all
53*64e33c5cSCy Schubert# documentation generated by doxygen is written. Doxygen will use this
54*64e33c5cSCy Schubert# information to generate all constant output in the proper language.
55*64e33c5cSCy Schubert# The default language is English, other supported languages are:
56*64e33c5cSCy Schubert# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57*64e33c5cSCy Schubert# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
58*64e33c5cSCy Schubert# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
59*64e33c5cSCy Schubert# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
60*64e33c5cSCy Schubert# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
61*64e33c5cSCy Schubert# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
62*64e33c5cSCy Schubert
63*64e33c5cSCy SchubertOUTPUT_LANGUAGE        = English
64*64e33c5cSCy Schubert
65*64e33c5cSCy Schubert# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66*64e33c5cSCy Schubert# include brief member descriptions after the members that are listed in
67*64e33c5cSCy Schubert# the file and class documentation (similar to JavaDoc).
68*64e33c5cSCy Schubert# Set to NO to disable this.
69*64e33c5cSCy Schubert
70*64e33c5cSCy SchubertBRIEF_MEMBER_DESC      = YES
71*64e33c5cSCy Schubert
72*64e33c5cSCy Schubert# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73*64e33c5cSCy Schubert# the brief description of a member or function before the detailed description.
74*64e33c5cSCy Schubert# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75*64e33c5cSCy Schubert# brief descriptions will be completely suppressed.
76*64e33c5cSCy Schubert
77*64e33c5cSCy SchubertREPEAT_BRIEF           = YES
78*64e33c5cSCy Schubert
79*64e33c5cSCy Schubert# This tag implements a quasi-intelligent brief description abbreviator
80*64e33c5cSCy Schubert# that is used to form the text in various listings. Each string
81*64e33c5cSCy Schubert# in this list, if found as the leading text of the brief description, will be
82*64e33c5cSCy Schubert# stripped from the text and the result after processing the whole list, is
83*64e33c5cSCy Schubert# used as the annotated text. Otherwise, the brief description is used as-is.
84*64e33c5cSCy Schubert# If left blank, the following values are used ("$name" is automatically
85*64e33c5cSCy Schubert# replaced with the name of the entity): "The $name class" "The $name widget"
86*64e33c5cSCy Schubert# "The $name file" "is" "provides" "specifies" "contains"
87*64e33c5cSCy Schubert# "represents" "a" "an" "the"
88*64e33c5cSCy Schubert
89*64e33c5cSCy SchubertABBREVIATE_BRIEF       =
90*64e33c5cSCy Schubert
91*64e33c5cSCy Schubert# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
92*64e33c5cSCy Schubert# Doxygen will generate a detailed section even if there is only a brief
93*64e33c5cSCy Schubert# description.
94*64e33c5cSCy Schubert
95*64e33c5cSCy SchubertALWAYS_DETAILED_SEC    = NO
96*64e33c5cSCy Schubert
97*64e33c5cSCy Schubert# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
98*64e33c5cSCy Schubert# inherited members of a class in the documentation of that class as if those
99*64e33c5cSCy Schubert# members were ordinary class members. Constructors, destructors and assignment
100*64e33c5cSCy Schubert# operators of the base classes will not be shown.
101*64e33c5cSCy Schubert
102*64e33c5cSCy SchubertINLINE_INHERITED_MEMB  = NO
103*64e33c5cSCy Schubert
104*64e33c5cSCy Schubert# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
105*64e33c5cSCy Schubert# path before files name in the file list and in the header files. If set
106*64e33c5cSCy Schubert# to NO the shortest path that makes the file name unique will be used.
107*64e33c5cSCy Schubert
108*64e33c5cSCy SchubertFULL_PATH_NAMES        = YES
109*64e33c5cSCy Schubert
110*64e33c5cSCy Schubert# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
111*64e33c5cSCy Schubert# can be used to strip a user-defined part of the path. Stripping is
112*64e33c5cSCy Schubert# only done if one of the specified strings matches the left-hand part of
113*64e33c5cSCy Schubert# the path. The tag can be used to show relative paths in the file list.
114*64e33c5cSCy Schubert# If left blank the directory from which doxygen is run is used as the
115*64e33c5cSCy Schubert# path to strip.
116*64e33c5cSCy Schubert
117*64e33c5cSCy SchubertSTRIP_FROM_PATH        =
118*64e33c5cSCy Schubert
119*64e33c5cSCy Schubert# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
120*64e33c5cSCy Schubert# the path mentioned in the documentation of a class, which tells
121*64e33c5cSCy Schubert# the reader which header file to include in order to use a class.
122*64e33c5cSCy Schubert# If left blank only the name of the header file containing the class
123*64e33c5cSCy Schubert# definition is used. Otherwise one should specify the include paths that
124*64e33c5cSCy Schubert# are normally passed to the compiler using the -I flag.
125*64e33c5cSCy Schubert
126*64e33c5cSCy SchubertSTRIP_FROM_INC_PATH    =
127*64e33c5cSCy Schubert
128*64e33c5cSCy Schubert# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
129*64e33c5cSCy Schubert# (but less readable) file names. This can be useful is your file systems
130*64e33c5cSCy Schubert# doesn't support long names like on DOS, Mac, or CD-ROM.
131*64e33c5cSCy Schubert
132*64e33c5cSCy SchubertSHORT_NAMES            = NO
133*64e33c5cSCy Schubert
134*64e33c5cSCy Schubert# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
135*64e33c5cSCy Schubert# will interpret the first line (until the first dot) of a JavaDoc-style
136*64e33c5cSCy Schubert# comment as the brief description. If set to NO, the JavaDoc
137*64e33c5cSCy Schubert# comments will behave just like regular Qt-style comments
138*64e33c5cSCy Schubert# (thus requiring an explicit @brief command for a brief description.)
139*64e33c5cSCy Schubert
140*64e33c5cSCy SchubertJAVADOC_AUTOBRIEF      = YES
141*64e33c5cSCy Schubert
142*64e33c5cSCy Schubert# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
143*64e33c5cSCy Schubert# interpret the first line (until the first dot) of a Qt-style
144*64e33c5cSCy Schubert# comment as the brief description. If set to NO, the comments
145*64e33c5cSCy Schubert# will behave just like regular Qt-style comments (thus requiring
146*64e33c5cSCy Schubert# an explicit \brief command for a brief description.)
147*64e33c5cSCy Schubert
148*64e33c5cSCy SchubertQT_AUTOBRIEF           = NO
149*64e33c5cSCy Schubert
150*64e33c5cSCy Schubert# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
151*64e33c5cSCy Schubert# treat a multi-line C++ special comment block (i.e. a block of //! or ///
152*64e33c5cSCy Schubert# comments) as a brief description. This used to be the default behaviour.
153*64e33c5cSCy Schubert# The new default is to treat a multi-line C++ comment block as a detailed
154*64e33c5cSCy Schubert# description. Set this tag to YES if you prefer the old behaviour instead.
155*64e33c5cSCy Schubert
156*64e33c5cSCy SchubertMULTILINE_CPP_IS_BRIEF = NO
157*64e33c5cSCy Schubert
158*64e33c5cSCy Schubert# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
159*64e33c5cSCy Schubert# member inherits the documentation from any documented member that it
160*64e33c5cSCy Schubert# re-implements.
161*64e33c5cSCy Schubert
162*64e33c5cSCy SchubertINHERIT_DOCS           = YES
163*64e33c5cSCy Schubert
164*64e33c5cSCy Schubert# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
165*64e33c5cSCy Schubert# a new page for each member. If set to NO, the documentation of a member will
166*64e33c5cSCy Schubert# be part of the file/class/namespace that contains it.
167*64e33c5cSCy Schubert
168*64e33c5cSCy SchubertSEPARATE_MEMBER_PAGES  = NO
169*64e33c5cSCy Schubert
170*64e33c5cSCy Schubert# The TAB_SIZE tag can be used to set the number of spaces in a tab.
171*64e33c5cSCy Schubert# Doxygen uses this value to replace tabs by spaces in code fragments.
172*64e33c5cSCy Schubert
173*64e33c5cSCy SchubertTAB_SIZE               = 8
174*64e33c5cSCy Schubert
175*64e33c5cSCy Schubert# This tag can be used to specify a number of aliases that acts
176*64e33c5cSCy Schubert# as commands in the documentation. An alias has the form "name=value".
177*64e33c5cSCy Schubert# For example adding "sideeffect=\par Side Effects:\n" will allow you to
178*64e33c5cSCy Schubert# put the command \sideeffect (or @sideeffect) in the documentation, which
179*64e33c5cSCy Schubert# will result in a user-defined paragraph with heading "Side Effects:".
180*64e33c5cSCy Schubert# You can put \n's in the value part of an alias to insert newlines.
181*64e33c5cSCy Schubert
182*64e33c5cSCy SchubertALIASES                =
183*64e33c5cSCy Schubert
184*64e33c5cSCy Schubert# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
185*64e33c5cSCy Schubert# sources only. Doxygen will then generate output that is more tailored for C.
186*64e33c5cSCy Schubert# For instance, some of the names that are used will be different. The list
187*64e33c5cSCy Schubert# of all members will be omitted, etc.
188*64e33c5cSCy Schubert
189*64e33c5cSCy SchubertOPTIMIZE_OUTPUT_FOR_C  = YES
190*64e33c5cSCy Schubert
191*64e33c5cSCy Schubert# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
192*64e33c5cSCy Schubert# sources only. Doxygen will then generate output that is more tailored for
193*64e33c5cSCy Schubert# Java. For instance, namespaces will be presented as packages, qualified
194*64e33c5cSCy Schubert# scopes will look different, etc.
195*64e33c5cSCy Schubert
196*64e33c5cSCy SchubertOPTIMIZE_OUTPUT_JAVA   = NO
197*64e33c5cSCy Schubert
198*64e33c5cSCy Schubert# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
199*64e33c5cSCy Schubert# sources only. Doxygen will then generate output that is more tailored for
200*64e33c5cSCy Schubert# Fortran.
201*64e33c5cSCy Schubert
202*64e33c5cSCy SchubertOPTIMIZE_FOR_FORTRAN   = NO
203*64e33c5cSCy Schubert
204*64e33c5cSCy Schubert# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
205*64e33c5cSCy Schubert# sources. Doxygen will then generate output that is tailored for
206*64e33c5cSCy Schubert# VHDL.
207*64e33c5cSCy Schubert
208*64e33c5cSCy SchubertOPTIMIZE_OUTPUT_VHDL   = NO
209*64e33c5cSCy Schubert
210*64e33c5cSCy Schubert# Doxygen selects the parser to use depending on the extension of the files it
211*64e33c5cSCy Schubert# parses. With this tag you can assign which parser to use for a given extension.
212*64e33c5cSCy Schubert# Doxygen has a built-in mapping, but you can override or extend it using this
213*64e33c5cSCy Schubert# tag. The format is ext=language, where ext is a file extension, and language
214*64e33c5cSCy Schubert# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
215*64e33c5cSCy Schubert# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
216*64e33c5cSCy Schubert# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
217*64e33c5cSCy Schubert# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
218*64e33c5cSCy Schubert# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
219*64e33c5cSCy Schubert
220*64e33c5cSCy SchubertEXTENSION_MAPPING      =
221*64e33c5cSCy Schubert
222*64e33c5cSCy Schubert# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
223*64e33c5cSCy Schubert# to include (a tag file for) the STL sources as input, then you should
224*64e33c5cSCy Schubert# set this tag to YES in order to let doxygen match functions declarations and
225*64e33c5cSCy Schubert# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
226*64e33c5cSCy Schubert# func(std::string) {}). This also make the inheritance and collaboration
227*64e33c5cSCy Schubert# diagrams that involve STL classes more complete and accurate.
228*64e33c5cSCy Schubert
229*64e33c5cSCy SchubertBUILTIN_STL_SUPPORT    = NO
230*64e33c5cSCy Schubert
231*64e33c5cSCy Schubert# If you use Microsoft's C++/CLI language, you should set this option to YES to
232*64e33c5cSCy Schubert# enable parsing support.
233*64e33c5cSCy Schubert
234*64e33c5cSCy SchubertCPP_CLI_SUPPORT        = NO
235*64e33c5cSCy Schubert
236*64e33c5cSCy Schubert# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
237*64e33c5cSCy Schubert# Doxygen will parse them like normal C++ but will assume all classes use public
238*64e33c5cSCy Schubert# instead of private inheritance when no explicit protection keyword is present.
239*64e33c5cSCy Schubert
240*64e33c5cSCy SchubertSIP_SUPPORT            = NO
241*64e33c5cSCy Schubert
242*64e33c5cSCy Schubert# For Microsoft's IDL there are propget and propput attributes to indicate getter
243*64e33c5cSCy Schubert# and setter methods for a property. Setting this option to YES (the default)
244*64e33c5cSCy Schubert# will make doxygen to replace the get and set methods by a property in the
245*64e33c5cSCy Schubert# documentation. This will only work if the methods are indeed getting or
246*64e33c5cSCy Schubert# setting a simple type. If this is not the case, or you want to show the
247*64e33c5cSCy Schubert# methods anyway, you should set this option to NO.
248*64e33c5cSCy Schubert
249*64e33c5cSCy SchubertIDL_PROPERTY_SUPPORT   = YES
250*64e33c5cSCy Schubert
251*64e33c5cSCy Schubert# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
252*64e33c5cSCy Schubert# tag is set to YES, then doxygen will reuse the documentation of the first
253*64e33c5cSCy Schubert# member in the group (if any) for the other members of the group. By default
254*64e33c5cSCy Schubert# all members of a group must be documented explicitly.
255*64e33c5cSCy Schubert
256*64e33c5cSCy SchubertDISTRIBUTE_GROUP_DOC   = NO
257*64e33c5cSCy Schubert
258*64e33c5cSCy Schubert# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
259*64e33c5cSCy Schubert# the same type (for instance a group of public functions) to be put as a
260*64e33c5cSCy Schubert# subgroup of that type (e.g. under the Public Functions section). Set it to
261*64e33c5cSCy Schubert# NO to prevent subgrouping. Alternatively, this can be done per class using
262*64e33c5cSCy Schubert# the \nosubgrouping command.
263*64e33c5cSCy Schubert
264*64e33c5cSCy SchubertSUBGROUPING            = YES
265*64e33c5cSCy Schubert
266*64e33c5cSCy Schubert# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
267*64e33c5cSCy Schubert# is documented as struct, union, or enum with the name of the typedef. So
268*64e33c5cSCy Schubert# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
269*64e33c5cSCy Schubert# with name TypeT. When disabled the typedef will appear as a member of a file,
270*64e33c5cSCy Schubert# namespace, or class. And the struct will be named TypeS. This can typically
271*64e33c5cSCy Schubert# be useful for C code in case the coding convention dictates that all compound
272*64e33c5cSCy Schubert# types are typedef'ed and only the typedef is referenced, never the tag name.
273*64e33c5cSCy Schubert
274*64e33c5cSCy SchubertTYPEDEF_HIDES_STRUCT   = NO
275*64e33c5cSCy Schubert
276*64e33c5cSCy Schubert# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
277*64e33c5cSCy Schubert# determine which symbols to keep in memory and which to flush to disk.
278*64e33c5cSCy Schubert# When the cache is full, less often used symbols will be written to disk.
279*64e33c5cSCy Schubert# For small to medium size projects (<1000 input files) the default value is
280*64e33c5cSCy Schubert# probably good enough. For larger projects a too small cache size can cause
281*64e33c5cSCy Schubert# doxygen to be busy swapping symbols to and from disk most of the time
282*64e33c5cSCy Schubert# causing a significant performance penalty.
283*64e33c5cSCy Schubert# If the system has enough physical memory increasing the cache will improve the
284*64e33c5cSCy Schubert# performance by keeping more symbols in memory. Note that the value works on
285*64e33c5cSCy Schubert# a logarithmic scale so increasing the size by one will roughly double the
286*64e33c5cSCy Schubert# memory usage. The cache size is given by this formula:
287*64e33c5cSCy Schubert# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
288*64e33c5cSCy Schubert# corresponding to a cache size of 2^16 = 65536 symbols
289*64e33c5cSCy Schubert
290*64e33c5cSCy Schubert#SYMBOL_CACHE_SIZE      = 0
291*64e33c5cSCy Schubert
292*64e33c5cSCy Schubert#---------------------------------------------------------------------------
293*64e33c5cSCy Schubert# Build related configuration options
294*64e33c5cSCy Schubert#---------------------------------------------------------------------------
295*64e33c5cSCy Schubert
296*64e33c5cSCy Schubert# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
297*64e33c5cSCy Schubert# documentation are documented, even if no documentation was available.
298*64e33c5cSCy Schubert# Private class members and static file members will be hidden unless
299*64e33c5cSCy Schubert# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
300*64e33c5cSCy Schubert
301*64e33c5cSCy SchubertEXTRACT_ALL            = NO
302*64e33c5cSCy Schubert
303*64e33c5cSCy Schubert# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
304*64e33c5cSCy Schubert# will be included in the documentation.
305*64e33c5cSCy Schubert
306*64e33c5cSCy SchubertEXTRACT_PRIVATE        = YES
307*64e33c5cSCy Schubert
308*64e33c5cSCy Schubert# If the EXTRACT_STATIC tag is set to YES all static members of a file
309*64e33c5cSCy Schubert# will be included in the documentation.
310*64e33c5cSCy Schubert
311*64e33c5cSCy SchubertEXTRACT_STATIC         = YES
312*64e33c5cSCy Schubert
313*64e33c5cSCy Schubert# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
314*64e33c5cSCy Schubert# defined locally in source files will be included in the documentation.
315*64e33c5cSCy Schubert# If set to NO only classes defined in header files are included.
316*64e33c5cSCy Schubert
317*64e33c5cSCy SchubertEXTRACT_LOCAL_CLASSES  = YES
318*64e33c5cSCy Schubert
319*64e33c5cSCy Schubert# This flag is only useful for Objective-C code. When set to YES local
320*64e33c5cSCy Schubert# methods, which are defined in the implementation section but not in
321*64e33c5cSCy Schubert# the interface are included in the documentation.
322*64e33c5cSCy Schubert# If set to NO (the default) only methods in the interface are included.
323*64e33c5cSCy Schubert
324*64e33c5cSCy SchubertEXTRACT_LOCAL_METHODS  = YES
325*64e33c5cSCy Schubert
326*64e33c5cSCy Schubert# If this flag is set to YES, the members of anonymous namespaces will be
327*64e33c5cSCy Schubert# extracted and appear in the documentation as a namespace called
328*64e33c5cSCy Schubert# 'anonymous_namespace{file}', where file will be replaced with the base
329*64e33c5cSCy Schubert# name of the file that contains the anonymous namespace. By default
330*64e33c5cSCy Schubert# anonymous namespace are hidden.
331*64e33c5cSCy Schubert
332*64e33c5cSCy SchubertEXTRACT_ANON_NSPACES   = NO
333*64e33c5cSCy Schubert
334*64e33c5cSCy Schubert# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
335*64e33c5cSCy Schubert# undocumented members of documented classes, files or namespaces.
336*64e33c5cSCy Schubert# If set to NO (the default) these members will be included in the
337*64e33c5cSCy Schubert# various overviews, but no documentation section is generated.
338*64e33c5cSCy Schubert# This option has no effect if EXTRACT_ALL is enabled.
339*64e33c5cSCy Schubert
340*64e33c5cSCy SchubertHIDE_UNDOC_MEMBERS     = NO
341*64e33c5cSCy Schubert
342*64e33c5cSCy Schubert# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
343*64e33c5cSCy Schubert# undocumented classes that are normally visible in the class hierarchy.
344*64e33c5cSCy Schubert# If set to NO (the default) these classes will be included in the various
345*64e33c5cSCy Schubert# overviews. This option has no effect if EXTRACT_ALL is enabled.
346*64e33c5cSCy Schubert
347*64e33c5cSCy SchubertHIDE_UNDOC_CLASSES     = NO
348*64e33c5cSCy Schubert
349*64e33c5cSCy Schubert# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
350*64e33c5cSCy Schubert# friend (class|struct|union) declarations.
351*64e33c5cSCy Schubert# If set to NO (the default) these declarations will be included in the
352*64e33c5cSCy Schubert# documentation.
353*64e33c5cSCy Schubert
354*64e33c5cSCy SchubertHIDE_FRIEND_COMPOUNDS  = NO
355*64e33c5cSCy Schubert
356*64e33c5cSCy Schubert# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
357*64e33c5cSCy Schubert# documentation blocks found inside the body of a function.
358*64e33c5cSCy Schubert# If set to NO (the default) these blocks will be appended to the
359*64e33c5cSCy Schubert# function's detailed documentation block.
360*64e33c5cSCy Schubert
361*64e33c5cSCy SchubertHIDE_IN_BODY_DOCS      = NO
362*64e33c5cSCy Schubert
363*64e33c5cSCy Schubert# The INTERNAL_DOCS tag determines if documentation
364*64e33c5cSCy Schubert# that is typed after a \internal command is included. If the tag is set
365*64e33c5cSCy Schubert# to NO (the default) then the documentation will be excluded.
366*64e33c5cSCy Schubert# Set it to YES to include the internal documentation.
367*64e33c5cSCy Schubert
368*64e33c5cSCy SchubertINTERNAL_DOCS          = NO
369*64e33c5cSCy Schubert
370*64e33c5cSCy Schubert# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
371*64e33c5cSCy Schubert# file names in lower-case letters. If set to YES upper-case letters are also
372*64e33c5cSCy Schubert# allowed. This is useful if you have classes or files whose names only differ
373*64e33c5cSCy Schubert# in case and if your file system supports case sensitive file names. Windows
374*64e33c5cSCy Schubert# and Mac users are advised to set this option to NO.
375*64e33c5cSCy Schubert
376*64e33c5cSCy SchubertCASE_SENSE_NAMES       = YES
377*64e33c5cSCy Schubert
378*64e33c5cSCy Schubert# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
379*64e33c5cSCy Schubert# will show members with their full class and namespace scopes in the
380*64e33c5cSCy Schubert# documentation. If set to YES the scope will be hidden.
381*64e33c5cSCy Schubert
382*64e33c5cSCy SchubertHIDE_SCOPE_NAMES       = NO
383*64e33c5cSCy Schubert
384*64e33c5cSCy Schubert# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
385*64e33c5cSCy Schubert# will put a list of the files that are included by a file in the documentation
386*64e33c5cSCy Schubert# of that file.
387*64e33c5cSCy Schubert
388*64e33c5cSCy SchubertSHOW_INCLUDE_FILES     = YES
389*64e33c5cSCy Schubert
390*64e33c5cSCy Schubert# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
391*64e33c5cSCy Schubert# will list include files with double quotes in the documentation
392*64e33c5cSCy Schubert# rather than with sharp brackets.
393*64e33c5cSCy Schubert
394*64e33c5cSCy SchubertFORCE_LOCAL_INCLUDES   = NO
395*64e33c5cSCy Schubert
396*64e33c5cSCy Schubert# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
397*64e33c5cSCy Schubert# is inserted in the documentation for inline members.
398*64e33c5cSCy Schubert
399*64e33c5cSCy SchubertINLINE_INFO            = YES
400*64e33c5cSCy Schubert
401*64e33c5cSCy Schubert# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
402*64e33c5cSCy Schubert# will sort the (detailed) documentation of file and class members
403*64e33c5cSCy Schubert# alphabetically by member name. If set to NO the members will appear in
404*64e33c5cSCy Schubert# declaration order.
405*64e33c5cSCy Schubert
406*64e33c5cSCy SchubertSORT_MEMBER_DOCS       = NO
407*64e33c5cSCy Schubert
408*64e33c5cSCy Schubert# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
409*64e33c5cSCy Schubert# brief documentation of file, namespace and class members alphabetically
410*64e33c5cSCy Schubert# by member name. If set to NO (the default) the members will appear in
411*64e33c5cSCy Schubert# declaration order.
412*64e33c5cSCy Schubert
413*64e33c5cSCy SchubertSORT_BRIEF_DOCS        = NO
414*64e33c5cSCy Schubert
415*64e33c5cSCy Schubert# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
416*64e33c5cSCy Schubert# will sort the (brief and detailed) documentation of class members so that
417*64e33c5cSCy Schubert# constructors and destructors are listed first. If set to NO (the default)
418*64e33c5cSCy Schubert# the constructors will appear in the respective orders defined by
419*64e33c5cSCy Schubert# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
420*64e33c5cSCy Schubert# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
421*64e33c5cSCy Schubert# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
422*64e33c5cSCy Schubert
423*64e33c5cSCy SchubertSORT_MEMBERS_CTORS_1ST = NO
424*64e33c5cSCy Schubert
425*64e33c5cSCy Schubert# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
426*64e33c5cSCy Schubert# hierarchy of group names into alphabetical order. If set to NO (the default)
427*64e33c5cSCy Schubert# the group names will appear in their defined order.
428*64e33c5cSCy Schubert
429*64e33c5cSCy SchubertSORT_GROUP_NAMES       = NO
430*64e33c5cSCy Schubert
431*64e33c5cSCy Schubert# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
432*64e33c5cSCy Schubert# sorted by fully-qualified names, including namespaces. If set to
433*64e33c5cSCy Schubert# NO (the default), the class list will be sorted only by class name,
434*64e33c5cSCy Schubert# not including the namespace part.
435*64e33c5cSCy Schubert# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
436*64e33c5cSCy Schubert# Note: This option applies only to the class list, not to the
437*64e33c5cSCy Schubert# alphabetical list.
438*64e33c5cSCy Schubert
439*64e33c5cSCy SchubertSORT_BY_SCOPE_NAME     = NO
440*64e33c5cSCy Schubert
441*64e33c5cSCy Schubert# The GENERATE_TODOLIST tag can be used to enable (YES) or
442*64e33c5cSCy Schubert# disable (NO) the todo list. This list is created by putting \todo
443*64e33c5cSCy Schubert# commands in the documentation.
444*64e33c5cSCy Schubert
445*64e33c5cSCy SchubertGENERATE_TODOLIST      = YES
446*64e33c5cSCy Schubert
447*64e33c5cSCy Schubert# The GENERATE_TESTLIST tag can be used to enable (YES) or
448*64e33c5cSCy Schubert# disable (NO) the test list. This list is created by putting \test
449*64e33c5cSCy Schubert# commands in the documentation.
450*64e33c5cSCy Schubert
451*64e33c5cSCy SchubertGENERATE_TESTLIST      = YES
452*64e33c5cSCy Schubert
453*64e33c5cSCy Schubert# The GENERATE_BUGLIST tag can be used to enable (YES) or
454*64e33c5cSCy Schubert# disable (NO) the bug list. This list is created by putting \bug
455*64e33c5cSCy Schubert# commands in the documentation.
456*64e33c5cSCy Schubert
457*64e33c5cSCy SchubertGENERATE_BUGLIST       = YES
458*64e33c5cSCy Schubert
459*64e33c5cSCy Schubert# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
460*64e33c5cSCy Schubert# disable (NO) the deprecated list. This list is created by putting
461*64e33c5cSCy Schubert# \deprecated commands in the documentation.
462*64e33c5cSCy Schubert
463*64e33c5cSCy SchubertGENERATE_DEPRECATEDLIST= YES
464*64e33c5cSCy Schubert
465*64e33c5cSCy Schubert# The ENABLED_SECTIONS tag can be used to enable conditional
466*64e33c5cSCy Schubert# documentation sections, marked by \if sectionname ... \endif.
467*64e33c5cSCy Schubert
468*64e33c5cSCy SchubertENABLED_SECTIONS       =
469*64e33c5cSCy Schubert
470*64e33c5cSCy Schubert# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
471*64e33c5cSCy Schubert# the initial value of a variable or define consists of for it to appear in
472*64e33c5cSCy Schubert# the documentation. If the initializer consists of more lines than specified
473*64e33c5cSCy Schubert# here it will be hidden. Use a value of 0 to hide initializers completely.
474*64e33c5cSCy Schubert# The appearance of the initializer of individual variables and defines in the
475*64e33c5cSCy Schubert# documentation can be controlled using \showinitializer or \hideinitializer
476*64e33c5cSCy Schubert# command in the documentation regardless of this setting.
477*64e33c5cSCy Schubert
478*64e33c5cSCy SchubertMAX_INITIALIZER_LINES  = 30
479*64e33c5cSCy Schubert
480*64e33c5cSCy Schubert# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
481*64e33c5cSCy Schubert# at the bottom of the documentation of classes and structs. If set to YES the
482*64e33c5cSCy Schubert# list will mention the files that were used to generate the documentation.
483*64e33c5cSCy Schubert
484*64e33c5cSCy SchubertSHOW_USED_FILES        = YES
485*64e33c5cSCy Schubert
486*64e33c5cSCy Schubert# If the sources in your project are distributed over multiple directories
487*64e33c5cSCy Schubert# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
488*64e33c5cSCy Schubert# in the documentation. The default is NO.
489*64e33c5cSCy Schubert
490*64e33c5cSCy Schubert#SHOW_DIRECTORIES       = YES
491*64e33c5cSCy Schubert
492*64e33c5cSCy Schubert# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
493*64e33c5cSCy Schubert# This will remove the Files entry from the Quick Index and from the
494*64e33c5cSCy Schubert# Folder Tree View (if specified). The default is YES.
495*64e33c5cSCy Schubert
496*64e33c5cSCy SchubertSHOW_FILES             = YES
497*64e33c5cSCy Schubert
498*64e33c5cSCy Schubert# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
499*64e33c5cSCy Schubert# Namespaces page.
500*64e33c5cSCy Schubert# This will remove the Namespaces entry from the Quick Index
501*64e33c5cSCy Schubert# and from the Folder Tree View (if specified). The default is YES.
502*64e33c5cSCy Schubert
503*64e33c5cSCy SchubertSHOW_NAMESPACES        = YES
504*64e33c5cSCy Schubert
505*64e33c5cSCy Schubert# The FILE_VERSION_FILTER tag can be used to specify a program or script that
506*64e33c5cSCy Schubert# doxygen should invoke to get the current version for each file (typically from
507*64e33c5cSCy Schubert# the version control system). Doxygen will invoke the program by executing (via
508*64e33c5cSCy Schubert# popen()) the command <command> <input-file>, where <command> is the value of
509*64e33c5cSCy Schubert# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
510*64e33c5cSCy Schubert# provided by doxygen. Whatever the program writes to standard output
511*64e33c5cSCy Schubert# is used as the file version. See the manual for examples.
512*64e33c5cSCy Schubert
513*64e33c5cSCy SchubertFILE_VERSION_FILTER    =
514*64e33c5cSCy Schubert
515*64e33c5cSCy Schubert# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
516*64e33c5cSCy Schubert# by doxygen. The layout file controls the global structure of the generated
517*64e33c5cSCy Schubert# output files in an output format independent way. The create the layout file
518*64e33c5cSCy Schubert# that represents doxygen's defaults, run doxygen with the -l option.
519*64e33c5cSCy Schubert# You can optionally specify a file name after the option, if omitted
520*64e33c5cSCy Schubert# DoxygenLayout.xml will be used as the name of the layout file.
521*64e33c5cSCy Schubert
522*64e33c5cSCy SchubertLAYOUT_FILE            =
523*64e33c5cSCy Schubert
524*64e33c5cSCy Schubert#---------------------------------------------------------------------------
525*64e33c5cSCy Schubert# configuration options related to warning and progress messages
526*64e33c5cSCy Schubert#---------------------------------------------------------------------------
527*64e33c5cSCy Schubert
528*64e33c5cSCy Schubert# The QUIET tag can be used to turn on/off the messages that are generated
529*64e33c5cSCy Schubert# by doxygen. Possible values are YES and NO. If left blank NO is used.
530*64e33c5cSCy Schubert
531*64e33c5cSCy SchubertQUIET                  = YES
532*64e33c5cSCy Schubert
533*64e33c5cSCy Schubert# The WARNINGS tag can be used to turn on/off the warning messages that are
534*64e33c5cSCy Schubert# generated by doxygen. Possible values are YES and NO. If left blank
535*64e33c5cSCy Schubert# NO is used.
536*64e33c5cSCy Schubert
537*64e33c5cSCy SchubertWARNINGS               = YES
538*64e33c5cSCy Schubert
539*64e33c5cSCy Schubert# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
540*64e33c5cSCy Schubert# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
541*64e33c5cSCy Schubert# automatically be disabled.
542*64e33c5cSCy Schubert
543*64e33c5cSCy SchubertWARN_IF_UNDOCUMENTED   = NO
544*64e33c5cSCy Schubert
545*64e33c5cSCy Schubert# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
546*64e33c5cSCy Schubert# potential errors in the documentation, such as not documenting some
547*64e33c5cSCy Schubert# parameters in a documented function, or documenting parameters that
548*64e33c5cSCy Schubert# don't exist or using markup commands wrongly.
549*64e33c5cSCy Schubert
550*64e33c5cSCy SchubertWARN_IF_DOC_ERROR      = YES
551*64e33c5cSCy Schubert
552*64e33c5cSCy Schubert# This WARN_NO_PARAMDOC option can be abled to get warnings for
553*64e33c5cSCy Schubert# functions that are documented, but have no documentation for their parameters
554*64e33c5cSCy Schubert# or return value. If set to NO (the default) doxygen will only warn about
555*64e33c5cSCy Schubert# wrong or incomplete parameter documentation, but not about the absence of
556*64e33c5cSCy Schubert# documentation.
557*64e33c5cSCy Schubert
558*64e33c5cSCy SchubertWARN_NO_PARAMDOC       = YES
559*64e33c5cSCy Schubert
560*64e33c5cSCy Schubert# The WARN_FORMAT tag determines the format of the warning messages that
561*64e33c5cSCy Schubert# doxygen can produce. The string should contain the $file, $line, and $text
562*64e33c5cSCy Schubert# tags, which will be replaced by the file and line number from which the
563*64e33c5cSCy Schubert# warning originated and the warning text. Optionally the format may contain
564*64e33c5cSCy Schubert# $version, which will be replaced by the version of the file (if it could
565*64e33c5cSCy Schubert# be obtained via FILE_VERSION_FILTER)
566*64e33c5cSCy Schubert
567*64e33c5cSCy SchubertWARN_FORMAT            = "$file:$line: $text"
568*64e33c5cSCy Schubert
569*64e33c5cSCy Schubert# The WARN_LOGFILE tag can be used to specify a file to which warning
570*64e33c5cSCy Schubert# and error messages should be written. If left blank the output is written
571*64e33c5cSCy Schubert# to stderr.
572*64e33c5cSCy Schubert
573*64e33c5cSCy SchubertWARN_LOGFILE           =
574*64e33c5cSCy Schubert
575*64e33c5cSCy Schubert#---------------------------------------------------------------------------
576*64e33c5cSCy Schubert# configuration options related to the input files
577*64e33c5cSCy Schubert#---------------------------------------------------------------------------
578*64e33c5cSCy Schubert
579*64e33c5cSCy Schubert# The INPUT tag can be used to specify the files and/or directories that contain
580*64e33c5cSCy Schubert# documented source files. You may enter file names like "myfile.cpp" or
581*64e33c5cSCy Schubert# directories like "/usr/src/myproject". Separate the files or directories
582*64e33c5cSCy Schubert# with spaces.
583*64e33c5cSCy Schubert
584*64e33c5cSCy SchubertINPUT                  = .
585*64e33c5cSCy Schubert
586*64e33c5cSCy Schubert# This tag can be used to specify the character encoding of the source files
587*64e33c5cSCy Schubert# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
588*64e33c5cSCy Schubert# also the default input encoding. Doxygen uses libiconv (or the iconv built
589*64e33c5cSCy Schubert# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
590*64e33c5cSCy Schubert# the list of possible encodings.
591*64e33c5cSCy Schubert
592*64e33c5cSCy SchubertINPUT_ENCODING         = UTF-8
593*64e33c5cSCy Schubert
594*64e33c5cSCy Schubert# If the value of the INPUT tag contains directories, you can use the
595*64e33c5cSCy Schubert# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
596*64e33c5cSCy Schubert# and *.h) to filter out the source-files in the directories. If left
597*64e33c5cSCy Schubert# blank the following patterns are tested:
598*64e33c5cSCy Schubert# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
599*64e33c5cSCy Schubert# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
600*64e33c5cSCy Schubert
601*64e33c5cSCy SchubertFILE_PATTERNS          =
602*64e33c5cSCy Schubert
603*64e33c5cSCy Schubert# The RECURSIVE tag can be used to turn specify whether or not subdirectories
604*64e33c5cSCy Schubert# should be searched for input files as well. Possible values are YES and NO.
605*64e33c5cSCy Schubert# If left blank NO is used.
606*64e33c5cSCy Schubert
607*64e33c5cSCy SchubertRECURSIVE              = YES
608*64e33c5cSCy Schubert
609*64e33c5cSCy Schubert# The EXCLUDE tag can be used to specify files and/or directories that should
610*64e33c5cSCy Schubert# excluded from the INPUT source files. This way you can easily exclude a
611*64e33c5cSCy Schubert# subdirectory from a directory tree whose root is specified with the INPUT tag.
612*64e33c5cSCy Schubert
613*64e33c5cSCy SchubertEXCLUDE                = ./build \
614*64e33c5cSCy Schubert                         ./compat \
615*64e33c5cSCy Schubert			 ./contrib \
616*64e33c5cSCy Schubert                         util/configparser.c \
617*64e33c5cSCy Schubert                         util/configparser.h \
618*64e33c5cSCy Schubert                         util/configlexer.c \
619*64e33c5cSCy Schubert                         util/locks.h \
620*64e33c5cSCy Schubert                         pythonmod/doc \
621*64e33c5cSCy Schubert                         pythonmod/examples \
622*64e33c5cSCy Schubert                         pythonmod/unboundmodule.py \
623*64e33c5cSCy Schubert                         pythonmod/interface.h \
624*64e33c5cSCy Schubert                         pythonmod/ubmodule-msg.py \
625*64e33c5cSCy Schubert                         pythonmod/ubmodule-tst.py \
626*64e33c5cSCy Schubert			 unboundmodule.py \
627*64e33c5cSCy Schubert                         libunbound/python/unbound.py \
628*64e33c5cSCy Schubert                         libunbound/python/libunbound_wrap.c \
629*64e33c5cSCy Schubert                         libunbound/python/doc \
630*64e33c5cSCy Schubert                         libunbound/python/examples \
631*64e33c5cSCy Schubert                         ./ldns-src \
632*64e33c5cSCy Schubert			 README.md \
633*64e33c5cSCy Schubert			 doc/control_proto_spec.txt \
634*64e33c5cSCy Schubert			 doc/requirements.txt
635*64e33c5cSCy Schubert
636*64e33c5cSCy Schubert# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
637*64e33c5cSCy Schubert# directories that are symbolic links (a Unix filesystem feature) are excluded
638*64e33c5cSCy Schubert# from the input.
639*64e33c5cSCy Schubert
640*64e33c5cSCy SchubertEXCLUDE_SYMLINKS       = NO
641*64e33c5cSCy Schubert
642*64e33c5cSCy Schubert# If the value of the INPUT tag contains directories, you can use the
643*64e33c5cSCy Schubert# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
644*64e33c5cSCy Schubert# certain files from those directories. Note that the wildcards are matched
645*64e33c5cSCy Schubert# against the file with absolute path, so to exclude all test directories
646*64e33c5cSCy Schubert# for example use the pattern */test/*
647*64e33c5cSCy Schubert
648*64e33c5cSCy SchubertEXCLUDE_PATTERNS       =
649*64e33c5cSCy Schubert
650*64e33c5cSCy Schubert# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
651*64e33c5cSCy Schubert# (namespaces, classes, functions, etc.) that should be excluded from the
652*64e33c5cSCy Schubert# output. The symbol name can be a fully qualified name, a word, or if the
653*64e33c5cSCy Schubert# wildcard * is used, a substring. Examples: ANamespace, AClass,
654*64e33c5cSCy Schubert# AClass::ANamespace, ANamespace::*Test
655*64e33c5cSCy Schubert
656*64e33c5cSCy SchubertEXCLUDE_SYMBOLS        =
657*64e33c5cSCy Schubert
658*64e33c5cSCy Schubert# The EXAMPLE_PATH tag can be used to specify one or more files or
659*64e33c5cSCy Schubert# directories that contain example code fragments that are included (see
660*64e33c5cSCy Schubert# the \include command).
661*64e33c5cSCy Schubert
662*64e33c5cSCy SchubertEXAMPLE_PATH           =
663*64e33c5cSCy Schubert
664*64e33c5cSCy Schubert# If the value of the EXAMPLE_PATH tag contains directories, you can use the
665*64e33c5cSCy Schubert# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
666*64e33c5cSCy Schubert# and *.h) to filter out the source-files in the directories. If left
667*64e33c5cSCy Schubert# blank all files are included.
668*64e33c5cSCy Schubert
669*64e33c5cSCy SchubertEXAMPLE_PATTERNS       =
670*64e33c5cSCy Schubert
671*64e33c5cSCy Schubert# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
672*64e33c5cSCy Schubert# searched for input files to be used with the \include or \dontinclude
673*64e33c5cSCy Schubert# commands irrespective of the value of the RECURSIVE tag.
674*64e33c5cSCy Schubert# Possible values are YES and NO. If left blank NO is used.
675*64e33c5cSCy Schubert
676*64e33c5cSCy SchubertEXAMPLE_RECURSIVE      = NO
677*64e33c5cSCy Schubert
678*64e33c5cSCy Schubert# The IMAGE_PATH tag can be used to specify one or more files or
679*64e33c5cSCy Schubert# directories that contain image that are included in the documentation (see
680*64e33c5cSCy Schubert# the \image command).
681*64e33c5cSCy Schubert
682*64e33c5cSCy SchubertIMAGE_PATH             =
683*64e33c5cSCy Schubert
684*64e33c5cSCy Schubert# The INPUT_FILTER tag can be used to specify a program that doxygen should
685*64e33c5cSCy Schubert# invoke to filter for each input file. Doxygen will invoke the filter program
686*64e33c5cSCy Schubert# by executing (via popen()) the command <filter> <input-file>, where <filter>
687*64e33c5cSCy Schubert# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
688*64e33c5cSCy Schubert# input file. Doxygen will then use the output that the filter program writes
689*64e33c5cSCy Schubert# to standard output.
690*64e33c5cSCy Schubert# If FILTER_PATTERNS is specified, this tag will be
691*64e33c5cSCy Schubert# ignored.
692*64e33c5cSCy Schubert
693*64e33c5cSCy SchubertINPUT_FILTER           =
694*64e33c5cSCy Schubert
695*64e33c5cSCy Schubert# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
696*64e33c5cSCy Schubert# basis.
697*64e33c5cSCy Schubert# Doxygen will compare the file name with each pattern and apply the
698*64e33c5cSCy Schubert# filter if there is a match.
699*64e33c5cSCy Schubert# The filters are a list of the form:
700*64e33c5cSCy Schubert# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
701*64e33c5cSCy Schubert# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
702*64e33c5cSCy Schubert# is applied to all files.
703*64e33c5cSCy Schubert
704*64e33c5cSCy SchubertFILTER_PATTERNS        =
705*64e33c5cSCy Schubert
706*64e33c5cSCy Schubert# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
707*64e33c5cSCy Schubert# INPUT_FILTER) will be used to filter the input files when producing source
708*64e33c5cSCy Schubert# files to browse (i.e. when SOURCE_BROWSER is set to YES).
709*64e33c5cSCy Schubert
710*64e33c5cSCy SchubertFILTER_SOURCE_FILES    = NO
711*64e33c5cSCy Schubert
712*64e33c5cSCy Schubert#---------------------------------------------------------------------------
713*64e33c5cSCy Schubert# configuration options related to source browsing
714*64e33c5cSCy Schubert#---------------------------------------------------------------------------
715*64e33c5cSCy Schubert
716*64e33c5cSCy Schubert# If the SOURCE_BROWSER tag is set to YES then a list of source files will
717*64e33c5cSCy Schubert# be generated. Documented entities will be cross-referenced with these sources.
718*64e33c5cSCy Schubert# Note: To get rid of all source code in the generated output, make sure also
719*64e33c5cSCy Schubert# VERBATIM_HEADERS is set to NO.
720*64e33c5cSCy Schubert
721*64e33c5cSCy SchubertSOURCE_BROWSER         = NO
722*64e33c5cSCy Schubert
723*64e33c5cSCy Schubert# Setting the INLINE_SOURCES tag to YES will include the body
724*64e33c5cSCy Schubert# of functions and classes directly in the documentation.
725*64e33c5cSCy Schubert
726*64e33c5cSCy SchubertINLINE_SOURCES         = NO
727*64e33c5cSCy Schubert
728*64e33c5cSCy Schubert# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
729*64e33c5cSCy Schubert# doxygen to hide any special comment blocks from generated source code
730*64e33c5cSCy Schubert# fragments. Normal C and C++ comments will always remain visible.
731*64e33c5cSCy Schubert
732*64e33c5cSCy SchubertSTRIP_CODE_COMMENTS    = YES
733*64e33c5cSCy Schubert
734*64e33c5cSCy Schubert# If the REFERENCED_BY_RELATION tag is set to YES
735*64e33c5cSCy Schubert# then for each documented function all documented
736*64e33c5cSCy Schubert# functions referencing it will be listed.
737*64e33c5cSCy Schubert
738*64e33c5cSCy SchubertREFERENCED_BY_RELATION = YES
739*64e33c5cSCy Schubert
740*64e33c5cSCy Schubert# If the REFERENCES_RELATION tag is set to YES
741*64e33c5cSCy Schubert# then for each documented function all documented entities
742*64e33c5cSCy Schubert# called/used by that function will be listed.
743*64e33c5cSCy Schubert
744*64e33c5cSCy SchubertREFERENCES_RELATION    = YES
745*64e33c5cSCy Schubert
746*64e33c5cSCy Schubert# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
747*64e33c5cSCy Schubert# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
748*64e33c5cSCy Schubert# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
749*64e33c5cSCy Schubert# link to the source code.
750*64e33c5cSCy Schubert# Otherwise they will link to the documentation.
751*64e33c5cSCy Schubert
752*64e33c5cSCy SchubertREFERENCES_LINK_SOURCE = YES
753*64e33c5cSCy Schubert
754*64e33c5cSCy Schubert# If the USE_HTAGS tag is set to YES then the references to source code
755*64e33c5cSCy Schubert# will point to the HTML generated by the htags(1) tool instead of doxygen
756*64e33c5cSCy Schubert# built-in source browser. The htags tool is part of GNU's global source
757*64e33c5cSCy Schubert# tagging system (see http://www.gnu.org/software/global/global.html). You
758*64e33c5cSCy Schubert# will need version 4.8.6 or higher.
759*64e33c5cSCy Schubert
760*64e33c5cSCy SchubertUSE_HTAGS              = NO
761*64e33c5cSCy Schubert
762*64e33c5cSCy Schubert# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
763*64e33c5cSCy Schubert# will generate a verbatim copy of the header file for each class for
764*64e33c5cSCy Schubert# which an include is specified. Set to NO to disable this.
765*64e33c5cSCy Schubert
766*64e33c5cSCy SchubertVERBATIM_HEADERS       = NO
767*64e33c5cSCy Schubert
768*64e33c5cSCy Schubert#---------------------------------------------------------------------------
769*64e33c5cSCy Schubert# configuration options related to the alphabetical class index
770*64e33c5cSCy Schubert#---------------------------------------------------------------------------
771*64e33c5cSCy Schubert
772*64e33c5cSCy Schubert# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
773*64e33c5cSCy Schubert# of all compounds will be generated. Enable this if the project
774*64e33c5cSCy Schubert# contains a lot of classes, structs, unions or interfaces.
775*64e33c5cSCy Schubert
776*64e33c5cSCy SchubertALPHABETICAL_INDEX     = YES
777*64e33c5cSCy Schubert
778*64e33c5cSCy Schubert# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
779*64e33c5cSCy Schubert# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
780*64e33c5cSCy Schubert# in which this list will be split (can be a number in the range [1..20])
781*64e33c5cSCy Schubert
782*64e33c5cSCy Schubert#COLS_IN_ALPHA_INDEX    = 5
783*64e33c5cSCy Schubert
784*64e33c5cSCy Schubert# In case all classes in a project start with a common prefix, all
785*64e33c5cSCy Schubert# classes will be put under the same header in the alphabetical index.
786*64e33c5cSCy Schubert# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
787*64e33c5cSCy Schubert# should be ignored while generating the index headers.
788*64e33c5cSCy Schubert
789*64e33c5cSCy SchubertIGNORE_PREFIX          =
790*64e33c5cSCy Schubert
791*64e33c5cSCy Schubert#---------------------------------------------------------------------------
792*64e33c5cSCy Schubert# configuration options related to the HTML output
793*64e33c5cSCy Schubert#---------------------------------------------------------------------------
794*64e33c5cSCy Schubert
795*64e33c5cSCy Schubert# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
796*64e33c5cSCy Schubert# generate HTML output.
797*64e33c5cSCy Schubert
798*64e33c5cSCy SchubertGENERATE_HTML          = YES
799*64e33c5cSCy Schubert
800*64e33c5cSCy Schubert# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
801*64e33c5cSCy Schubert# If a relative path is entered the value of OUTPUT_DIRECTORY will be
802*64e33c5cSCy Schubert# put in front of it. If left blank `html' will be used as the default path.
803*64e33c5cSCy Schubert
804*64e33c5cSCy SchubertHTML_OUTPUT            = html
805*64e33c5cSCy Schubert
806*64e33c5cSCy Schubert# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
807*64e33c5cSCy Schubert# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
808*64e33c5cSCy Schubert# doxygen will generate files with .html extension.
809*64e33c5cSCy Schubert
810*64e33c5cSCy SchubertHTML_FILE_EXTENSION    = .html
811*64e33c5cSCy Schubert
812*64e33c5cSCy Schubert# The HTML_HEADER tag can be used to specify a personal HTML header for
813*64e33c5cSCy Schubert# each generated HTML page. If it is left blank doxygen will generate a
814*64e33c5cSCy Schubert# standard header.
815*64e33c5cSCy Schubert
816*64e33c5cSCy SchubertHTML_HEADER            =
817*64e33c5cSCy Schubert
818*64e33c5cSCy Schubert# The HTML_FOOTER tag can be used to specify a personal HTML footer for
819*64e33c5cSCy Schubert# each generated HTML page. If it is left blank doxygen will generate a
820*64e33c5cSCy Schubert# standard footer.
821*64e33c5cSCy Schubert
822*64e33c5cSCy SchubertHTML_FOOTER            =
823*64e33c5cSCy Schubert
824*64e33c5cSCy Schubert# If the HTML_TIMESTAMP tag is set to YES then the generated HTML
825*64e33c5cSCy Schubert# documentation will contain the timesstamp.
826*64e33c5cSCy Schubert
827*64e33c5cSCy SchubertHTML_TIMESTAMP         = NO
828*64e33c5cSCy Schubert
829*64e33c5cSCy Schubert# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
830*64e33c5cSCy Schubert# style sheet that is used by each HTML page. It can be used to
831*64e33c5cSCy Schubert# fine-tune the look of the HTML output. If the tag is left blank doxygen
832*64e33c5cSCy Schubert# will generate a default style sheet. Note that doxygen will try to copy
833*64e33c5cSCy Schubert# the style sheet file to the HTML output directory, so don't put your own
834*64e33c5cSCy Schubert# stylesheet in the HTML output directory as well, or it will be erased!
835*64e33c5cSCy Schubert
836*64e33c5cSCy SchubertHTML_STYLESHEET        =
837*64e33c5cSCy Schubert
838*64e33c5cSCy Schubert# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
839*64e33c5cSCy Schubert# Doxygen will adjust the colors in the stylesheet and background images
840*64e33c5cSCy Schubert# according to this color. Hue is specified as an angle on a colorwheel,
841*64e33c5cSCy Schubert# see http://en.wikipedia.org/wiki/Hue for more information.
842*64e33c5cSCy Schubert# For instance the value 0 represents red, 60 is yellow, 120 is green,
843*64e33c5cSCy Schubert# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
844*64e33c5cSCy Schubert# The allowed range is 0 to 359.
845*64e33c5cSCy Schubert
846*64e33c5cSCy Schubert#HTML_COLORSTYLE_HUE    = 220
847*64e33c5cSCy Schubert
848*64e33c5cSCy Schubert# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
849*64e33c5cSCy Schubert# the colors in the HTML output. For a value of 0 the output will use
850*64e33c5cSCy Schubert# grayscales only. A value of 255 will produce the most vivid colors.
851*64e33c5cSCy Schubert
852*64e33c5cSCy Schubert#HTML_COLORSTYLE_SAT    = 100
853*64e33c5cSCy Schubert
854*64e33c5cSCy Schubert# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
855*64e33c5cSCy Schubert# the luminance component of the colors in the HTML output. Values below
856*64e33c5cSCy Schubert# 100 gradually make the output lighter, whereas values above 100 make
857*64e33c5cSCy Schubert# the output darker. The value divided by 100 is the actual gamma applied,
858*64e33c5cSCy Schubert# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
859*64e33c5cSCy Schubert# and 100 does not change the gamma.
860*64e33c5cSCy Schubert
861*64e33c5cSCy Schubert#HTML_COLORSTYLE_GAMMA  = 80
862*64e33c5cSCy Schubert
863*64e33c5cSCy Schubert# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
864*64e33c5cSCy Schubert# page will contain the date and time when the page was generated. Setting
865*64e33c5cSCy Schubert# this to NO can help when comparing the output of multiple runs.
866*64e33c5cSCy Schubert
867*64e33c5cSCy SchubertHTML_TIMESTAMP         = YES
868*64e33c5cSCy Schubert
869*64e33c5cSCy Schubert# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
870*64e33c5cSCy Schubert# files or namespaces will be aligned in HTML using tables. If set to
871*64e33c5cSCy Schubert# NO a bullet list will be used.
872*64e33c5cSCy Schubert
873*64e33c5cSCy Schubert#HTML_ALIGN_MEMBERS     = YES
874*64e33c5cSCy Schubert
875*64e33c5cSCy Schubert# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
876*64e33c5cSCy Schubert# documentation will contain sections that can be hidden and shown after the
877*64e33c5cSCy Schubert# page has loaded. For this to work a browser that supports
878*64e33c5cSCy Schubert# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
879*64e33c5cSCy Schubert# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
880*64e33c5cSCy Schubert
881*64e33c5cSCy SchubertHTML_DYNAMIC_SECTIONS  = NO
882*64e33c5cSCy Schubert
883*64e33c5cSCy Schubert# If the GENERATE_DOCSET tag is set to YES, additional index files
884*64e33c5cSCy Schubert# will be generated that can be used as input for Apple's Xcode 3
885*64e33c5cSCy Schubert# integrated development environment, introduced with OSX 10.5 (Leopard).
886*64e33c5cSCy Schubert# To create a documentation set, doxygen will generate a Makefile in the
887*64e33c5cSCy Schubert# HTML output directory. Running make will produce the docset in that
888*64e33c5cSCy Schubert# directory and running "make install" will install the docset in
889*64e33c5cSCy Schubert# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
890*64e33c5cSCy Schubert# it at startup.
891*64e33c5cSCy Schubert# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
892*64e33c5cSCy Schubert# for more information.
893*64e33c5cSCy Schubert
894*64e33c5cSCy SchubertGENERATE_DOCSET        = NO
895*64e33c5cSCy Schubert
896*64e33c5cSCy Schubert# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
897*64e33c5cSCy Schubert# feed. A documentation feed provides an umbrella under which multiple
898*64e33c5cSCy Schubert# documentation sets from a single provider (such as a company or product suite)
899*64e33c5cSCy Schubert# can be grouped.
900*64e33c5cSCy Schubert
901*64e33c5cSCy SchubertDOCSET_FEEDNAME        = "Doxygen generated docs"
902*64e33c5cSCy Schubert
903*64e33c5cSCy Schubert# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
904*64e33c5cSCy Schubert# should uniquely identify the documentation set bundle. This should be a
905*64e33c5cSCy Schubert# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
906*64e33c5cSCy Schubert# will append .docset to the name.
907*64e33c5cSCy Schubert
908*64e33c5cSCy SchubertDOCSET_BUNDLE_ID       = org.doxygen.Project
909*64e33c5cSCy Schubert
910*64e33c5cSCy Schubert# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
911*64e33c5cSCy Schubert# the documentation publisher. This should be a reverse domain-name style
912*64e33c5cSCy Schubert# string, e.g. com.mycompany.MyDocSet.documentation.
913*64e33c5cSCy Schubert
914*64e33c5cSCy Schubert#DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
915*64e33c5cSCy Schubert
916*64e33c5cSCy Schubert# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
917*64e33c5cSCy Schubert
918*64e33c5cSCy Schubert#DOCSET_PUBLISHER_NAME  = Publisher
919*64e33c5cSCy Schubert
920*64e33c5cSCy Schubert# If the GENERATE_HTMLHELP tag is set to YES, additional index files
921*64e33c5cSCy Schubert# will be generated that can be used as input for tools like the
922*64e33c5cSCy Schubert# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
923*64e33c5cSCy Schubert# of the generated HTML documentation.
924*64e33c5cSCy Schubert
925*64e33c5cSCy SchubertGENERATE_HTMLHELP      = NO
926*64e33c5cSCy Schubert
927*64e33c5cSCy Schubert# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
928*64e33c5cSCy Schubert# be used to specify the file name of the resulting .chm file. You
929*64e33c5cSCy Schubert# can add a path in front of the file if the result should not be
930*64e33c5cSCy Schubert# written to the html output directory.
931*64e33c5cSCy Schubert
932*64e33c5cSCy SchubertCHM_FILE               =
933*64e33c5cSCy Schubert
934*64e33c5cSCy Schubert# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
935*64e33c5cSCy Schubert# be used to specify the location (absolute path including file name) of
936*64e33c5cSCy Schubert# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
937*64e33c5cSCy Schubert# the HTML help compiler on the generated index.hhp.
938*64e33c5cSCy Schubert
939*64e33c5cSCy SchubertHHC_LOCATION           =
940*64e33c5cSCy Schubert
941*64e33c5cSCy Schubert# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
942*64e33c5cSCy Schubert# controls if a separate .chi index file is generated (YES) or that
943*64e33c5cSCy Schubert# it should be included in the master .chm file (NO).
944*64e33c5cSCy Schubert
945*64e33c5cSCy SchubertGENERATE_CHI           = NO
946*64e33c5cSCy Schubert
947*64e33c5cSCy Schubert# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
948*64e33c5cSCy Schubert# is used to encode HtmlHelp index (hhk), content (hhc) and project file
949*64e33c5cSCy Schubert# content.
950*64e33c5cSCy Schubert
951*64e33c5cSCy SchubertCHM_INDEX_ENCODING     =
952*64e33c5cSCy Schubert
953*64e33c5cSCy Schubert# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
954*64e33c5cSCy Schubert# controls whether a binary table of contents is generated (YES) or a
955*64e33c5cSCy Schubert# normal table of contents (NO) in the .chm file.
956*64e33c5cSCy Schubert
957*64e33c5cSCy SchubertBINARY_TOC             = NO
958*64e33c5cSCy Schubert
959*64e33c5cSCy Schubert# The TOC_EXPAND flag can be set to YES to add extra items for group members
960*64e33c5cSCy Schubert# to the contents of the HTML help documentation and to the tree view.
961*64e33c5cSCy Schubert
962*64e33c5cSCy SchubertTOC_EXPAND             = NO
963*64e33c5cSCy Schubert
964*64e33c5cSCy Schubert# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
965*64e33c5cSCy Schubert# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
966*64e33c5cSCy Schubert# that can be used as input for Qt's qhelpgenerator to generate a
967*64e33c5cSCy Schubert# Qt Compressed Help (.qch) of the generated HTML documentation.
968*64e33c5cSCy Schubert
969*64e33c5cSCy SchubertGENERATE_QHP           = NO
970*64e33c5cSCy Schubert
971*64e33c5cSCy Schubert# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
972*64e33c5cSCy Schubert# be used to specify the file name of the resulting .qch file.
973*64e33c5cSCy Schubert# The path specified is relative to the HTML output folder.
974*64e33c5cSCy Schubert
975*64e33c5cSCy SchubertQCH_FILE               =
976*64e33c5cSCy Schubert
977*64e33c5cSCy Schubert# The QHP_NAMESPACE tag specifies the namespace to use when generating
978*64e33c5cSCy Schubert# Qt Help Project output. For more information please see
979*64e33c5cSCy Schubert# http://doc.trolltech.com/qthelpproject.html#namespace
980*64e33c5cSCy Schubert
981*64e33c5cSCy SchubertQHP_NAMESPACE          = org.doxygen.Project
982*64e33c5cSCy Schubert
983*64e33c5cSCy Schubert# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
984*64e33c5cSCy Schubert# Qt Help Project output. For more information please see
985*64e33c5cSCy Schubert# http://doc.trolltech.com/qthelpproject.html#virtual-folders
986*64e33c5cSCy Schubert
987*64e33c5cSCy SchubertQHP_VIRTUAL_FOLDER     = doc
988*64e33c5cSCy Schubert
989*64e33c5cSCy Schubert# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
990*64e33c5cSCy Schubert# add. For more information please see
991*64e33c5cSCy Schubert# http://doc.trolltech.com/qthelpproject.html#custom-filters
992*64e33c5cSCy Schubert
993*64e33c5cSCy SchubertQHP_CUST_FILTER_NAME   =
994*64e33c5cSCy Schubert
995*64e33c5cSCy Schubert# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
996*64e33c5cSCy Schubert# custom filter to add. For more information please see
997*64e33c5cSCy Schubert# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
998*64e33c5cSCy Schubert# Qt Help Project / Custom Filters</a>.
999*64e33c5cSCy Schubert
1000*64e33c5cSCy SchubertQHP_CUST_FILTER_ATTRS  =
1001*64e33c5cSCy Schubert
1002*64e33c5cSCy Schubert# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1003*64e33c5cSCy Schubert# project's
1004*64e33c5cSCy Schubert# filter section matches.
1005*64e33c5cSCy Schubert# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1006*64e33c5cSCy Schubert# Qt Help Project / Filter Attributes</a>.
1007*64e33c5cSCy Schubert
1008*64e33c5cSCy SchubertQHP_SECT_FILTER_ATTRS  =
1009*64e33c5cSCy Schubert
1010*64e33c5cSCy Schubert# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1011*64e33c5cSCy Schubert# be used to specify the location of Qt's qhelpgenerator.
1012*64e33c5cSCy Schubert# If non-empty doxygen will try to run qhelpgenerator on the generated
1013*64e33c5cSCy Schubert# .qhp file.
1014*64e33c5cSCy Schubert
1015*64e33c5cSCy SchubertQHG_LOCATION           =
1016*64e33c5cSCy Schubert
1017*64e33c5cSCy Schubert# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1018*64e33c5cSCy Schubert#  will be generated, which together with the HTML files, form an Eclipse help
1019*64e33c5cSCy Schubert# plugin. To install this plugin and make it available under the help contents
1020*64e33c5cSCy Schubert# menu in Eclipse, the contents of the directory containing the HTML and XML
1021*64e33c5cSCy Schubert# files needs to be copied into the plugins directory of eclipse. The name of
1022*64e33c5cSCy Schubert# the directory within the plugins directory should be the same as
1023*64e33c5cSCy Schubert# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1024*64e33c5cSCy Schubert# the help appears.
1025*64e33c5cSCy Schubert
1026*64e33c5cSCy SchubertGENERATE_ECLIPSEHELP   = NO
1027*64e33c5cSCy Schubert
1028*64e33c5cSCy Schubert# A unique identifier for the eclipse help plugin. When installing the plugin
1029*64e33c5cSCy Schubert# the directory name containing the HTML and XML files should also have
1030*64e33c5cSCy Schubert# this name.
1031*64e33c5cSCy Schubert
1032*64e33c5cSCy SchubertECLIPSE_DOC_ID         = org.doxygen.Project
1033*64e33c5cSCy Schubert
1034*64e33c5cSCy Schubert# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1035*64e33c5cSCy Schubert# top of each HTML page. The value NO (the default) enables the index and
1036*64e33c5cSCy Schubert# the value YES disables it.
1037*64e33c5cSCy Schubert
1038*64e33c5cSCy SchubertDISABLE_INDEX          = NO
1039*64e33c5cSCy Schubert
1040*64e33c5cSCy Schubert# This tag can be used to set the number of enum values (range [1..20])
1041*64e33c5cSCy Schubert# that doxygen will group on one line in the generated HTML documentation.
1042*64e33c5cSCy Schubert
1043*64e33c5cSCy SchubertENUM_VALUES_PER_LINE   = 4
1044*64e33c5cSCy Schubert
1045*64e33c5cSCy Schubert# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1046*64e33c5cSCy Schubert# structure should be generated to display hierarchical information.
1047*64e33c5cSCy Schubert# If the tag value is set to YES, a side panel will be generated
1048*64e33c5cSCy Schubert# containing a tree-like index structure (just like the one that
1049*64e33c5cSCy Schubert# is generated for HTML Help). For this to work a browser that supports
1050*64e33c5cSCy Schubert# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1051*64e33c5cSCy Schubert# Windows users are probably better off using the HTML help feature.
1052*64e33c5cSCy Schubert
1053*64e33c5cSCy SchubertGENERATE_TREEVIEW      = NO
1054*64e33c5cSCy Schubert
1055*64e33c5cSCy Schubert# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1056*64e33c5cSCy Schubert# and Class Hierarchy pages using a tree view instead of an ordered list.
1057*64e33c5cSCy Schubert
1058*64e33c5cSCy Schubert#USE_INLINE_TREES       = NO
1059*64e33c5cSCy Schubert
1060*64e33c5cSCy Schubert# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1061*64e33c5cSCy Schubert# used to set the initial width (in pixels) of the frame in which the tree
1062*64e33c5cSCy Schubert# is shown.
1063*64e33c5cSCy Schubert
1064*64e33c5cSCy SchubertTREEVIEW_WIDTH         = 250
1065*64e33c5cSCy Schubert
1066*64e33c5cSCy Schubert# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1067*64e33c5cSCy Schubert# links to external symbols imported via tag files in a separate window.
1068*64e33c5cSCy Schubert
1069*64e33c5cSCy Schubert#EXT_LINKS_IN_WINDOW    = NO
1070*64e33c5cSCy Schubert
1071*64e33c5cSCy Schubert# Use this tag to change the font size of Latex formulas included
1072*64e33c5cSCy Schubert# as images in the HTML documentation. The default is 10. Note that
1073*64e33c5cSCy Schubert# when you change the font size after a successful doxygen run you need
1074*64e33c5cSCy Schubert# to manually remove any form_*.png images from the HTML output directory
1075*64e33c5cSCy Schubert# to force them to be regenerated.
1076*64e33c5cSCy Schubert
1077*64e33c5cSCy SchubertFORMULA_FONTSIZE       = 10
1078*64e33c5cSCy Schubert
1079*64e33c5cSCy Schubert# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1080*64e33c5cSCy Schubert# generated for formulas are transparent PNGs. Transparent PNGs are
1081*64e33c5cSCy Schubert# not supported properly for IE 6.0, but are supported on all modern browsers.
1082*64e33c5cSCy Schubert# Note that when changing this option you need to delete any form_*.png files
1083*64e33c5cSCy Schubert# in the HTML output before the changes have effect.
1084*64e33c5cSCy Schubert
1085*64e33c5cSCy Schubert#FORMULA_TRANSPARENT    = YES
1086*64e33c5cSCy Schubert
1087*64e33c5cSCy Schubert# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1088*64e33c5cSCy Schubert# for the HTML output. The underlying search engine uses javascript
1089*64e33c5cSCy Schubert# and DHTML and should work on any modern browser. Note that when using
1090*64e33c5cSCy Schubert# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1091*64e33c5cSCy Schubert# (GENERATE_DOCSET) there is already a search function so this one should
1092*64e33c5cSCy Schubert# typically be disabled. For large projects the javascript based search engine
1093*64e33c5cSCy Schubert# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1094*64e33c5cSCy Schubert
1095*64e33c5cSCy SchubertSEARCHENGINE           = NO
1096*64e33c5cSCy Schubert
1097*64e33c5cSCy Schubert# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1098*64e33c5cSCy Schubert# implemented using a PHP enabled web server instead of at the web client
1099*64e33c5cSCy Schubert# using Javascript. Doxygen will generate the search PHP script and index
1100*64e33c5cSCy Schubert# file to put on the web server. The advantage of the server
1101*64e33c5cSCy Schubert# based approach is that it scales better to large projects and allows
1102*64e33c5cSCy Schubert# full text search. The disadvances is that it is more difficult to setup
1103*64e33c5cSCy Schubert# and does not have live searching capabilities.
1104*64e33c5cSCy Schubert
1105*64e33c5cSCy SchubertSERVER_BASED_SEARCH    = NO
1106*64e33c5cSCy Schubert
1107*64e33c5cSCy Schubert#---------------------------------------------------------------------------
1108*64e33c5cSCy Schubert# configuration options related to the LaTeX output
1109*64e33c5cSCy Schubert#---------------------------------------------------------------------------
1110*64e33c5cSCy Schubert
1111*64e33c5cSCy Schubert# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1112*64e33c5cSCy Schubert# generate Latex output.
1113*64e33c5cSCy Schubert
1114*64e33c5cSCy SchubertGENERATE_LATEX         = NO
1115*64e33c5cSCy Schubert
1116*64e33c5cSCy Schubert# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1117*64e33c5cSCy Schubert# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1118*64e33c5cSCy Schubert# put in front of it. If left blank `latex' will be used as the default path.
1119*64e33c5cSCy Schubert
1120*64e33c5cSCy SchubertLATEX_OUTPUT           = latex
1121*64e33c5cSCy Schubert
1122*64e33c5cSCy Schubert# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1123*64e33c5cSCy Schubert# invoked. If left blank `latex' will be used as the default command name.
1124*64e33c5cSCy Schubert# Note that when enabling USE_PDFLATEX this option is only used for
1125*64e33c5cSCy Schubert# generating bitmaps for formulas in the HTML output, but not in the
1126*64e33c5cSCy Schubert# Makefile that is written to the output directory.
1127*64e33c5cSCy Schubert
1128*64e33c5cSCy SchubertLATEX_CMD_NAME         = latex
1129*64e33c5cSCy Schubert
1130*64e33c5cSCy Schubert# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1131*64e33c5cSCy Schubert# generate index for LaTeX. If left blank `makeindex' will be used as the
1132*64e33c5cSCy Schubert# default command name.
1133*64e33c5cSCy Schubert
1134*64e33c5cSCy SchubertMAKEINDEX_CMD_NAME     = makeindex
1135*64e33c5cSCy Schubert
1136*64e33c5cSCy Schubert# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1137*64e33c5cSCy Schubert# LaTeX documents. This may be useful for small projects and may help to
1138*64e33c5cSCy Schubert# save some trees in general.
1139*64e33c5cSCy Schubert
1140*64e33c5cSCy SchubertCOMPACT_LATEX          = NO
1141*64e33c5cSCy Schubert
1142*64e33c5cSCy Schubert# The PAPER_TYPE tag can be used to set the paper type that is used
1143*64e33c5cSCy Schubert# by the printer. Possible values are: a4, a4wide, letter, legal and
1144*64e33c5cSCy Schubert# executive. If left blank a4wide will be used.
1145*64e33c5cSCy Schubert
1146*64e33c5cSCy Schubert#PAPER_TYPE             = a4wide
1147*64e33c5cSCy Schubert
1148*64e33c5cSCy Schubert# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1149*64e33c5cSCy Schubert# packages that should be included in the LaTeX output.
1150*64e33c5cSCy Schubert
1151*64e33c5cSCy SchubertEXTRA_PACKAGES         =
1152*64e33c5cSCy Schubert
1153*64e33c5cSCy Schubert# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1154*64e33c5cSCy Schubert# the generated latex document. The header should contain everything until
1155*64e33c5cSCy Schubert# the first chapter. If it is left blank doxygen will generate a
1156*64e33c5cSCy Schubert# standard header. Notice: only use this tag if you know what you are doing!
1157*64e33c5cSCy Schubert
1158*64e33c5cSCy SchubertLATEX_HEADER           =
1159*64e33c5cSCy Schubert
1160*64e33c5cSCy Schubert# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1161*64e33c5cSCy Schubert# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1162*64e33c5cSCy Schubert# contain links (just like the HTML output) instead of page references
1163*64e33c5cSCy Schubert# This makes the output suitable for online browsing using a pdf viewer.
1164*64e33c5cSCy Schubert
1165*64e33c5cSCy SchubertPDF_HYPERLINKS         = NO
1166*64e33c5cSCy Schubert
1167*64e33c5cSCy Schubert# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1168*64e33c5cSCy Schubert# plain latex in the generated Makefile. Set this option to YES to get a
1169*64e33c5cSCy Schubert# higher quality PDF documentation.
1170*64e33c5cSCy Schubert
1171*64e33c5cSCy SchubertUSE_PDFLATEX           = NO
1172*64e33c5cSCy Schubert
1173*64e33c5cSCy Schubert# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1174*64e33c5cSCy Schubert# command to the generated LaTeX files. This will instruct LaTeX to keep
1175*64e33c5cSCy Schubert# running if errors occur, instead of asking the user for help.
1176*64e33c5cSCy Schubert# This option is also used when generating formulas in HTML.
1177*64e33c5cSCy Schubert
1178*64e33c5cSCy SchubertLATEX_BATCHMODE        = NO
1179*64e33c5cSCy Schubert
1180*64e33c5cSCy Schubert# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1181*64e33c5cSCy Schubert# include the index chapters (such as File Index, Compound Index, etc.)
1182*64e33c5cSCy Schubert# in the output.
1183*64e33c5cSCy Schubert
1184*64e33c5cSCy SchubertLATEX_HIDE_INDICES     = NO
1185*64e33c5cSCy Schubert
1186*64e33c5cSCy Schubert# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1187*64e33c5cSCy Schubert# source code with syntax highlighting in the LaTeX output.
1188*64e33c5cSCy Schubert# Note that which sources are shown also depends on other settings
1189*64e33c5cSCy Schubert# such as SOURCE_BROWSER.
1190*64e33c5cSCy Schubert
1191*64e33c5cSCy SchubertLATEX_SOURCE_CODE      = NO
1192*64e33c5cSCy Schubert
1193*64e33c5cSCy Schubert#---------------------------------------------------------------------------
1194*64e33c5cSCy Schubert# configuration options related to the RTF output
1195*64e33c5cSCy Schubert#---------------------------------------------------------------------------
1196*64e33c5cSCy Schubert
1197*64e33c5cSCy Schubert# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1198*64e33c5cSCy Schubert# The RTF output is optimized for Word 97 and may not look very pretty with
1199*64e33c5cSCy Schubert# other RTF readers or editors.
1200*64e33c5cSCy Schubert
1201*64e33c5cSCy SchubertGENERATE_RTF           = NO
1202*64e33c5cSCy Schubert
1203*64e33c5cSCy Schubert# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1204*64e33c5cSCy Schubert# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1205*64e33c5cSCy Schubert# put in front of it. If left blank `rtf' will be used as the default path.
1206*64e33c5cSCy Schubert
1207*64e33c5cSCy SchubertRTF_OUTPUT             = rtf
1208*64e33c5cSCy Schubert
1209*64e33c5cSCy Schubert# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1210*64e33c5cSCy Schubert# RTF documents. This may be useful for small projects and may help to
1211*64e33c5cSCy Schubert# save some trees in general.
1212*64e33c5cSCy Schubert
1213*64e33c5cSCy SchubertCOMPACT_RTF            = NO
1214*64e33c5cSCy Schubert
1215*64e33c5cSCy Schubert# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1216*64e33c5cSCy Schubert# will contain hyperlink fields. The RTF file will
1217*64e33c5cSCy Schubert# contain links (just like the HTML output) instead of page references.
1218*64e33c5cSCy Schubert# This makes the output suitable for online browsing using WORD or other
1219*64e33c5cSCy Schubert# programs which support those fields.
1220*64e33c5cSCy Schubert# Note: wordpad (write) and others do not support links.
1221*64e33c5cSCy Schubert
1222*64e33c5cSCy SchubertRTF_HYPERLINKS         = NO
1223*64e33c5cSCy Schubert
1224*64e33c5cSCy Schubert# Load stylesheet definitions from file. Syntax is similar to doxygen's
1225*64e33c5cSCy Schubert# config file, i.e. a series of assignments. You only have to provide
1226*64e33c5cSCy Schubert# replacements, missing definitions are set to their default value.
1227*64e33c5cSCy Schubert
1228*64e33c5cSCy SchubertRTF_STYLESHEET_FILE    =
1229*64e33c5cSCy Schubert
1230*64e33c5cSCy Schubert# Set optional variables used in the generation of an rtf document.
1231*64e33c5cSCy Schubert# Syntax is similar to doxygen's config file.
1232*64e33c5cSCy Schubert
1233*64e33c5cSCy SchubertRTF_EXTENSIONS_FILE    =
1234*64e33c5cSCy Schubert
1235*64e33c5cSCy Schubert#---------------------------------------------------------------------------
1236*64e33c5cSCy Schubert# configuration options related to the man page output
1237*64e33c5cSCy Schubert#---------------------------------------------------------------------------
1238*64e33c5cSCy Schubert
1239*64e33c5cSCy Schubert# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1240*64e33c5cSCy Schubert# generate man pages
1241*64e33c5cSCy Schubert
1242*64e33c5cSCy SchubertGENERATE_MAN           = NO
1243*64e33c5cSCy Schubert
1244*64e33c5cSCy Schubert# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1245*64e33c5cSCy Schubert# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1246*64e33c5cSCy Schubert# put in front of it. If left blank `man' will be used as the default path.
1247*64e33c5cSCy Schubert
1248*64e33c5cSCy SchubertMAN_OUTPUT             = man
1249*64e33c5cSCy Schubert
1250*64e33c5cSCy Schubert# The MAN_EXTENSION tag determines the extension that is added to
1251*64e33c5cSCy Schubert# the generated man pages (default is the subroutine's section .3)
1252*64e33c5cSCy Schubert
1253*64e33c5cSCy SchubertMAN_EXTENSION          = .3
1254*64e33c5cSCy Schubert
1255*64e33c5cSCy Schubert# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1256*64e33c5cSCy Schubert# then it will generate one additional man file for each entity
1257*64e33c5cSCy Schubert# documented in the real man page(s). These additional files
1258*64e33c5cSCy Schubert# only source the real man page, but without them the man command
1259*64e33c5cSCy Schubert# would be unable to find the correct page. The default is NO.
1260*64e33c5cSCy Schubert
1261*64e33c5cSCy SchubertMAN_LINKS              = NO
1262*64e33c5cSCy Schubert
1263*64e33c5cSCy Schubert#---------------------------------------------------------------------------
1264*64e33c5cSCy Schubert# configuration options related to the XML output
1265*64e33c5cSCy Schubert#---------------------------------------------------------------------------
1266*64e33c5cSCy Schubert
1267*64e33c5cSCy Schubert# If the GENERATE_XML tag is set to YES Doxygen will
1268*64e33c5cSCy Schubert# generate an XML file that captures the structure of
1269*64e33c5cSCy Schubert# the code including all documentation.
1270*64e33c5cSCy Schubert
1271*64e33c5cSCy SchubertGENERATE_XML           = YES
1272*64e33c5cSCy Schubert
1273*64e33c5cSCy Schubert# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1274*64e33c5cSCy Schubert# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1275*64e33c5cSCy Schubert# put in front of it. If left blank `xml' will be used as the default path.
1276*64e33c5cSCy Schubert
1277*64e33c5cSCy SchubertXML_OUTPUT             = xml
1278*64e33c5cSCy Schubert
1279*64e33c5cSCy Schubert# The XML_SCHEMA tag can be used to specify an XML schema,
1280*64e33c5cSCy Schubert# which can be used by a validating XML parser to check the
1281*64e33c5cSCy Schubert# syntax of the XML files.
1282*64e33c5cSCy Schubert
1283*64e33c5cSCy Schubert#XML_SCHEMA             =
1284*64e33c5cSCy Schubert
1285*64e33c5cSCy Schubert# The XML_DTD tag can be used to specify an XML DTD,
1286*64e33c5cSCy Schubert# which can be used by a validating XML parser to check the
1287*64e33c5cSCy Schubert# syntax of the XML files.
1288*64e33c5cSCy Schubert
1289*64e33c5cSCy Schubert#XML_DTD                =
1290*64e33c5cSCy Schubert
1291*64e33c5cSCy Schubert# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1292*64e33c5cSCy Schubert# dump the program listings (including syntax highlighting
1293*64e33c5cSCy Schubert# and cross-referencing information) to the XML output. Note that
1294*64e33c5cSCy Schubert# enabling this will significantly increase the size of the XML output.
1295*64e33c5cSCy Schubert
1296*64e33c5cSCy SchubertXML_PROGRAMLISTING     = YES
1297*64e33c5cSCy Schubert
1298*64e33c5cSCy Schubert#---------------------------------------------------------------------------
1299*64e33c5cSCy Schubert# configuration options for the AutoGen Definitions output
1300*64e33c5cSCy Schubert#---------------------------------------------------------------------------
1301*64e33c5cSCy Schubert
1302*64e33c5cSCy Schubert# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1303*64e33c5cSCy Schubert# generate an AutoGen Definitions (see autogen.sf.net) file
1304*64e33c5cSCy Schubert# that captures the structure of the code including all
1305*64e33c5cSCy Schubert# documentation. Note that this feature is still experimental
1306*64e33c5cSCy Schubert# and incomplete at the moment.
1307*64e33c5cSCy Schubert
1308*64e33c5cSCy SchubertGENERATE_AUTOGEN_DEF   = NO
1309*64e33c5cSCy Schubert
1310*64e33c5cSCy Schubert#---------------------------------------------------------------------------
1311*64e33c5cSCy Schubert# configuration options related to the Perl module output
1312*64e33c5cSCy Schubert#---------------------------------------------------------------------------
1313*64e33c5cSCy Schubert
1314*64e33c5cSCy Schubert# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1315*64e33c5cSCy Schubert# generate a Perl module file that captures the structure of
1316*64e33c5cSCy Schubert# the code including all documentation. Note that this
1317*64e33c5cSCy Schubert# feature is still experimental and incomplete at the
1318*64e33c5cSCy Schubert# moment.
1319*64e33c5cSCy Schubert
1320*64e33c5cSCy SchubertGENERATE_PERLMOD       = NO
1321*64e33c5cSCy Schubert
1322*64e33c5cSCy Schubert# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1323*64e33c5cSCy Schubert# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1324*64e33c5cSCy Schubert# to generate PDF and DVI output from the Perl module output.
1325*64e33c5cSCy Schubert
1326*64e33c5cSCy SchubertPERLMOD_LATEX          = NO
1327*64e33c5cSCy Schubert
1328*64e33c5cSCy Schubert# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1329*64e33c5cSCy Schubert# nicely formatted so it can be parsed by a human reader.
1330*64e33c5cSCy Schubert# This is useful
1331*64e33c5cSCy Schubert# if you want to understand what is going on.
1332*64e33c5cSCy Schubert# On the other hand, if this
1333*64e33c5cSCy Schubert# tag is set to NO the size of the Perl module output will be much smaller
1334*64e33c5cSCy Schubert# and Perl will parse it just the same.
1335*64e33c5cSCy Schubert
1336*64e33c5cSCy SchubertPERLMOD_PRETTY         = YES
1337*64e33c5cSCy Schubert
1338*64e33c5cSCy Schubert# The names of the make variables in the generated doxyrules.make file
1339*64e33c5cSCy Schubert# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1340*64e33c5cSCy Schubert# This is useful so different doxyrules.make files included by the same
1341*64e33c5cSCy Schubert# Makefile don't overwrite each other's variables.
1342*64e33c5cSCy Schubert
1343*64e33c5cSCy SchubertPERLMOD_MAKEVAR_PREFIX =
1344*64e33c5cSCy Schubert
1345*64e33c5cSCy Schubert#---------------------------------------------------------------------------
1346*64e33c5cSCy Schubert# Configuration options related to the preprocessor
1347*64e33c5cSCy Schubert#---------------------------------------------------------------------------
1348*64e33c5cSCy Schubert
1349*64e33c5cSCy Schubert# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1350*64e33c5cSCy Schubert# evaluate all C-preprocessor directives found in the sources and include
1351*64e33c5cSCy Schubert# files.
1352*64e33c5cSCy Schubert
1353*64e33c5cSCy SchubertENABLE_PREPROCESSING   = YES
1354*64e33c5cSCy Schubert
1355*64e33c5cSCy Schubert# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1356*64e33c5cSCy Schubert# names in the source code. If set to NO (the default) only conditional
1357*64e33c5cSCy Schubert# compilation will be performed. Macro expansion can be done in a controlled
1358*64e33c5cSCy Schubert# way by setting EXPAND_ONLY_PREDEF to YES.
1359*64e33c5cSCy Schubert
1360*64e33c5cSCy SchubertMACRO_EXPANSION        = YES
1361*64e33c5cSCy Schubert
1362*64e33c5cSCy Schubert# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1363*64e33c5cSCy Schubert# then the macro expansion is limited to the macros specified with the
1364*64e33c5cSCy Schubert# PREDEFINED and EXPAND_AS_DEFINED tags.
1365*64e33c5cSCy Schubert
1366*64e33c5cSCy SchubertEXPAND_ONLY_PREDEF     = YES
1367*64e33c5cSCy Schubert
1368*64e33c5cSCy Schubert# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1369*64e33c5cSCy Schubert# in the INCLUDE_PATH (see below) will be search if a #include is found.
1370*64e33c5cSCy Schubert
1371*64e33c5cSCy SchubertSEARCH_INCLUDES        = YES
1372*64e33c5cSCy Schubert
1373*64e33c5cSCy Schubert# The INCLUDE_PATH tag can be used to specify one or more directories that
1374*64e33c5cSCy Schubert# contain include files that are not input files but should be processed by
1375*64e33c5cSCy Schubert# the preprocessor.
1376*64e33c5cSCy Schubert
1377*64e33c5cSCy SchubertINCLUDE_PATH           =
1378*64e33c5cSCy Schubert
1379*64e33c5cSCy Schubert# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1380*64e33c5cSCy Schubert# patterns (like *.h and *.hpp) to filter out the header-files in the
1381*64e33c5cSCy Schubert# directories. If left blank, the patterns specified with FILE_PATTERNS will
1382*64e33c5cSCy Schubert# be used.
1383*64e33c5cSCy Schubert
1384*64e33c5cSCy SchubertINCLUDE_FILE_PATTERNS  = *.h
1385*64e33c5cSCy Schubert
1386*64e33c5cSCy Schubert# The PREDEFINED tag can be used to specify one or more macro names that
1387*64e33c5cSCy Schubert# are defined before the preprocessor is started (similar to the -D option of
1388*64e33c5cSCy Schubert# gcc). The argument of the tag is a list of macros of the form: name
1389*64e33c5cSCy Schubert# or name=definition (no spaces). If the definition and the = are
1390*64e33c5cSCy Schubert# omitted =1 is assumed. To prevent a macro definition from being
1391*64e33c5cSCy Schubert# undefined via #undef or recursively expanded use the := operator
1392*64e33c5cSCy Schubert# instead of the = operator.
1393*64e33c5cSCy Schubert
1394*64e33c5cSCy SchubertPREDEFINED             = DOXYGEN
1395*64e33c5cSCy Schubert
1396*64e33c5cSCy Schubert# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1397*64e33c5cSCy Schubert# this tag can be used to specify a list of macro names that should be expanded.
1398*64e33c5cSCy Schubert# The macro definition that is found in the sources will be used.
1399*64e33c5cSCy Schubert# Use the PREDEFINED tag if you want to use a different macro definition.
1400*64e33c5cSCy Schubert
1401*64e33c5cSCy SchubertEXPAND_AS_DEFINED      = ATTR_UNUSED
1402*64e33c5cSCy Schubert
1403*64e33c5cSCy Schubert# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1404*64e33c5cSCy Schubert# doxygen's preprocessor will remove all function-like macros that are alone
1405*64e33c5cSCy Schubert# on a line, have an all uppercase name, and do not end with a semicolon. Such
1406*64e33c5cSCy Schubert# function macros are typically used for boiler-plate code, and will confuse
1407*64e33c5cSCy Schubert# the parser if not removed.
1408*64e33c5cSCy Schubert
1409*64e33c5cSCy SchubertSKIP_FUNCTION_MACROS   = YES
1410*64e33c5cSCy Schubert
1411*64e33c5cSCy Schubert#---------------------------------------------------------------------------
1412*64e33c5cSCy Schubert# Configuration::additions related to external references
1413*64e33c5cSCy Schubert#---------------------------------------------------------------------------
1414*64e33c5cSCy Schubert
1415*64e33c5cSCy Schubert# The TAGFILES option can be used to specify one or more tagfiles.
1416*64e33c5cSCy Schubert# Optionally an initial location of the external documentation
1417*64e33c5cSCy Schubert# can be added for each tagfile. The format of a tag file without
1418*64e33c5cSCy Schubert# this location is as follows:
1419*64e33c5cSCy Schubert#
1420*64e33c5cSCy Schubert# TAGFILES = file1 file2 ...
1421*64e33c5cSCy Schubert# Adding location for the tag files is done as follows:
1422*64e33c5cSCy Schubert#
1423*64e33c5cSCy Schubert# TAGFILES = file1=loc1 "file2 = loc2" ...
1424*64e33c5cSCy Schubert# where "loc1" and "loc2" can be relative or absolute paths or
1425*64e33c5cSCy Schubert# URLs. If a location is present for each tag, the installdox tool
1426*64e33c5cSCy Schubert# does not have to be run to correct the links.
1427*64e33c5cSCy Schubert# Note that each tag file must have a unique name
1428*64e33c5cSCy Schubert# (where the name does NOT include the path)
1429*64e33c5cSCy Schubert# If a tag file is not located in the directory in which doxygen
1430*64e33c5cSCy Schubert# is run, you must also specify the path to the tagfile here.
1431*64e33c5cSCy Schubert
1432*64e33c5cSCy SchubertTAGFILES               =
1433*64e33c5cSCy Schubert
1434*64e33c5cSCy Schubert# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1435*64e33c5cSCy Schubert# a tag file that is based on the input files it reads.
1436*64e33c5cSCy Schubert
1437*64e33c5cSCy SchubertGENERATE_TAGFILE       =
1438*64e33c5cSCy Schubert
1439*64e33c5cSCy Schubert# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1440*64e33c5cSCy Schubert# in the class index. If set to NO only the inherited external classes
1441*64e33c5cSCy Schubert# will be listed.
1442*64e33c5cSCy Schubert
1443*64e33c5cSCy SchubertALLEXTERNALS           = NO
1444*64e33c5cSCy Schubert
1445*64e33c5cSCy Schubert# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1446*64e33c5cSCy Schubert# in the modules index. If set to NO, only the current project's groups will
1447*64e33c5cSCy Schubert# be listed.
1448*64e33c5cSCy Schubert
1449*64e33c5cSCy SchubertEXTERNAL_GROUPS        = YES
1450*64e33c5cSCy Schubert
1451*64e33c5cSCy Schubert# The PERL_PATH should be the absolute path and name of the perl script
1452*64e33c5cSCy Schubert# interpreter (i.e. the result of `which perl').
1453*64e33c5cSCy Schubert
1454*64e33c5cSCy Schubert#PERL_PATH              = /usr/bin/perl
1455*64e33c5cSCy Schubert
1456*64e33c5cSCy Schubert#---------------------------------------------------------------------------
1457*64e33c5cSCy Schubert# Configuration options related to the dot tool
1458*64e33c5cSCy Schubert#---------------------------------------------------------------------------
1459*64e33c5cSCy Schubert
1460*64e33c5cSCy Schubert# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1461*64e33c5cSCy Schubert# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1462*64e33c5cSCy Schubert# or super classes. Setting the tag to NO turns the diagrams off. Note that
1463*64e33c5cSCy Schubert# this option is superseded by the HAVE_DOT option below. This is only a
1464*64e33c5cSCy Schubert# fallback. It is recommended to install and use dot, since it yields more
1465*64e33c5cSCy Schubert# powerful graphs.
1466*64e33c5cSCy Schubert
1467*64e33c5cSCy SchubertCLASS_DIAGRAMS         = YES
1468*64e33c5cSCy Schubert
1469*64e33c5cSCy Schubert# You can define message sequence charts within doxygen comments using the \msc
1470*64e33c5cSCy Schubert# command. Doxygen will then run the mscgen tool (see
1471*64e33c5cSCy Schubert# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1472*64e33c5cSCy Schubert# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1473*64e33c5cSCy Schubert# the mscgen tool resides. If left empty the tool is assumed to be found in the
1474*64e33c5cSCy Schubert# default search path.
1475*64e33c5cSCy Schubert
1476*64e33c5cSCy Schubert#MSCGEN_PATH            =
1477*64e33c5cSCy Schubert
1478*64e33c5cSCy Schubert# If set to YES, the inheritance and collaboration graphs will hide
1479*64e33c5cSCy Schubert# inheritance and usage relations if the target is undocumented
1480*64e33c5cSCy Schubert# or is not a class.
1481*64e33c5cSCy Schubert
1482*64e33c5cSCy SchubertHIDE_UNDOC_RELATIONS   = YES
1483*64e33c5cSCy Schubert
1484*64e33c5cSCy Schubert# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1485*64e33c5cSCy Schubert# available from the path. This tool is part of Graphviz, a graph visualization
1486*64e33c5cSCy Schubert# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1487*64e33c5cSCy Schubert# have no effect if this option is set to NO (the default)
1488*64e33c5cSCy Schubert
1489*64e33c5cSCy SchubertHAVE_DOT               = NO
1490*64e33c5cSCy Schubert
1491*64e33c5cSCy Schubert# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1492*64e33c5cSCy Schubert# allowed to run in parallel. When set to 0 (the default) doxygen will
1493*64e33c5cSCy Schubert# base this on the number of processors available in the system. You can set it
1494*64e33c5cSCy Schubert# explicitly to a value larger than 0 to get control over the balance
1495*64e33c5cSCy Schubert# between CPU load and processing speed.
1496*64e33c5cSCy Schubert
1497*64e33c5cSCy Schubert#DOT_NUM_THREADS        = 0
1498*64e33c5cSCy Schubert
1499*64e33c5cSCy Schubert# By default doxygen will write a font called FreeSans.ttf to the output
1500*64e33c5cSCy Schubert# directory and reference it in all dot files that doxygen generates. This
1501*64e33c5cSCy Schubert# font does not include all possible unicode characters however, so when you need
1502*64e33c5cSCy Schubert# these (or just want a differently looking font) you can specify the font name
1503*64e33c5cSCy Schubert# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1504*64e33c5cSCy Schubert# which can be done by putting it in a standard location or by setting the
1505*64e33c5cSCy Schubert# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1506*64e33c5cSCy Schubert# containing the font.
1507*64e33c5cSCy Schubert
1508*64e33c5cSCy Schubert#DOT_FONTNAME           = FreeSans.ttf
1509*64e33c5cSCy Schubert
1510*64e33c5cSCy Schubert# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1511*64e33c5cSCy Schubert# The default size is 10pt.
1512*64e33c5cSCy Schubert
1513*64e33c5cSCy SchubertDOT_FONTSIZE           = 10
1514*64e33c5cSCy Schubert
1515*64e33c5cSCy Schubert# By default doxygen will tell dot to use the output directory to look for the
1516*64e33c5cSCy Schubert# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1517*64e33c5cSCy Schubert# different font using DOT_FONTNAME you can set the path where dot
1518*64e33c5cSCy Schubert# can find it using this tag.
1519*64e33c5cSCy Schubert
1520*64e33c5cSCy SchubertDOT_FONTPATH           =
1521*64e33c5cSCy Schubert
1522*64e33c5cSCy Schubert# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1523*64e33c5cSCy Schubert# will generate a graph for each documented class showing the direct and
1524*64e33c5cSCy Schubert# indirect inheritance relations. Setting this tag to YES will force the
1525*64e33c5cSCy Schubert# the CLASS_DIAGRAMS tag to NO.
1526*64e33c5cSCy Schubert
1527*64e33c5cSCy SchubertCLASS_GRAPH            = YES
1528*64e33c5cSCy Schubert
1529*64e33c5cSCy Schubert# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1530*64e33c5cSCy Schubert# will generate a graph for each documented class showing the direct and
1531*64e33c5cSCy Schubert# indirect implementation dependencies (inheritance, containment, and
1532*64e33c5cSCy Schubert# class references variables) of the class with other documented classes.
1533*64e33c5cSCy Schubert
1534*64e33c5cSCy SchubertCOLLABORATION_GRAPH    = YES
1535*64e33c5cSCy Schubert
1536*64e33c5cSCy Schubert# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1537*64e33c5cSCy Schubert# will generate a graph for groups, showing the direct groups dependencies
1538*64e33c5cSCy Schubert
1539*64e33c5cSCy SchubertGROUP_GRAPHS           = YES
1540*64e33c5cSCy Schubert
1541*64e33c5cSCy Schubert# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1542*64e33c5cSCy Schubert# collaboration diagrams in a style similar to the OMG's Unified Modeling
1543*64e33c5cSCy Schubert# Language.
1544*64e33c5cSCy Schubert
1545*64e33c5cSCy SchubertUML_LOOK               = NO
1546*64e33c5cSCy Schubert
1547*64e33c5cSCy Schubert# If set to YES, the inheritance and collaboration graphs will show the
1548*64e33c5cSCy Schubert# relations between templates and their instances.
1549*64e33c5cSCy Schubert
1550*64e33c5cSCy SchubertTEMPLATE_RELATIONS     = NO
1551*64e33c5cSCy Schubert
1552*64e33c5cSCy Schubert# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1553*64e33c5cSCy Schubert# tags are set to YES then doxygen will generate a graph for each documented
1554*64e33c5cSCy Schubert# file showing the direct and indirect include dependencies of the file with
1555*64e33c5cSCy Schubert# other documented files.
1556*64e33c5cSCy Schubert
1557*64e33c5cSCy SchubertINCLUDE_GRAPH          = YES
1558*64e33c5cSCy Schubert
1559*64e33c5cSCy Schubert# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1560*64e33c5cSCy Schubert# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1561*64e33c5cSCy Schubert# documented header file showing the documented files that directly or
1562*64e33c5cSCy Schubert# indirectly include this file.
1563*64e33c5cSCy Schubert
1564*64e33c5cSCy SchubertINCLUDED_BY_GRAPH      = YES
1565*64e33c5cSCy Schubert
1566*64e33c5cSCy Schubert# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1567*64e33c5cSCy Schubert# doxygen will generate a call dependency graph for every global function
1568*64e33c5cSCy Schubert# or class method. Note that enabling this option will significantly increase
1569*64e33c5cSCy Schubert# the time of a run. So in most cases it will be better to enable call graphs
1570*64e33c5cSCy Schubert# for selected functions only using the \callgraph command.
1571*64e33c5cSCy Schubert
1572*64e33c5cSCy SchubertCALL_GRAPH             = NO
1573*64e33c5cSCy Schubert
1574*64e33c5cSCy Schubert# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1575*64e33c5cSCy Schubert# doxygen will generate a caller dependency graph for every global function
1576*64e33c5cSCy Schubert# or class method. Note that enabling this option will significantly increase
1577*64e33c5cSCy Schubert# the time of a run. So in most cases it will be better to enable caller
1578*64e33c5cSCy Schubert# graphs for selected functions only using the \callergraph command.
1579*64e33c5cSCy Schubert
1580*64e33c5cSCy SchubertCALLER_GRAPH           = NO
1581*64e33c5cSCy Schubert
1582*64e33c5cSCy Schubert# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1583*64e33c5cSCy Schubert# will graphical hierarchy of all classes instead of a textual one.
1584*64e33c5cSCy Schubert
1585*64e33c5cSCy SchubertGRAPHICAL_HIERARCHY    = YES
1586*64e33c5cSCy Schubert
1587*64e33c5cSCy Schubert# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1588*64e33c5cSCy Schubert# then doxygen will show the dependencies a directory has on other directories
1589*64e33c5cSCy Schubert# in a graphical way. The dependency relations are determined by the #include
1590*64e33c5cSCy Schubert# relations between the files in the directories.
1591*64e33c5cSCy Schubert
1592*64e33c5cSCy SchubertDIRECTORY_GRAPH        = YES
1593*64e33c5cSCy Schubert
1594*64e33c5cSCy Schubert# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1595*64e33c5cSCy Schubert# generated by dot. Possible values are png, jpg, or gif
1596*64e33c5cSCy Schubert# If left blank png will be used.
1597*64e33c5cSCy Schubert
1598*64e33c5cSCy SchubertDOT_IMAGE_FORMAT       = png
1599*64e33c5cSCy Schubert
1600*64e33c5cSCy Schubert# The tag DOT_PATH can be used to specify the path where the dot tool can be
1601*64e33c5cSCy Schubert# found. If left blank, it is assumed the dot tool can be found in the path.
1602*64e33c5cSCy Schubert
1603*64e33c5cSCy SchubertDOT_PATH               =
1604*64e33c5cSCy Schubert
1605*64e33c5cSCy Schubert# The DOTFILE_DIRS tag can be used to specify one or more directories that
1606*64e33c5cSCy Schubert# contain dot files that are included in the documentation (see the
1607*64e33c5cSCy Schubert# \dotfile command).
1608*64e33c5cSCy Schubert
1609*64e33c5cSCy SchubertDOTFILE_DIRS           =
1610*64e33c5cSCy Schubert
1611*64e33c5cSCy Schubert# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1612*64e33c5cSCy Schubert# nodes that will be shown in the graph. If the number of nodes in a graph
1613*64e33c5cSCy Schubert# becomes larger than this value, doxygen will truncate the graph, which is
1614*64e33c5cSCy Schubert# visualized by representing a node as a red box. Note that doxygen if the
1615*64e33c5cSCy Schubert# number of direct children of the root node in a graph is already larger than
1616*64e33c5cSCy Schubert# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1617*64e33c5cSCy Schubert# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1618*64e33c5cSCy Schubert
1619*64e33c5cSCy SchubertDOT_GRAPH_MAX_NODES    = 50
1620*64e33c5cSCy Schubert
1621*64e33c5cSCy Schubert# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1622*64e33c5cSCy Schubert# graphs generated by dot. A depth value of 3 means that only nodes reachable
1623*64e33c5cSCy Schubert# from the root by following a path via at most 3 edges will be shown. Nodes
1624*64e33c5cSCy Schubert# that lay further from the root node will be omitted. Note that setting this
1625*64e33c5cSCy Schubert# option to 1 or 2 may greatly reduce the computation time needed for large
1626*64e33c5cSCy Schubert# code bases. Also note that the size of a graph can be further restricted by
1627*64e33c5cSCy Schubert# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1628*64e33c5cSCy Schubert
1629*64e33c5cSCy SchubertMAX_DOT_GRAPH_DEPTH    = 0
1630*64e33c5cSCy Schubert
1631*64e33c5cSCy Schubert# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1632*64e33c5cSCy Schubert# background. This is disabled by default, because dot on Windows does not
1633*64e33c5cSCy Schubert# seem to support this out of the box. Warning: Depending on the platform used,
1634*64e33c5cSCy Schubert# enabling this option may lead to badly anti-aliased labels on the edges of
1635*64e33c5cSCy Schubert# a graph (i.e. they become hard to read).
1636*64e33c5cSCy Schubert
1637*64e33c5cSCy SchubertDOT_TRANSPARENT        = NO
1638*64e33c5cSCy Schubert
1639*64e33c5cSCy Schubert# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1640*64e33c5cSCy Schubert# files in one run (i.e. multiple -o and -T options on the command line). This
1641*64e33c5cSCy Schubert# makes dot run faster, but since only newer versions of dot (>1.8.10)
1642*64e33c5cSCy Schubert# support this, this feature is disabled by default.
1643*64e33c5cSCy Schubert
1644*64e33c5cSCy SchubertDOT_MULTI_TARGETS      = NO
1645*64e33c5cSCy Schubert
1646*64e33c5cSCy Schubert# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1647*64e33c5cSCy Schubert# generate a legend page explaining the meaning of the various boxes and
1648*64e33c5cSCy Schubert# arrows in the dot generated graphs.
1649*64e33c5cSCy Schubert
1650*64e33c5cSCy SchubertGENERATE_LEGEND        = YES
1651*64e33c5cSCy Schubert
1652*64e33c5cSCy Schubert# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1653*64e33c5cSCy Schubert# remove the intermediate dot files that are used to generate
1654*64e33c5cSCy Schubert# the various graphs.
1655*64e33c5cSCy Schubert
1656*64e33c5cSCy SchubertDOT_CLEANUP            = YES
1657