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