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