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