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