blob: f8fa0c333c401dbd970fa12465b2b0e4931ab552 [file] [log] [blame]
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001# Doxyfile 1.8.11
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07002
3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project.
5#
6# All text after a double hash (##) is considered a comment and is placed in
7# front of the TAG it is preceding.
8#
9# All text after a single hash (#) is considered a comment and will be ignored.
10# The format is:
11# TAG = value [value, ...]
12# For lists, items can also be appended using:
13# TAG += value [value, ...]
14# Values that contain spaces should be placed between quotes (\" \").
15
16#---------------------------------------------------------------------------
17# Project related configuration options
18#---------------------------------------------------------------------------
19
20# This tag specifies the encoding used for all characters in the config file
21# that follow. The default is UTF-8 which is also the encoding used for all text
22# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24# for the list of possible encodings.
25# The default value is: UTF-8.
26
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
35PROJECT_NAME = "NDNS: Domain Name Service for Named Data Networking"
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
41PROJECT_NUMBER = @VERSION@
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
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -080049# 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.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -070053
54PROJECT_LOGO =
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
61OUTPUT_DIRECTORY = docs/doxygen
62
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -080063# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -070064# 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
Davide Pesaventodadbc3e2023-02-14 02:32:36 -050071CREATE_SUBDIRS = NO
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -070072
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -080073# 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
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -070081# 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.
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -080084# 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.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -070092# The default value is: English.
93
94OUTPUT_LANGUAGE = English
95
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -080096# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -070097# descriptions after the members that are listed in the file and class
98# documentation (similar to Javadoc). Set to NO to disable this.
99# The default value is: YES.
100
101BRIEF_MEMBER_DESC = YES
102
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800103# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700104# description of a member or function before the detailed description
105#
106# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
107# brief descriptions will be completely suppressed.
108# The default value is: YES.
109
110REPEAT_BRIEF = YES
111
112# This tag implements a quasi-intelligent brief description abbreviator that is
113# used to form the text in various listings. Each string in this list, if found
114# as the leading text of the brief description, will be stripped from the text
115# and the result, after processing the whole list, is used as the annotated
116# text. Otherwise, the brief description is used as-is. If left blank, the
117# following values are used ($name is automatically replaced with the name of
118# the entity):The $name class, The $name widget, The $name file, is, provides,
119# specifies, contains, represents, a, an and the.
120
121ABBREVIATE_BRIEF =
122
123# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
124# doxygen will generate a detailed section even if there is only a brief
125# description.
126# The default value is: NO.
127
128ALWAYS_DETAILED_SEC = NO
129
130# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
131# inherited members of a class in the documentation of that class as if those
132# members were ordinary class members. Constructors, destructors and assignment
133# operators of the base classes will not be shown.
134# The default value is: NO.
135
136INLINE_INHERITED_MEMB = YES
137
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800138# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700139# before files name in the file list and in the header files. If set to NO the
140# shortest path that makes the file name unique will be used
141# The default value is: YES.
142
143FULL_PATH_NAMES = NO
144
145# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
146# Stripping is only done if one of the specified strings matches the left-hand
147# part of the path. The tag can be used to show relative paths in the file list.
148# If left blank the directory from which doxygen is run is used as the path to
149# strip.
150#
151# Note that you can specify absolute paths here, but also relative paths, which
152# will be relative from the directory where doxygen is started.
153# This tag requires that the tag FULL_PATH_NAMES is set to YES.
154
155STRIP_FROM_PATH =
156
157# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
158# path mentioned in the documentation of a class, which tells the reader which
159# header file to include in order to use a class. If left blank only the name of
160# the header file containing the class definition is used. Otherwise one should
161# specify the list of include paths that are normally passed to the compiler
162# using the -I flag.
163
164STRIP_FROM_INC_PATH =
165
166# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
167# less readable) file names. This can be useful is your file systems doesn't
168# support long names like on DOS, Mac, or CD-ROM.
169# The default value is: NO.
170
171SHORT_NAMES = NO
172
173# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
174# first line (until the first dot) of a Javadoc-style comment as the brief
175# description. If set to NO, the Javadoc-style will behave just like regular Qt-
176# style comments (thus requiring an explicit @brief command for a brief
177# description.)
178# The default value is: NO.
179
180JAVADOC_AUTOBRIEF = NO
181
182# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
183# line (until the first dot) of a Qt-style comment as the brief description. If
184# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
185# requiring an explicit \brief command for a brief description.)
186# The default value is: NO.
187
188QT_AUTOBRIEF = NO
189
190# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
191# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
192# a brief description. This used to be the default behavior. The new default is
193# to treat a multi-line C++ comment block as a detailed description. Set this
194# tag to YES if you prefer the old behavior instead.
195#
196# Note that setting this tag to YES also means that rational rose comments are
197# not recognized any more.
198# The default value is: NO.
199
200MULTILINE_CPP_IS_BRIEF = NO
201
202# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
203# documentation from any documented member that it re-implements.
204# The default value is: YES.
205
206INHERIT_DOCS = YES
207
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800208# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
209# page for each member. If set to NO, the documentation of a member will be part
210# of the file/class/namespace that contains it.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700211# The default value is: NO.
212
213SEPARATE_MEMBER_PAGES = NO
214
215# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
216# uses this value to replace tabs by spaces in code fragments.
217# Minimum value: 1, maximum value: 16, default value: 4.
218
219TAB_SIZE = 4
220
221# This tag can be used to specify a number of aliases that act as commands in
222# the documentation. An alias has the form:
223# name=value
224# For example adding
225# "sideeffect=@par Side Effects:\n"
226# will allow you to put the command \sideeffect (or @sideeffect) in the
227# documentation, which will result in a user-defined paragraph with heading
228# "Side Effects:". You can put \n's in the value part of an alias to insert
229# newlines.
230
231ALIASES =
232
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700233# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
234# only. Doxygen will then generate output that is more tailored for C. For
235# instance, some of the names that are used will be different. The list of all
236# members will be omitted, etc.
237# The default value is: NO.
238
239OPTIMIZE_OUTPUT_FOR_C = NO
240
241# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
242# Python sources only. Doxygen will then generate output that is more tailored
243# for that language. For instance, namespaces will be presented as packages,
244# qualified scopes will look different, etc.
245# The default value is: NO.
246
247OPTIMIZE_OUTPUT_JAVA = NO
248
249# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
250# sources. Doxygen will then generate output that is tailored for Fortran.
251# The default value is: NO.
252
253OPTIMIZE_FOR_FORTRAN = NO
254
255# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
256# sources. Doxygen will then generate output that is tailored for VHDL.
257# The default value is: NO.
258
259OPTIMIZE_OUTPUT_VHDL = NO
260
261# Doxygen selects the parser to use depending on the extension of the files it
262# parses. With this tag you can assign which parser to use for a given
263# extension. Doxygen has a built-in mapping, but you can override or extend it
264# using this tag. The format is ext=language, where ext is a file extension, and
265# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800266# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
267# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
268# Fortran. In the later case the parser tries to guess whether the code is fixed
269# or free formatted code, this is the default for Fortran type files), VHDL. For
270# instance to make doxygen treat .inc files as Fortran files (default is PHP),
271# and .f files as C (default is Fortran), use: inc=Fortran f=C.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700272#
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800273# Note: For files without extension you can use no_extension as a placeholder.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700274#
275# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
276# the files are not read by doxygen.
277
278EXTENSION_MAPPING =
279
280# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
281# according to the Markdown format, which allows for more readable
282# documentation. See http://daringfireball.net/projects/markdown/ for details.
283# The output of markdown processing is further processed by doxygen, so you can
284# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
285# case of backward compatibilities issues.
286# The default value is: YES.
287
288MARKDOWN_SUPPORT = YES
289
290# When enabled doxygen tries to link words that correspond to documented
291# classes, or namespaces to their corresponding documentation. Such a link can
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800292# be prevented in individual cases by putting a % sign in front of the word or
293# globally by setting AUTOLINK_SUPPORT to NO.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700294# The default value is: YES.
295
296AUTOLINK_SUPPORT = YES
297
298# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
299# to include (a tag file for) the STL sources as input, then you should set this
300# tag to YES in order to let doxygen match functions declarations and
301# definitions whose arguments contain STL classes (e.g. func(std::string);
302# versus func(std::string) {}). This also make the inheritance and collaboration
303# diagrams that involve STL classes more complete and accurate.
304# The default value is: NO.
305
306BUILTIN_STL_SUPPORT = YES
307
308# If you use Microsoft's C++/CLI language, you should set this option to YES to
309# enable parsing support.
310# The default value is: NO.
311
312CPP_CLI_SUPPORT = NO
313
314# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
315# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
316# will parse them like normal C++ but will assume all classes use public instead
317# of private inheritance when no explicit protection keyword is present.
318# The default value is: NO.
319
320SIP_SUPPORT = NO
321
322# For Microsoft's IDL there are propget and propput attributes to indicate
323# getter and setter methods for a property. Setting this option to YES will make
324# doxygen to replace the get and set methods by a property in the documentation.
325# This will only work if the methods are indeed getting or setting a simple
326# type. If this is not the case, or you want to show the methods anyway, you
327# should set this option to NO.
328# The default value is: YES.
329
330IDL_PROPERTY_SUPPORT = YES
331
332# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800333# tag is set to YES then doxygen will reuse the documentation of the first
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700334# member in the group (if any) for the other members of the group. By default
335# all members of a group must be documented explicitly.
336# The default value is: NO.
337
338DISTRIBUTE_GROUP_DOC = NO
339
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800340# If one adds a struct or class to a group and this option is enabled, then also
341# any nested class or struct is added to the same group. By default this option
342# is disabled and one has to add nested compounds explicitly via \ingroup.
343# The default value is: NO.
344
345GROUP_NESTED_COMPOUNDS = NO
346
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700347# Set the SUBGROUPING tag to YES to allow class member groups of the same type
348# (for instance a group of public functions) to be put as a subgroup of that
349# type (e.g. under the Public Functions section). Set it to NO to prevent
350# subgrouping. Alternatively, this can be done per class using the
351# \nosubgrouping command.
352# The default value is: YES.
353
354SUBGROUPING = YES
355
356# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
357# are shown inside the group in which they are included (e.g. using \ingroup)
358# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
359# and RTF).
360#
361# Note that this feature does not work in combination with
362# SEPARATE_MEMBER_PAGES.
363# The default value is: NO.
364
365INLINE_GROUPED_CLASSES = NO
366
367# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
368# with only public data fields or simple typedef fields will be shown inline in
369# the documentation of the scope in which they are defined (i.e. file,
370# namespace, or group documentation), provided this scope is documented. If set
371# to NO, structs, classes, and unions are shown on a separate page (for HTML and
372# Man pages) or section (for LaTeX and RTF).
373# The default value is: NO.
374
375INLINE_SIMPLE_STRUCTS = NO
376
377# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
378# enum is documented as struct, union, or enum with the name of the typedef. So
379# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
380# with name TypeT. When disabled the typedef will appear as a member of a file,
381# namespace, or class. And the struct will be named TypeS. This can typically be
382# useful for C code in case the coding convention dictates that all compound
383# types are typedef'ed and only the typedef is referenced, never the tag name.
384# The default value is: NO.
385
386TYPEDEF_HIDES_STRUCT = NO
387
388# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
389# cache is used to resolve symbols given their name and scope. Since this can be
390# an expensive process and often the same symbol appears multiple times in the
391# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
392# doxygen will become slower. If the cache is too large, memory is wasted. The
393# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
394# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
395# symbols. At the end of a run doxygen will report the cache usage and suggest
396# the optimal cache size from a speed point of view.
397# Minimum value: 0, maximum value: 9, default value: 0.
398
399LOOKUP_CACHE_SIZE = 0
400
401#---------------------------------------------------------------------------
402# Build related configuration options
403#---------------------------------------------------------------------------
404
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800405# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700406# documentation are documented, even if no documentation was available. Private
407# class members and static file members will be hidden unless the
408# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
409# Note: This will also disable the warnings about undocumented members that are
410# normally produced when WARNINGS is set to YES.
411# The default value is: NO.
412
413EXTRACT_ALL = YES
414
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800415# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700416# be included in the documentation.
417# The default value is: NO.
418
419EXTRACT_PRIVATE = NO
420
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800421# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700422# scope will be included in the documentation.
423# The default value is: NO.
424
425EXTRACT_PACKAGE = NO
426
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800427# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700428# included in the documentation.
429# The default value is: NO.
430
431EXTRACT_STATIC = YES
432
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800433# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
434# locally in source files will be included in the documentation. If set to NO,
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700435# only classes defined in header files are included. Does not have any effect
436# for Java sources.
437# The default value is: YES.
438
439EXTRACT_LOCAL_CLASSES = YES
440
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800441# This flag is only useful for Objective-C code. If set to YES, local methods,
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700442# which are defined in the implementation section but not in the interface are
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800443# included in the documentation. If set to NO, only methods in the interface are
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700444# included.
445# The default value is: NO.
446
447EXTRACT_LOCAL_METHODS = NO
448
449# If this flag is set to YES, the members of anonymous namespaces will be
450# extracted and appear in the documentation as a namespace called
451# 'anonymous_namespace{file}', where file will be replaced with the base name of
452# the file that contains the anonymous namespace. By default anonymous namespace
453# are hidden.
454# The default value is: NO.
455
456EXTRACT_ANON_NSPACES = NO
457
458# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
459# undocumented members inside documented classes or files. If set to NO these
460# members will be included in the various overviews, but no documentation
461# section is generated. This option has no effect if EXTRACT_ALL is enabled.
462# The default value is: NO.
463
464HIDE_UNDOC_MEMBERS = NO
465
466# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
467# undocumented classes that are normally visible in the class hierarchy. If set
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800468# to NO, these classes will be included in the various overviews. This option
469# has no effect if EXTRACT_ALL is enabled.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700470# The default value is: NO.
471
472HIDE_UNDOC_CLASSES = NO
473
474# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800475# (class|struct|union) declarations. If set to NO, these declarations will be
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700476# included in the documentation.
477# The default value is: NO.
478
479HIDE_FRIEND_COMPOUNDS = NO
480
481# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800482# documentation blocks found inside the body of a function. If set to NO, these
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700483# blocks will be appended to the function's detailed documentation block.
484# The default value is: NO.
485
486HIDE_IN_BODY_DOCS = NO
487
488# The INTERNAL_DOCS tag determines if documentation that is typed after a
489# \internal command is included. If the tag is set to NO then the documentation
490# will be excluded. Set it to YES to include the internal documentation.
491# The default value is: NO.
492
493INTERNAL_DOCS = NO
494
495# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800496# names in lower-case letters. If set to YES, upper-case letters are also
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700497# allowed. This is useful if you have classes or files whose names only differ
498# in case and if your file system supports case sensitive file names. Windows
499# and Mac users are advised to set this option to NO.
500# The default value is: system dependent.
501
502CASE_SENSE_NAMES = YES
503
504# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800505# their full class and namespace scopes in the documentation. If set to YES, the
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700506# scope will be hidden.
507# The default value is: NO.
508
509HIDE_SCOPE_NAMES = NO
510
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800511# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
512# append additional text to a page's title, such as Class Reference. If set to
513# YES the compound reference will be hidden.
514# The default value is: NO.
515
516HIDE_COMPOUND_REFERENCE= NO
517
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700518# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
519# the files that are included by a file in the documentation of that file.
520# The default value is: YES.
521
522SHOW_INCLUDE_FILES = YES
523
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800524# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
525# grouped member an include statement to the documentation, telling the reader
526# which file to include in order to use the member.
527# The default value is: NO.
528
529SHOW_GROUPED_MEMB_INC = NO
530
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700531# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
532# files with double quotes in the documentation rather than with sharp brackets.
533# The default value is: NO.
534
535FORCE_LOCAL_INCLUDES = NO
536
537# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
538# documentation for inline members.
539# The default value is: YES.
540
541INLINE_INFO = YES
542
543# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
544# (detailed) documentation of file and class members alphabetically by member
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800545# name. If set to NO, the members will appear in declaration order.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700546# The default value is: YES.
547
548SORT_MEMBER_DOCS = YES
549
550# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
551# descriptions of file, namespace and class members alphabetically by member
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800552# name. If set to NO, the members will appear in declaration order. Note that
553# this will also influence the order of the classes in the class list.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700554# The default value is: NO.
555
556SORT_BRIEF_DOCS = NO
557
558# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
559# (brief and detailed) documentation of class members so that constructors and
560# destructors are listed first. If set to NO the constructors will appear in the
561# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
562# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
563# member documentation.
564# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
565# detailed member documentation.
566# The default value is: NO.
567
Davide Pesavento3d01fa32021-10-03 17:13:38 -0400568SORT_MEMBERS_CTORS_1ST = YES
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700569
570# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
571# of group names into alphabetical order. If set to NO the group names will
572# appear in their defined order.
573# The default value is: NO.
574
575SORT_GROUP_NAMES = YES
576
577# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
578# fully-qualified names, including namespaces. If set to NO, the class list will
579# be sorted only by class name, not including the namespace part.
580# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
581# Note: This option applies only to the class list, not to the alphabetical
582# list.
583# The default value is: NO.
584
585SORT_BY_SCOPE_NAME = NO
586
587# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
588# type resolution of all parameters of a function it will reject a match between
589# the prototype and the implementation of a member function even if there is
590# only one candidate or it is obvious which candidate to choose by doing a
591# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
592# accept a match between prototype and implementation in such cases.
593# The default value is: NO.
594
595STRICT_PROTO_MATCHING = NO
596
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800597# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
598# list. This list is created by putting \todo commands in the documentation.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700599# The default value is: YES.
600
601GENERATE_TODOLIST = YES
602
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800603# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
604# list. This list is created by putting \test commands in the documentation.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700605# The default value is: YES.
606
607GENERATE_TESTLIST = YES
608
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800609# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700610# list. This list is created by putting \bug commands in the documentation.
611# The default value is: YES.
612
613GENERATE_BUGLIST = YES
614
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800615# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700616# the deprecated list. This list is created by putting \deprecated commands in
617# the documentation.
618# The default value is: YES.
619
Davide Pesaventofee7ee32020-04-15 02:45:07 -0400620GENERATE_DEPRECATEDLIST= YES
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700621
622# The ENABLED_SECTIONS tag can be used to enable conditional documentation
623# sections, marked by \if <section_label> ... \endif and \cond <section_label>
624# ... \endcond blocks.
625
626ENABLED_SECTIONS =
627
628# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
629# initial value of a variable or macro / define can have for it to appear in the
630# documentation. If the initializer consists of more lines than specified here
631# it will be hidden. Use a value of 0 to hide initializers completely. The
632# appearance of the value of individual variables and macros / defines can be
633# controlled using \showinitializer or \hideinitializer command in the
634# documentation regardless of this setting.
635# Minimum value: 0, maximum value: 10000, default value: 30.
636
637MAX_INITIALIZER_LINES = 30
638
639# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800640# the bottom of the documentation of classes and structs. If set to YES, the
641# list will mention the files that were used to generate the documentation.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700642# The default value is: YES.
643
644SHOW_USED_FILES = NO
645
646# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
647# will remove the Files entry from the Quick Index and from the Folder Tree View
648# (if specified).
649# The default value is: YES.
650
651SHOW_FILES = YES
652
653# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
654# page. This will remove the Namespaces entry from the Quick Index and from the
655# Folder Tree View (if specified).
656# The default value is: YES.
657
658SHOW_NAMESPACES = YES
659
660# The FILE_VERSION_FILTER tag can be used to specify a program or script that
661# doxygen should invoke to get the current version for each file (typically from
662# the version control system). Doxygen will invoke the program by executing (via
663# popen()) the command command input-file, where command is the value of the
664# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
665# by doxygen. Whatever the program writes to standard output is used as the file
666# version. For an example see the documentation.
667
668FILE_VERSION_FILTER =
669
670# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
671# by doxygen. The layout file controls the global structure of the generated
672# output files in an output format independent way. To create the layout file
673# that represents doxygen's defaults, run doxygen with the -l option. You can
674# optionally specify a file name after the option, if omitted DoxygenLayout.xml
675# will be used as the name of the layout file.
676#
677# Note that if you run doxygen from a directory containing a file called
678# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
679# tag is left empty.
680
681LAYOUT_FILE =
682
683# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
684# the reference definitions. This must be a list of .bib files. The .bib
685# extension is automatically appended if omitted. This requires the bibtex tool
686# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
687# For LaTeX the style of the bibliography can be controlled using
688# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800689# search path. See also \cite for info how to create references.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700690
691CITE_BIB_FILES =
692
693#---------------------------------------------------------------------------
694# Configuration options related to warning and progress messages
695#---------------------------------------------------------------------------
696
697# The QUIET tag can be used to turn on/off the messages that are generated to
698# standard output by doxygen. If QUIET is set to YES this implies that the
699# messages are off.
700# The default value is: NO.
701
702QUIET = YES
703
704# The WARNINGS tag can be used to turn on/off the warning messages that are
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800705# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700706# this implies that the warnings are on.
707#
708# Tip: Turn warnings on while writing the documentation.
709# The default value is: YES.
710
711WARNINGS = YES
712
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800713# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700714# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
715# will automatically be disabled.
716# The default value is: YES.
717
718WARN_IF_UNDOCUMENTED = YES
719
720# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
721# potential errors in the documentation, such as not documenting some parameters
722# in a documented function, or documenting parameters that don't exist or using
723# markup commands wrongly.
724# The default value is: YES.
725
726WARN_IF_DOC_ERROR = YES
727
728# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
729# are documented, but have no documentation for their parameters or return
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800730# value. If set to NO, doxygen will only warn about wrong or incomplete
731# parameter documentation, but not about the absence of documentation.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700732# The default value is: NO.
733
734WARN_NO_PARAMDOC = YES
735
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800736# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
737# a warning is encountered.
738# The default value is: NO.
739
740WARN_AS_ERROR = NO
741
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700742# The WARN_FORMAT tag determines the format of the warning messages that doxygen
743# can produce. The string should contain the $file, $line, and $text tags, which
744# will be replaced by the file and line number from which the warning originated
745# and the warning text. Optionally the format may contain $version, which will
746# be replaced by the version of the file (if it could be obtained via
747# FILE_VERSION_FILTER)
748# The default value is: $file:$line: $text.
749
750WARN_FORMAT = "$file:$line: $text"
751
752# The WARN_LOGFILE tag can be used to specify a file to which warning and error
753# messages should be written. If left blank the output is written to standard
754# error (stderr).
755
756WARN_LOGFILE =
757
758#---------------------------------------------------------------------------
759# Configuration options related to the input files
760#---------------------------------------------------------------------------
761
762# The INPUT tag is used to specify the files and/or directories that contain
763# documented source files. You may enter file names like myfile.cpp or
764# directories like /usr/src/myproject. Separate the files or directories with
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800765# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700766# Note: If this tag is empty the current directory is searched.
767
Davide Pesaventofee7ee32020-04-15 02:45:07 -0400768INPUT = src tools
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700769
770# This tag can be used to specify the character encoding of the source files
771# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
772# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
773# documentation (see: http://www.gnu.org/software/libiconv) for the list of
774# possible encodings.
775# The default value is: UTF-8.
776
777INPUT_ENCODING = UTF-8
778
779# If the value of the INPUT tag contains directories, you can use the
780# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800781# *.h) to filter out the source-files in the directories.
782#
783# Note that for custom extensions or not directly supported extensions you also
784# need to set EXTENSION_MAPPING for the extension otherwise the files are not
785# read by doxygen.
786#
787# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
788# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
789# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
790# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl,
791# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700792
793FILE_PATTERNS =
794
795# The RECURSIVE tag can be used to specify whether or not subdirectories should
796# be searched for input files as well.
797# The default value is: NO.
798
799RECURSIVE = YES
800
801# The EXCLUDE tag can be used to specify files and/or directories that should be
802# excluded from the INPUT source files. This way you can easily exclude a
803# subdirectory from a directory tree whose root is specified with the INPUT tag.
804#
805# Note that relative paths are relative to the directory from which doxygen is
806# run.
807
808EXCLUDE =
809
810# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
811# directories that are symbolic links (a Unix file system feature) are excluded
812# from the input.
813# The default value is: NO.
814
815EXCLUDE_SYMLINKS = NO
816
817# If the value of the INPUT tag contains directories, you can use the
818# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
819# certain files from those directories.
820#
821# Note that the wildcards are matched against the file with absolute path, so to
822# exclude all test directories for example use the pattern */test/*
823
824EXCLUDE_PATTERNS =
825
826# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
827# (namespaces, classes, functions, etc.) that should be excluded from the
828# output. The symbol name can be a fully qualified name, a word, or if the
829# wildcard * is used, a substring. Examples: ANamespace, AClass,
830# AClass::ANamespace, ANamespace::*Test
831#
832# Note that the wildcards are matched against the file with absolute path, so to
833# exclude all test directories use the pattern */test/*
834
835EXCLUDE_SYMBOLS =
836
837# The EXAMPLE_PATH tag can be used to specify one or more files or directories
838# that contain example code fragments that are included (see the \include
839# command).
840
841EXAMPLE_PATH =
842
843# If the value of the EXAMPLE_PATH tag contains directories, you can use the
844# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
845# *.h) to filter out the source-files in the directories. If left blank all
846# files are included.
847
848EXAMPLE_PATTERNS =
849
850# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
851# searched for input files to be used with the \include or \dontinclude commands
852# irrespective of the value of the RECURSIVE tag.
853# The default value is: NO.
854
855EXAMPLE_RECURSIVE = NO
856
857# The IMAGE_PATH tag can be used to specify one or more files or directories
858# that contain images that are to be included in the documentation (see the
859# \image command).
860
861IMAGE_PATH =
862
863# The INPUT_FILTER tag can be used to specify a program that doxygen should
864# invoke to filter for each input file. Doxygen will invoke the filter program
865# by executing (via popen()) the command:
866#
867# <filter> <input-file>
868#
869# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
870# name of an input file. Doxygen will then use the output that the filter
871# program writes to standard output. If FILTER_PATTERNS is specified, this tag
872# will be ignored.
873#
874# Note that the filter must not add or remove lines; it is applied before the
875# code is scanned, but not when the output code is generated. If lines are added
876# or removed, the anchors will not be placed correctly.
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800877#
878# Note that for custom extensions or not directly supported extensions you also
879# need to set EXTENSION_MAPPING for the extension otherwise the files are not
880# properly processed by doxygen.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700881
882INPUT_FILTER =
883
884# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
885# basis. Doxygen will compare the file name with each pattern and apply the
886# filter if there is a match. The filters are a list of the form: pattern=filter
887# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
888# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
889# patterns match the file name, INPUT_FILTER is applied.
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800890#
891# Note that for custom extensions or not directly supported extensions you also
892# need to set EXTENSION_MAPPING for the extension otherwise the files are not
893# properly processed by doxygen.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700894
895FILTER_PATTERNS =
896
897# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800898# INPUT_FILTER) will also be used to filter the input files that are used for
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700899# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
900# The default value is: NO.
901
902FILTER_SOURCE_FILES = NO
903
904# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
905# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
906# it is also possible to disable source filtering for a specific pattern using
907# *.ext= (so without naming a filter).
908# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
909
910FILTER_SOURCE_PATTERNS =
911
912# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
913# is part of the input, its contents will be placed on the main page
914# (index.html). This can be useful if you have a project on for instance GitHub
915# and want to reuse the introduction page also for the doxygen output.
916
917USE_MDFILE_AS_MAINPAGE =
918
919#---------------------------------------------------------------------------
920# Configuration options related to source browsing
921#---------------------------------------------------------------------------
922
923# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
924# generated. Documented entities will be cross-referenced with these sources.
925#
926# Note: To get rid of all source code in the generated output, make sure that
927# also VERBATIM_HEADERS is set to NO.
928# The default value is: NO.
929
930SOURCE_BROWSER = YES
931
932# Setting the INLINE_SOURCES tag to YES will include the body of functions,
933# classes and enums directly into the documentation.
934# The default value is: NO.
935
936INLINE_SOURCES = NO
937
938# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
939# special comment blocks from generated source code fragments. Normal C, C++ and
940# Fortran comments will always remain visible.
941# The default value is: YES.
942
943STRIP_CODE_COMMENTS = YES
944
945# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
946# function all documented functions referencing it will be listed.
947# The default value is: NO.
948
949REFERENCED_BY_RELATION = NO
950
951# If the REFERENCES_RELATION tag is set to YES then for each documented function
952# all documented entities called/used by that function will be listed.
953# The default value is: NO.
954
955REFERENCES_RELATION = NO
956
957# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -0800958# to YES then the hyperlinks from functions in REFERENCES_RELATION and
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700959# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
960# link to the documentation.
961# The default value is: YES.
962
963REFERENCES_LINK_SOURCE = YES
964
965# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
966# source code will show a tooltip with additional information such as prototype,
967# brief description and links to the definition and documentation. Since this
968# will make the HTML file larger and loading of large files a bit slower, you
969# can opt to disable this feature.
970# The default value is: YES.
971# This tag requires that the tag SOURCE_BROWSER is set to YES.
972
973SOURCE_TOOLTIPS = YES
974
975# If the USE_HTAGS tag is set to YES then the references to source code will
976# point to the HTML generated by the htags(1) tool instead of doxygen built-in
977# source browser. The htags tool is part of GNU's global source tagging system
978# (see http://www.gnu.org/software/global/global.html). You will need version
979# 4.8.6 or higher.
980#
981# To use it do the following:
982# - Install the latest version of global
983# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
984# - Make sure the INPUT points to the root of the source tree
985# - Run doxygen as normal
986#
987# Doxygen will invoke htags (and that will in turn invoke gtags), so these
988# tools must be available from the command line (i.e. in the search path).
989#
990# The result: instead of the source browser generated by doxygen, the links to
991# source code will now point to the output of htags.
992# The default value is: NO.
993# This tag requires that the tag SOURCE_BROWSER is set to YES.
994
995USE_HTAGS = NO
996
997# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
998# verbatim copy of the header file for each class for which an include is
999# specified. Set to NO to disable this.
1000# See also: Section \class.
1001# The default value is: YES.
1002
1003VERBATIM_HEADERS = YES
1004
1005#---------------------------------------------------------------------------
1006# Configuration options related to the alphabetical class index
1007#---------------------------------------------------------------------------
1008
1009# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1010# compounds will be generated. Enable this if the project contains a lot of
1011# classes, structs, unions or interfaces.
1012# The default value is: YES.
1013
1014ALPHABETICAL_INDEX = YES
1015
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001016# In case all classes in a project start with a common prefix, all classes will
1017# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1018# can be used to specify a prefix (or a list of prefixes) that should be ignored
1019# while generating the index headers.
1020# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1021
1022IGNORE_PREFIX =
1023
1024#---------------------------------------------------------------------------
1025# Configuration options related to the HTML output
1026#---------------------------------------------------------------------------
1027
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001028# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001029# The default value is: YES.
1030
1031GENERATE_HTML = YES
1032
1033# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1034# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1035# it.
1036# The default directory is: html.
1037# This tag requires that the tag GENERATE_HTML is set to YES.
1038
1039HTML_OUTPUT = ./
1040
1041# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1042# generated HTML page (for example: .htm, .php, .asp).
1043# The default value is: .html.
1044# This tag requires that the tag GENERATE_HTML is set to YES.
1045
1046HTML_FILE_EXTENSION = .html
1047
1048# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1049# each generated HTML page. If the tag is left blank doxygen will generate a
1050# standard header.
1051#
1052# To get valid HTML the header file that includes any scripts and style sheets
1053# that doxygen needs, which is dependent on the configuration options used (e.g.
1054# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1055# default header using
1056# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1057# YourConfigFile
1058# and then modify the file new_header.html. See also section "Doxygen usage"
1059# for information on how to generate the default header that doxygen normally
1060# uses.
1061# Note: The header is subject to change so you typically have to regenerate the
1062# default header when upgrading to a newer version of doxygen. For a description
1063# of the possible markers and block names see the documentation.
1064# This tag requires that the tag GENERATE_HTML is set to YES.
1065
1066HTML_HEADER = ../docs/named_data_theme/named_data_header.html
1067
1068# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1069# generated HTML page. If the tag is left blank doxygen will generate a standard
1070# footer. See HTML_HEADER for more information on how to generate a default
1071# footer and what special commands can be used inside the footer. See also
1072# section "Doxygen usage" for information on how to generate the default footer
1073# that doxygen normally uses.
1074# This tag requires that the tag GENERATE_HTML is set to YES.
1075
1076HTML_FOOTER = ../docs/named_data_theme/named_data_footer.html
1077
1078# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1079# sheet that is used by each HTML page. It can be used to fine-tune the look of
1080# the HTML output. If left blank doxygen will generate a default style sheet.
1081# See also section "Doxygen usage" for information on how to generate the style
1082# sheet that doxygen normally uses.
1083# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1084# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1085# obsolete.
1086# This tag requires that the tag GENERATE_HTML is set to YES.
1087
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001088HTML_STYLESHEET =
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001089
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001090# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1091# cascading style sheets that are included after the standard style sheets
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001092# created by doxygen. Using this option one can overrule certain style aspects.
1093# This is preferred over using HTML_STYLESHEET since it does not replace the
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001094# standard style sheet and is therefore more robust against future updates.
1095# Doxygen will copy the style sheet files to the output directory.
1096# Note: The order of the extra style sheet files is of importance (e.g. the last
1097# style sheet in the list overrules the setting of the previous ones in the
1098# list). For an example see the documentation.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001099# This tag requires that the tag GENERATE_HTML is set to YES.
1100
1101HTML_EXTRA_STYLESHEET =
1102
1103# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1104# other source files which should be copied to the HTML output directory. Note
1105# that these files will be copied to the base HTML output directory. Use the
1106# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1107# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1108# files will be copied as-is; there are no commands or markers available.
1109# This tag requires that the tag GENERATE_HTML is set to YES.
1110
1111HTML_EXTRA_FILES = ../docs/named_data_theme/static/doxygen.css \
1112 ../docs/named_data_theme/static/base.css \
1113 ../docs/named_data_theme/static/foundation.css \
1114 ../docs/named_data_theme/static/bar-top.png
1115
1116# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001117# will adjust the colors in the style sheet and background images according to
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001118# this color. Hue is specified as an angle on a colorwheel, see
1119# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1120# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1121# purple, and 360 is red again.
1122# Minimum value: 0, maximum value: 359, default value: 220.
1123# This tag requires that the tag GENERATE_HTML is set to YES.
1124
1125HTML_COLORSTYLE_HUE = 0
1126
1127# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1128# in the HTML output. For a value of 0 the output will use grayscales only. A
1129# value of 255 will produce the most vivid colors.
1130# Minimum value: 0, maximum value: 255, default value: 100.
1131# This tag requires that the tag GENERATE_HTML is set to YES.
1132
1133HTML_COLORSTYLE_SAT = 0
1134
1135# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1136# luminance component of the colors in the HTML output. Values below 100
1137# gradually make the output lighter, whereas values above 100 make the output
1138# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1139# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1140# change the gamma.
1141# Minimum value: 40, maximum value: 240, default value: 80.
1142# This tag requires that the tag GENERATE_HTML is set to YES.
1143
1144HTML_COLORSTYLE_GAMMA = 91
1145
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001146# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1147# documentation will contain sections that can be hidden and shown after the
1148# page has loaded.
1149# The default value is: NO.
1150# This tag requires that the tag GENERATE_HTML is set to YES.
1151
Davide Pesaventofee7ee32020-04-15 02:45:07 -04001152HTML_DYNAMIC_SECTIONS = YES
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001153
1154# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1155# shown in the various tree structured indices initially; the user can expand
1156# and collapse entries dynamically later on. Doxygen will expand the tree to
1157# such a level that at most the specified number of entries are visible (unless
1158# a fully collapsed tree already exceeds this amount). So setting the number of
1159# entries 1 will produce a full collapsed tree by default. 0 is a special value
1160# representing an infinite number of entries and will result in a full expanded
1161# tree by default.
1162# Minimum value: 0, maximum value: 9999, default value: 100.
1163# This tag requires that the tag GENERATE_HTML is set to YES.
1164
1165HTML_INDEX_NUM_ENTRIES = 100
1166
1167# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1168# generated that can be used as input for Apple's Xcode 3 integrated development
1169# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1170# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1171# Makefile in the HTML output directory. Running make will produce the docset in
1172# that directory and running make install will install the docset in
1173# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1174# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1175# for more information.
1176# The default value is: NO.
1177# This tag requires that the tag GENERATE_HTML is set to YES.
1178
1179GENERATE_DOCSET = NO
1180
1181# This tag determines the name of the docset feed. A documentation feed provides
1182# an umbrella under which multiple documentation sets from a single provider
1183# (such as a company or product suite) can be grouped.
1184# The default value is: Doxygen generated docs.
1185# This tag requires that the tag GENERATE_DOCSET is set to YES.
1186
1187DOCSET_FEEDNAME = "Doxygen generated docs"
1188
1189# This tag specifies a string that should uniquely identify the documentation
1190# set bundle. This should be a reverse domain-name style string, e.g.
1191# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1192# The default value is: org.doxygen.Project.
1193# This tag requires that the tag GENERATE_DOCSET is set to YES.
1194
1195DOCSET_BUNDLE_ID = org.doxygen.Project
1196
1197# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1198# the documentation publisher. This should be a reverse domain-name style
1199# string, e.g. com.mycompany.MyDocSet.documentation.
1200# The default value is: org.doxygen.Publisher.
1201# This tag requires that the tag GENERATE_DOCSET is set to YES.
1202
1203DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1204
1205# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1206# The default value is: Publisher.
1207# This tag requires that the tag GENERATE_DOCSET is set to YES.
1208
1209DOCSET_PUBLISHER_NAME = Publisher
1210
1211# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1212# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1213# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1214# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1215# Windows.
1216#
1217# The HTML Help Workshop contains a compiler that can convert all HTML output
1218# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1219# files are now used as the Windows 98 help format, and will replace the old
1220# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1221# HTML files also contain an index, a table of contents, and you can search for
1222# words in the documentation. The HTML workshop also contains a viewer for
1223# compressed HTML files.
1224# The default value is: NO.
1225# This tag requires that the tag GENERATE_HTML is set to YES.
1226
1227GENERATE_HTMLHELP = NO
1228
1229# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1230# file. You can add a path in front of the file if the result should not be
1231# written to the html output directory.
1232# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1233
1234CHM_FILE =
1235
1236# The HHC_LOCATION tag can be used to specify the location (absolute path
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001237# including file name) of the HTML help compiler (hhc.exe). If non-empty,
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001238# doxygen will try to run the HTML help compiler on the generated index.hhp.
1239# The file has to be specified with full path.
1240# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1241
1242HHC_LOCATION =
1243
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001244# The GENERATE_CHI flag controls if a separate .chi index file is generated
1245# (YES) or that it should be included in the master .chm file (NO).
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001246# The default value is: NO.
1247# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1248
1249GENERATE_CHI = NO
1250
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001251# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001252# and project file content.
1253# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1254
1255CHM_INDEX_ENCODING =
1256
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001257# The BINARY_TOC flag controls whether a binary table of contents is generated
1258# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1259# enables the Previous and Next buttons.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001260# The default value is: NO.
1261# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1262
1263BINARY_TOC = NO
1264
1265# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1266# the table of contents of the HTML help documentation and to the tree view.
1267# The default value is: NO.
1268# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1269
1270TOC_EXPAND = NO
1271
1272# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1273# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1274# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1275# (.qch) of the generated HTML documentation.
1276# The default value is: NO.
1277# This tag requires that the tag GENERATE_HTML is set to YES.
1278
1279GENERATE_QHP = NO
1280
1281# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1282# the file name of the resulting .qch file. The path specified is relative to
1283# the HTML output folder.
1284# This tag requires that the tag GENERATE_QHP is set to YES.
1285
1286QCH_FILE =
1287
1288# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1289# Project output. For more information please see Qt Help Project / Namespace
1290# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1291# The default value is: org.doxygen.Project.
1292# This tag requires that the tag GENERATE_QHP is set to YES.
1293
1294QHP_NAMESPACE = org.doxygen.Project
1295
1296# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1297# Help Project output. For more information please see Qt Help Project / Virtual
1298# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1299# folders).
1300# The default value is: doc.
1301# This tag requires that the tag GENERATE_QHP is set to YES.
1302
1303QHP_VIRTUAL_FOLDER = doc
1304
1305# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1306# filter to add. For more information please see Qt Help Project / Custom
1307# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1308# filters).
1309# This tag requires that the tag GENERATE_QHP is set to YES.
1310
1311QHP_CUST_FILTER_NAME =
1312
1313# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1314# custom filter to add. For more information please see Qt Help Project / Custom
1315# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1316# filters).
1317# This tag requires that the tag GENERATE_QHP is set to YES.
1318
1319QHP_CUST_FILTER_ATTRS =
1320
1321# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1322# project's filter section matches. Qt Help Project / Filter Attributes (see:
1323# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1324# This tag requires that the tag GENERATE_QHP is set to YES.
1325
1326QHP_SECT_FILTER_ATTRS =
1327
1328# The QHG_LOCATION tag can be used to specify the location of Qt's
1329# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1330# generated .qhp file.
1331# This tag requires that the tag GENERATE_QHP is set to YES.
1332
1333QHG_LOCATION =
1334
1335# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1336# generated, together with the HTML files, they form an Eclipse help plugin. To
1337# install this plugin and make it available under the help contents menu in
1338# Eclipse, the contents of the directory containing the HTML and XML files needs
1339# to be copied into the plugins directory of eclipse. The name of the directory
1340# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1341# After copying Eclipse needs to be restarted before the help appears.
1342# The default value is: NO.
1343# This tag requires that the tag GENERATE_HTML is set to YES.
1344
1345GENERATE_ECLIPSEHELP = NO
1346
1347# A unique identifier for the Eclipse help plugin. When installing the plugin
1348# the directory name containing the HTML and XML files should also have this
1349# name. Each documentation set should have its own identifier.
1350# The default value is: org.doxygen.Project.
1351# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1352
1353ECLIPSE_DOC_ID = org.doxygen.Project
1354
1355# If you want full control over the layout of the generated HTML pages it might
1356# be necessary to disable the index and replace it with your own. The
1357# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1358# of each HTML page. A value of NO enables the index and the value YES disables
1359# it. Since the tabs in the index contain the same information as the navigation
1360# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1361# The default value is: NO.
1362# This tag requires that the tag GENERATE_HTML is set to YES.
1363
1364DISABLE_INDEX = NO
1365
1366# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1367# structure should be generated to display hierarchical information. If the tag
1368# value is set to YES, a side panel will be generated containing a tree-like
1369# index structure (just like the one that is generated for HTML Help). For this
1370# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1371# (i.e. any modern browser). Windows users are probably better off using the
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001372# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001373# further fine-tune the look of the index. As an example, the default style
1374# sheet generated by doxygen has an example that shows how to put an image at
1375# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1376# the same information as the tab index, you could consider setting
1377# DISABLE_INDEX to YES when enabling this option.
1378# The default value is: NO.
1379# This tag requires that the tag GENERATE_HTML is set to YES.
1380
1381GENERATE_TREEVIEW = YES
1382
1383# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1384# doxygen will group on one line in the generated HTML documentation.
1385#
1386# Note that a value of 0 will completely suppress the enum values from appearing
1387# in the overview section.
1388# Minimum value: 0, maximum value: 20, default value: 4.
1389# This tag requires that the tag GENERATE_HTML is set to YES.
1390
Davide Pesaventofee7ee32020-04-15 02:45:07 -04001391ENUM_VALUES_PER_LINE = 1
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001392
1393# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1394# to set the initial width (in pixels) of the frame in which the tree is shown.
1395# Minimum value: 0, maximum value: 1500, default value: 250.
1396# This tag requires that the tag GENERATE_HTML is set to YES.
1397
1398TREEVIEW_WIDTH = 250
1399
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001400# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001401# external symbols imported via tag files in a separate window.
1402# The default value is: NO.
1403# This tag requires that the tag GENERATE_HTML is set to YES.
1404
1405EXT_LINKS_IN_WINDOW = NO
1406
1407# Use this tag to change the font size of LaTeX formulas included as images in
1408# the HTML documentation. When you change the font size after a successful
1409# doxygen run you need to manually remove any form_*.png images from the HTML
1410# output directory to force them to be regenerated.
1411# Minimum value: 8, maximum value: 50, default value: 10.
1412# This tag requires that the tag GENERATE_HTML is set to YES.
1413
1414FORMULA_FONTSIZE = 10
1415
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001416# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1417# http://www.mathjax.org) which uses client side Javascript for the rendering
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001418# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001419# installed or if you want to formulas look prettier in the HTML output. When
1420# enabled you may also need to install MathJax separately and configure the path
1421# to it using the MATHJAX_RELPATH option.
1422# The default value is: NO.
1423# This tag requires that the tag GENERATE_HTML is set to YES.
1424
1425USE_MATHJAX = NO
1426
1427# When MathJax is enabled you can set the default output format to be used for
1428# the MathJax output. See the MathJax site (see:
1429# http://docs.mathjax.org/en/latest/output.html) for more details.
1430# Possible values are: HTML-CSS (which is slower, but has the best
1431# compatibility), NativeMML (i.e. MathML) and SVG.
1432# The default value is: HTML-CSS.
1433# This tag requires that the tag USE_MATHJAX is set to YES.
1434
1435MATHJAX_FORMAT = HTML-CSS
1436
1437# When MathJax is enabled you need to specify the location relative to the HTML
1438# output directory using the MATHJAX_RELPATH option. The destination directory
1439# should contain the MathJax.js script. For instance, if the mathjax directory
1440# is located at the same level as the HTML output directory, then
1441# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1442# Content Delivery Network so you can quickly see the result without installing
1443# MathJax. However, it is strongly recommended to install a local copy of
1444# MathJax from http://www.mathjax.org before deployment.
1445# The default value is: http://cdn.mathjax.org/mathjax/latest.
1446# This tag requires that the tag USE_MATHJAX is set to YES.
1447
1448MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1449
1450# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1451# extension names that should be enabled during MathJax rendering. For example
1452# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1453# This tag requires that the tag USE_MATHJAX is set to YES.
1454
1455MATHJAX_EXTENSIONS =
1456
1457# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1458# of code that will be used on startup of the MathJax code. See the MathJax site
1459# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1460# example see the documentation.
1461# This tag requires that the tag USE_MATHJAX is set to YES.
1462
1463MATHJAX_CODEFILE =
1464
1465# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1466# the HTML output. The underlying search engine uses javascript and DHTML and
1467# should work on any modern browser. Note that when using HTML help
1468# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1469# there is already a search function so this one should typically be disabled.
1470# For large projects the javascript based search engine can be slow, then
1471# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1472# search using the keyboard; to jump to the search box use <access key> + S
1473# (what the <access key> is depends on the OS and browser, but it is typically
1474# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1475# key> to jump into the search results window, the results can be navigated
1476# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1477# the search. The filter options can be selected when the cursor is inside the
1478# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1479# to select a filter and <Enter> or <escape> to activate or cancel the filter
1480# option.
1481# The default value is: YES.
1482# This tag requires that the tag GENERATE_HTML is set to YES.
1483
1484SEARCHENGINE = YES
1485
1486# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1487# implemented using a web server instead of a web client using Javascript. There
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001488# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1489# setting. When disabled, doxygen will generate a PHP script for searching and
1490# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1491# and searching needs to be provided by external tools. See the section
1492# "External Indexing and Searching" for details.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001493# The default value is: NO.
1494# This tag requires that the tag SEARCHENGINE is set to YES.
1495
1496SERVER_BASED_SEARCH = NO
1497
1498# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1499# script for searching. Instead the search results are written to an XML file
1500# which needs to be processed by an external indexer. Doxygen will invoke an
1501# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1502# search results.
1503#
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001504# Doxygen ships with an example indexer (doxyindexer) and search engine
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001505# (doxysearch.cgi) which are based on the open source search engine library
1506# Xapian (see: http://xapian.org/).
1507#
1508# See the section "External Indexing and Searching" for details.
1509# The default value is: NO.
1510# This tag requires that the tag SEARCHENGINE is set to YES.
1511
1512EXTERNAL_SEARCH = NO
1513
1514# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1515# which will return the search results when EXTERNAL_SEARCH is enabled.
1516#
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001517# Doxygen ships with an example indexer (doxyindexer) and search engine
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001518# (doxysearch.cgi) which are based on the open source search engine library
1519# Xapian (see: http://xapian.org/). See the section "External Indexing and
1520# Searching" for details.
1521# This tag requires that the tag SEARCHENGINE is set to YES.
1522
1523SEARCHENGINE_URL =
1524
1525# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1526# search data is written to a file for indexing by an external tool. With the
1527# SEARCHDATA_FILE tag the name of this file can be specified.
1528# The default file is: searchdata.xml.
1529# This tag requires that the tag SEARCHENGINE is set to YES.
1530
1531SEARCHDATA_FILE = searchdata.xml
1532
1533# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1534# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1535# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1536# projects and redirect the results back to the right project.
1537# This tag requires that the tag SEARCHENGINE is set to YES.
1538
1539EXTERNAL_SEARCH_ID =
1540
1541# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1542# projects other than the one defined by this configuration file, but that are
1543# all added to the same external search index. Each project needs to have a
1544# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1545# to a relative location where the documentation can be found. The format is:
1546# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1547# This tag requires that the tag SEARCHENGINE is set to YES.
1548
1549EXTRA_SEARCH_MAPPINGS =
1550
1551#---------------------------------------------------------------------------
1552# Configuration options related to the LaTeX output
1553#---------------------------------------------------------------------------
1554
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001555# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001556# The default value is: YES.
1557
1558GENERATE_LATEX = NO
1559
1560# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1561# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1562# it.
1563# The default directory is: latex.
1564# This tag requires that the tag GENERATE_LATEX is set to YES.
1565
1566LATEX_OUTPUT = latex
1567
1568# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1569# invoked.
1570#
1571# Note that when enabling USE_PDFLATEX this option is only used for generating
1572# bitmaps for formulas in the HTML output, but not in the Makefile that is
1573# written to the output directory.
1574# The default file is: latex.
1575# This tag requires that the tag GENERATE_LATEX is set to YES.
1576
1577LATEX_CMD_NAME = latex
1578
1579# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1580# index for LaTeX.
1581# The default file is: makeindex.
1582# This tag requires that the tag GENERATE_LATEX is set to YES.
1583
1584MAKEINDEX_CMD_NAME = makeindex
1585
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001586# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001587# documents. This may be useful for small projects and may help to save some
1588# trees in general.
1589# The default value is: NO.
1590# This tag requires that the tag GENERATE_LATEX is set to YES.
1591
1592COMPACT_LATEX = NO
1593
1594# The PAPER_TYPE tag can be used to set the paper type that is used by the
1595# printer.
1596# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1597# 14 inches) and executive (7.25 x 10.5 inches).
1598# The default value is: a4.
1599# This tag requires that the tag GENERATE_LATEX is set to YES.
1600
1601PAPER_TYPE = a4
1602
1603# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001604# that should be included in the LaTeX output. The package can be specified just
1605# by its name or with the correct syntax as to be used with the LaTeX
1606# \usepackage command. To get the times font for instance you can specify :
1607# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1608# To use the option intlimits with the amsmath package you can specify:
1609# EXTRA_PACKAGES=[intlimits]{amsmath}
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001610# If left blank no extra packages will be included.
1611# This tag requires that the tag GENERATE_LATEX is set to YES.
1612
1613EXTRA_PACKAGES =
1614
1615# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1616# generated LaTeX document. The header should contain everything until the first
1617# chapter. If it is left blank doxygen will generate a standard header. See
1618# section "Doxygen usage" for information on how to let doxygen write the
1619# default header to a separate file.
1620#
1621# Note: Only use a user-defined header if you know what you are doing! The
1622# following commands have a special meaning inside the header: $title,
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001623# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1624# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1625# string, for the replacement values of the other commands the user is referred
1626# to HTML_HEADER.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001627# This tag requires that the tag GENERATE_LATEX is set to YES.
1628
1629LATEX_HEADER =
1630
1631# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1632# generated LaTeX document. The footer should contain everything after the last
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001633# chapter. If it is left blank doxygen will generate a standard footer. See
1634# LATEX_HEADER for more information on how to generate a default footer and what
1635# special commands can be used inside the footer.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001636#
1637# Note: Only use a user-defined footer if you know what you are doing!
1638# This tag requires that the tag GENERATE_LATEX is set to YES.
1639
1640LATEX_FOOTER =
1641
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001642# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1643# LaTeX style sheets that are included after the standard style sheets created
1644# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1645# will copy the style sheet files to the output directory.
1646# Note: The order of the extra style sheet files is of importance (e.g. the last
1647# style sheet in the list overrules the setting of the previous ones in the
1648# list).
1649# This tag requires that the tag GENERATE_LATEX is set to YES.
1650
1651LATEX_EXTRA_STYLESHEET =
1652
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001653# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1654# other source files which should be copied to the LATEX_OUTPUT output
1655# directory. Note that the files will be copied as-is; there are no commands or
1656# markers available.
1657# This tag requires that the tag GENERATE_LATEX is set to YES.
1658
1659LATEX_EXTRA_FILES =
1660
1661# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1662# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1663# contain links (just like the HTML output) instead of page references. This
1664# makes the output suitable for online browsing using a PDF viewer.
1665# The default value is: YES.
1666# This tag requires that the tag GENERATE_LATEX is set to YES.
1667
1668PDF_HYPERLINKS = YES
1669
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001670# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1671# the PDF file directly from the LaTeX files. Set this option to YES, to get a
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001672# higher quality PDF documentation.
1673# The default value is: YES.
1674# This tag requires that the tag GENERATE_LATEX is set to YES.
1675
1676USE_PDFLATEX = YES
1677
1678# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1679# command to the generated LaTeX files. This will instruct LaTeX to keep running
1680# if errors occur, instead of asking the user for help. This option is also used
1681# when generating formulas in HTML.
1682# The default value is: NO.
1683# This tag requires that the tag GENERATE_LATEX is set to YES.
1684
1685LATEX_BATCHMODE = NO
1686
1687# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1688# index chapters (such as File Index, Compound Index, etc.) in the output.
1689# The default value is: NO.
1690# This tag requires that the tag GENERATE_LATEX is set to YES.
1691
1692LATEX_HIDE_INDICES = NO
1693
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001694# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1695# bibliography, e.g. plainnat, or ieeetr. See
1696# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1697# The default value is: plain.
1698# This tag requires that the tag GENERATE_LATEX is set to YES.
1699
1700LATEX_BIB_STYLE = plain
1701
1702#---------------------------------------------------------------------------
1703# Configuration options related to the RTF output
1704#---------------------------------------------------------------------------
1705
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001706# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001707# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1708# readers/editors.
1709# The default value is: NO.
1710
1711GENERATE_RTF = NO
1712
1713# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1714# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1715# it.
1716# The default directory is: rtf.
1717# This tag requires that the tag GENERATE_RTF is set to YES.
1718
1719RTF_OUTPUT = rtf
1720
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001721# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001722# documents. This may be useful for small projects and may help to save some
1723# trees in general.
1724# The default value is: NO.
1725# This tag requires that the tag GENERATE_RTF is set to YES.
1726
1727COMPACT_RTF = NO
1728
1729# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1730# contain hyperlink fields. The RTF file will contain links (just like the HTML
1731# output) instead of page references. This makes the output suitable for online
1732# browsing using Word or some other Word compatible readers that support those
1733# fields.
1734#
1735# Note: WordPad (write) and others do not support links.
1736# The default value is: NO.
1737# This tag requires that the tag GENERATE_RTF is set to YES.
1738
1739RTF_HYPERLINKS = NO
1740
1741# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1742# file, i.e. a series of assignments. You only have to provide replacements,
1743# missing definitions are set to their default value.
1744#
1745# See also section "Doxygen usage" for information on how to generate the
1746# default style sheet that doxygen normally uses.
1747# This tag requires that the tag GENERATE_RTF is set to YES.
1748
1749RTF_STYLESHEET_FILE =
1750
1751# Set optional variables used in the generation of an RTF document. Syntax is
1752# similar to doxygen's config file. A template extensions file can be generated
1753# using doxygen -e rtf extensionFile.
1754# This tag requires that the tag GENERATE_RTF is set to YES.
1755
1756RTF_EXTENSIONS_FILE =
1757
1758#---------------------------------------------------------------------------
1759# Configuration options related to the man page output
1760#---------------------------------------------------------------------------
1761
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001762# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001763# classes and files.
1764# The default value is: NO.
1765
1766GENERATE_MAN = NO
1767
1768# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1769# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1770# it. A directory man3 will be created inside the directory specified by
1771# MAN_OUTPUT.
1772# The default directory is: man.
1773# This tag requires that the tag GENERATE_MAN is set to YES.
1774
1775MAN_OUTPUT = man
1776
1777# The MAN_EXTENSION tag determines the extension that is added to the generated
1778# man pages. In case the manual section does not start with a number, the number
1779# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1780# optional.
1781# The default value is: .3.
1782# This tag requires that the tag GENERATE_MAN is set to YES.
1783
1784MAN_EXTENSION = .3
1785
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001786# The MAN_SUBDIR tag determines the name of the directory created within
1787# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1788# MAN_EXTENSION with the initial . removed.
1789# This tag requires that the tag GENERATE_MAN is set to YES.
1790
1791MAN_SUBDIR =
1792
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001793# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1794# will generate one additional man file for each entity documented in the real
1795# man page(s). These additional files only source the real man page, but without
1796# them the man command would be unable to find the correct page.
1797# The default value is: NO.
1798# This tag requires that the tag GENERATE_MAN is set to YES.
1799
1800MAN_LINKS = NO
1801
1802#---------------------------------------------------------------------------
1803# Configuration options related to the XML output
1804#---------------------------------------------------------------------------
1805
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001806# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001807# captures the structure of the code including all documentation.
1808# The default value is: NO.
1809
1810GENERATE_XML = NO
1811
1812# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1813# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1814# it.
1815# The default directory is: xml.
1816# This tag requires that the tag GENERATE_XML is set to YES.
1817
1818XML_OUTPUT = xml
1819
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001820# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001821# listings (including syntax highlighting and cross-referencing information) to
1822# the XML output. Note that enabling this will significantly increase the size
1823# of the XML output.
1824# The default value is: YES.
1825# This tag requires that the tag GENERATE_XML is set to YES.
1826
1827XML_PROGRAMLISTING = YES
1828
1829#---------------------------------------------------------------------------
1830# Configuration options related to the DOCBOOK output
1831#---------------------------------------------------------------------------
1832
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001833# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001834# that can be used to generate PDF.
1835# The default value is: NO.
1836
1837GENERATE_DOCBOOK = NO
1838
1839# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1840# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1841# front of it.
1842# The default directory is: docbook.
1843# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1844
1845DOCBOOK_OUTPUT = docbook
1846
1847#---------------------------------------------------------------------------
1848# Configuration options for the AutoGen Definitions output
1849#---------------------------------------------------------------------------
1850
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001851# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1852# AutoGen Definitions (see http://autogen.sf.net) file that captures the
1853# structure of the code including all documentation. Note that this feature is
1854# still experimental and incomplete at the moment.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001855# The default value is: NO.
1856
1857GENERATE_AUTOGEN_DEF = NO
1858
1859#---------------------------------------------------------------------------
1860# Configuration options related to the Perl module output
1861#---------------------------------------------------------------------------
1862
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001863# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001864# file that captures the structure of the code including all documentation.
1865#
1866# Note that this feature is still experimental and incomplete at the moment.
1867# The default value is: NO.
1868
1869GENERATE_PERLMOD = NO
1870
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001871# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001872# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1873# output from the Perl module output.
1874# The default value is: NO.
1875# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1876
1877PERLMOD_LATEX = NO
1878
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001879# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001880# formatted so it can be parsed by a human reader. This is useful if you want to
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001881# understand what is going on. On the other hand, if this tag is set to NO, the
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001882# size of the Perl module output will be much smaller and Perl will parse it
1883# just the same.
1884# The default value is: YES.
1885# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1886
1887PERLMOD_PRETTY = YES
1888
1889# The names of the make variables in the generated doxyrules.make file are
1890# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1891# so different doxyrules.make files included by the same Makefile don't
1892# overwrite each other's variables.
1893# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1894
1895PERLMOD_MAKEVAR_PREFIX =
1896
1897#---------------------------------------------------------------------------
1898# Configuration options related to the preprocessor
1899#---------------------------------------------------------------------------
1900
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001901# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001902# C-preprocessor directives found in the sources and include files.
1903# The default value is: YES.
1904
1905ENABLE_PREPROCESSING = YES
1906
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001907# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
1908# in the source code. If set to NO, only conditional compilation will be
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001909# performed. Macro expansion can be done in a controlled way by setting
1910# EXPAND_ONLY_PREDEF to YES.
1911# The default value is: NO.
1912# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1913
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001914MACRO_EXPANSION = YES
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001915
1916# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1917# the macro expansion is limited to the macros specified with the PREDEFINED and
1918# EXPAND_AS_DEFINED tags.
1919# The default value is: NO.
1920# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1921
1922EXPAND_ONLY_PREDEF = NO
1923
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001924# If the SEARCH_INCLUDES tag is set to YES, the include files in the
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001925# INCLUDE_PATH will be searched if a #include is found.
1926# The default value is: YES.
1927# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1928
1929SEARCH_INCLUDES = YES
1930
1931# The INCLUDE_PATH tag can be used to specify one or more directories that
1932# contain include files that are not input files but should be processed by the
1933# preprocessor.
1934# This tag requires that the tag SEARCH_INCLUDES is set to YES.
1935
1936INCLUDE_PATH =
1937
1938# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1939# patterns (like *.h and *.hpp) to filter out the header-files in the
1940# directories. If left blank, the patterns specified with FILE_PATTERNS will be
1941# used.
1942# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1943
1944INCLUDE_FILE_PATTERNS =
1945
1946# The PREDEFINED tag can be used to specify one or more macro names that are
1947# defined before the preprocessor is started (similar to the -D option of e.g.
1948# gcc). The argument of the tag is a list of macros of the form: name or
1949# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
1950# is assumed. To prevent a macro definition from being undefined via #undef or
1951# recursively expanded use the := operator instead of the = operator.
1952# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1953
Davide Pesaventofee7ee32020-04-15 02:45:07 -04001954PREDEFINED = DOXYGEN \
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001955 BOOST_CONCEPT_ASSERT(x)= \
1956 BOOST_CONCEPT_REQUIRES(x)= \
Davide Pesaventofee7ee32020-04-15 02:45:07 -04001957 NDNS_LOG_INIT(x)= \
Davide Pesaventod01c1a42019-01-21 21:42:45 -05001958 NDNS_PUBLIC_WITH_TESTS_ELSE_PROTECTED=protected \
1959 NDNS_PUBLIC_WITH_TESTS_ELSE_PRIVATE=private \
1960 NDNS_PROTECTED_WITH_TESTS_ELSE_PRIVATE=private \
1961 NDNS_VIRTUAL_WITH_TESTS=
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001962
1963# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
1964# tag can be used to specify a list of macro names that should be expanded. The
1965# macro definition that is found in the sources will be used. Use the PREDEFINED
1966# tag if you want to use a different macro definition that overrules the
1967# definition found in the source code.
1968# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1969
1970EXPAND_AS_DEFINED =
1971
1972# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001973# remove all references to function-like macros that are alone on a line, have
1974# an all uppercase name, and do not end with a semicolon. Such function macros
1975# are typically used for boiler-plate code, and will confuse the parser if not
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001976# removed.
1977# The default value is: YES.
1978# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1979
1980SKIP_FUNCTION_MACROS = YES
1981
1982#---------------------------------------------------------------------------
1983# Configuration options related to external references
1984#---------------------------------------------------------------------------
1985
1986# The TAGFILES tag can be used to specify one or more tag files. For each tag
1987# file the location of the external documentation should be added. The format of
1988# a tag file without this location is as follows:
1989# TAGFILES = file1 file2 ...
1990# Adding location for the tag files is done as follows:
1991# TAGFILES = file1=loc1 "file2 = loc2" ...
1992# where loc1 and loc2 can be relative or absolute paths or URLs. See the
1993# section "Linking to external documentation" for more information about the use
1994# of tag files.
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08001995# Note: Each tag file must have a unique name (where the name does NOT include
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07001996# the path). If a tag file is not located in the directory in which doxygen is
1997# run, you must also specify the path to the tagfile here.
1998
1999TAGFILES =
2000
2001# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2002# tag file that is based on the input files it reads. See section "Linking to
2003# external documentation" for more information about the usage of tag files.
2004
2005GENERATE_TAGFILE = NDNS.tag
2006
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08002007# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2008# the class index. If set to NO, only the inherited external classes will be
2009# listed.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07002010# The default value is: NO.
2011
2012ALLEXTERNALS = NO
2013
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08002014# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2015# in the modules index. If set to NO, only the current project's groups will be
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07002016# listed.
2017# The default value is: YES.
2018
2019EXTERNAL_GROUPS = YES
2020
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08002021# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07002022# the related pages index. If set to NO, only the current project's pages will
2023# be listed.
2024# The default value is: YES.
2025
2026EXTERNAL_PAGES = YES
2027
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07002028#---------------------------------------------------------------------------
2029# Configuration options related to the dot tool
2030#---------------------------------------------------------------------------
2031
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08002032# You can include diagrams made with dia in doxygen documentation. Doxygen will
2033# then run dia to produce the diagram and insert it in the documentation. The
2034# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2035# If left empty dia is assumed to be found in the default search path.
2036
2037DIA_PATH =
2038
2039# If set to YES the inheritance and collaboration graphs will hide inheritance
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07002040# and usage relations if the target is undocumented or is not a class.
2041# The default value is: YES.
2042
2043HIDE_UNDOC_RELATIONS = YES
2044
2045# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2046# available from the path. This tool is part of Graphviz (see:
2047# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2048# Bell Labs. The other options in this section have no effect if this option is
2049# set to NO
Davide Pesavento3d01fa32021-10-03 17:13:38 -04002050# The default value is: YES.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07002051
Davide Pesavento3d01fa32021-10-03 17:13:38 -04002052HAVE_DOT = @HAVE_DOT@
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07002053
2054# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2055# to run in parallel. When set to 0 doxygen will base this on the number of
2056# processors available in the system. You can set it explicitly to a value
2057# larger than 0 to get control over the balance between CPU load and processing
2058# speed.
2059# Minimum value: 0, maximum value: 32, default value: 0.
2060# This tag requires that the tag HAVE_DOT is set to YES.
2061
2062DOT_NUM_THREADS = 0
2063
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07002064# By default doxygen will tell dot to use the default font as specified with
2065# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2066# the path where dot can find it using this tag.
2067# This tag requires that the tag HAVE_DOT is set to YES.
2068
2069DOT_FONTPATH =
2070
2071# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2072# each documented class showing the direct and indirect inheritance relations.
2073# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2074# The default value is: YES.
2075# This tag requires that the tag HAVE_DOT is set to YES.
2076
2077CLASS_GRAPH = YES
2078
2079# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2080# graph for each documented class showing the direct and indirect implementation
2081# dependencies (inheritance, containment, and class references variables) of the
2082# class with other documented classes.
2083# The default value is: YES.
2084# This tag requires that the tag HAVE_DOT is set to YES.
2085
2086COLLABORATION_GRAPH = YES
2087
2088# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2089# groups, showing the direct groups dependencies.
2090# The default value is: YES.
2091# This tag requires that the tag HAVE_DOT is set to YES.
2092
2093GROUP_GRAPHS = YES
2094
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08002095# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07002096# collaboration diagrams in a style similar to the OMG's Unified Modeling
2097# Language.
2098# The default value is: NO.
2099# This tag requires that the tag HAVE_DOT is set to YES.
2100
Davide Pesavento3d01fa32021-10-03 17:13:38 -04002101UML_LOOK = NO
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07002102
2103# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2104# class node. If there are many fields or methods and many nodes the graph may
2105# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2106# number of items for each type to make the size more manageable. Set this to 0
2107# for no limit. Note that the threshold may be exceeded by 50% before the limit
2108# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2109# but if the number exceeds 15, the total amount of fields shown is limited to
2110# 10.
2111# Minimum value: 0, maximum value: 100, default value: 10.
2112# This tag requires that the tag HAVE_DOT is set to YES.
2113
2114UML_LIMIT_NUM_FIELDS = 10
2115
2116# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2117# collaboration graphs will show the relations between templates and their
2118# instances.
2119# The default value is: NO.
2120# This tag requires that the tag HAVE_DOT is set to YES.
2121
2122TEMPLATE_RELATIONS = YES
2123
2124# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2125# YES then doxygen will generate a graph for each documented file showing the
2126# direct and indirect include dependencies of the file with other documented
2127# files.
2128# The default value is: YES.
2129# This tag requires that the tag HAVE_DOT is set to YES.
2130
2131INCLUDE_GRAPH = YES
2132
2133# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2134# set to YES then doxygen will generate a graph for each documented file showing
2135# the direct and indirect include dependencies of the file with other documented
2136# files.
2137# The default value is: YES.
2138# This tag requires that the tag HAVE_DOT is set to YES.
2139
2140INCLUDED_BY_GRAPH = YES
2141
2142# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2143# dependency graph for every global function or class method.
2144#
2145# Note that enabling this option will significantly increase the time of a run.
2146# So in most cases it will be better to enable call graphs for selected
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08002147# functions only using the \callgraph command. Disabling a call graph can be
2148# accomplished by means of the command \hidecallgraph.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07002149# The default value is: NO.
2150# This tag requires that the tag HAVE_DOT is set to YES.
2151
Davide Pesavento3d01fa32021-10-03 17:13:38 -04002152CALL_GRAPH = NO
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07002153
2154# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2155# dependency graph for every global function or class method.
2156#
2157# Note that enabling this option will significantly increase the time of a run.
2158# So in most cases it will be better to enable caller graphs for selected
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08002159# functions only using the \callergraph command. Disabling a caller graph can be
2160# accomplished by means of the command \hidecallergraph.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07002161# The default value is: NO.
2162# This tag requires that the tag HAVE_DOT is set to YES.
2163
Davide Pesavento3d01fa32021-10-03 17:13:38 -04002164CALLER_GRAPH = NO
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07002165
2166# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2167# hierarchy of all classes instead of a textual one.
2168# The default value is: YES.
2169# This tag requires that the tag HAVE_DOT is set to YES.
2170
2171GRAPHICAL_HIERARCHY = YES
2172
2173# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2174# dependencies a directory has on other directories in a graphical way. The
2175# dependency relations are determined by the #include relations between the
2176# files in the directories.
2177# The default value is: YES.
2178# This tag requires that the tag HAVE_DOT is set to YES.
2179
2180DIRECTORY_GRAPH = YES
2181
2182# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08002183# generated by dot. For an explanation of the image formats see the section
2184# output formats in the documentation of the dot tool (Graphviz (see:
2185# http://www.graphviz.org/)).
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07002186# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2187# to make the SVG files visible in IE 9+ (other browsers do not have this
2188# requirement).
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08002189# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
2190# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2191# png:gdiplus:gdiplus.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07002192# The default value is: png.
2193# This tag requires that the tag HAVE_DOT is set to YES.
2194
2195DOT_IMAGE_FORMAT = svg
2196
2197# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2198# enable generation of interactive SVG images that allow zooming and panning.
2199#
2200# Note that this requires a modern browser other than Internet Explorer. Tested
2201# and working are Firefox, Chrome, Safari, and Opera.
2202# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2203# the SVG files visible. Older versions of IE do not have SVG support.
2204# The default value is: NO.
2205# This tag requires that the tag HAVE_DOT is set to YES.
2206
2207INTERACTIVE_SVG = NO
2208
2209# The DOT_PATH tag can be used to specify the path where the dot tool can be
2210# found. If left blank, it is assumed the dot tool can be found in the path.
2211# This tag requires that the tag HAVE_DOT is set to YES.
2212
2213DOT_PATH =
2214
2215# The DOTFILE_DIRS tag can be used to specify one or more directories that
2216# contain dot files that are included in the documentation (see the \dotfile
2217# command).
2218# This tag requires that the tag HAVE_DOT is set to YES.
2219
2220DOTFILE_DIRS =
2221
2222# The MSCFILE_DIRS tag can be used to specify one or more directories that
2223# contain msc files that are included in the documentation (see the \mscfile
2224# command).
2225
2226MSCFILE_DIRS =
2227
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08002228# The DIAFILE_DIRS tag can be used to specify one or more directories that
2229# contain dia files that are included in the documentation (see the \diafile
2230# command).
2231
2232DIAFILE_DIRS =
2233
2234# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2235# path where java can find the plantuml.jar file. If left blank, it is assumed
2236# PlantUML is not used or called during a preprocessing step. Doxygen will
2237# generate a warning when it encounters a \startuml command in this case and
2238# will not generate output for the diagram.
2239
2240PLANTUML_JAR_PATH =
2241
2242# When using plantuml, the specified paths are searched for files specified by
2243# the !include statement in a plantuml block.
2244
2245PLANTUML_INCLUDE_PATH =
2246
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07002247# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2248# that will be shown in the graph. If the number of nodes in a graph becomes
2249# larger than this value, doxygen will truncate the graph, which is visualized
2250# by representing a node as a red box. Note that doxygen if the number of direct
2251# children of the root node in a graph is already larger than
2252# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2253# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2254# Minimum value: 0, maximum value: 10000, default value: 50.
2255# This tag requires that the tag HAVE_DOT is set to YES.
2256
2257DOT_GRAPH_MAX_NODES = 50
2258
2259# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2260# generated by dot. A depth value of 3 means that only nodes reachable from the
2261# root by following a path via at most 3 edges will be shown. Nodes that lay
2262# further from the root node will be omitted. Note that setting this option to 1
2263# or 2 may greatly reduce the computation time needed for large code bases. Also
2264# note that the size of a graph can be further restricted by
2265# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2266# Minimum value: 0, maximum value: 1000, default value: 0.
2267# This tag requires that the tag HAVE_DOT is set to YES.
2268
2269MAX_DOT_GRAPH_DEPTH = 0
2270
2271# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2272# background. This is disabled by default, because dot on Windows does not seem
2273# to support this out of the box.
2274#
2275# Warning: Depending on the platform used, enabling this option may lead to
2276# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2277# read).
2278# The default value is: NO.
2279# This tag requires that the tag HAVE_DOT is set to YES.
2280
2281DOT_TRANSPARENT = YES
2282
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08002283# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07002284# files in one run (i.e. multiple -o and -T options on the command line). This
2285# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2286# this, this feature is disabled by default.
2287# The default value is: NO.
2288# This tag requires that the tag HAVE_DOT is set to YES.
2289
Davide Pesaventofee7ee32020-04-15 02:45:07 -04002290DOT_MULTI_TARGETS = YES
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07002291
2292# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2293# explaining the meaning of the various boxes and arrows in the dot generated
2294# graphs.
2295# The default value is: YES.
2296# This tag requires that the tag HAVE_DOT is set to YES.
2297
2298GENERATE_LEGEND = YES
2299
Alexander Afanasyevdf2e9392016-03-10 11:50:53 -08002300# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -07002301# files that are used to generate the various graphs.
2302# The default value is: YES.
2303# This tag requires that the tag HAVE_DOT is set to YES.
2304
2305DOT_CLEANUP = YES