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