blob: 82513e48003c510e83c3943ca006ed77694e3f78 [file] [log] [blame]
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001# Doxyfile 1.8.13
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002
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
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -070035PROJECT_NAME = "ndn-cxx: NDN C++ library with eXperimental eXtensions"
Alexander Afanasyev401a2362014-03-02 00:03:11 +000036
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
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -070041PROJECT_NUMBER = @VERSION@
Alexander Afanasyev401a2362014-03-02 00:03:11 +000042
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
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -040049# 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 Afanasyev401a2362014-03-02 00:03:11 +000053
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
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -070061OUTPUT_DIRECTORY = docs/doxygen
Alexander Afanasyev401a2362014-03-02 00:03:11 +000062
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -040063# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
Alexander Afanasyev401a2362014-03-02 00:03:11 +000064# 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
71CREATE_SUBDIRS = YES
72
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -040073# 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 Afanasyev401a2362014-03-02 00:03:11 +000081# 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.
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -040084# 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 Afanasyev401a2362014-03-02 00:03:11 +000092# The default value is: English.
93
94OUTPUT_LANGUAGE = English
95
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -040096# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
Alexander Afanasyev401a2362014-03-02 00:03:11 +000097# 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
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400103# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000104# 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
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400138# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000139# 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
Davide Pesavento2c1d3492018-11-24 19:44:48 -0500143FULL_PATH_NAMES = YES
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000144
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
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400155STRIP_FROM_PATH =
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000156
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
Davide Pesavento2c1d3492018-11-24 19:44:48 -0500164STRIP_FROM_INC_PATH = ..
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000165
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
Alexander Afanasyev3aeeaeb2014-04-22 23:34:23 -0700180JAVADOC_AUTOBRIEF = YES
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000181
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
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400188QT_AUTOBRIEF = YES
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000189
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
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400208# 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 Afanasyev401a2362014-03-02 00:03:11 +0000211# 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 Afanasyev401a2362014-03-02 00:03:11 +0000233# 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
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400239OPTIMIZE_OUTPUT_FOR_C = NO
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000240
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,
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400266# 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 Afanasyev401a2362014-03-02 00:03:11 +0000272#
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400273# Note: For files without extension you can use no_extension as a placeholder.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000274#
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
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400290# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
291# to that level are automatically included in the table of contents, even if
292# they do not have an id attribute.
293# Note: This feature currently applies only to Markdown headings.
294# Minimum value: 0, maximum value: 99, default value: 0.
295# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
296
297# TOC_INCLUDE_HEADINGS = 0
298
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000299# When enabled doxygen tries to link words that correspond to documented
300# classes, or namespaces to their corresponding documentation. Such a link can
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400301# be prevented in individual cases by putting a % sign in front of the word or
302# globally by setting AUTOLINK_SUPPORT to NO.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000303# The default value is: YES.
304
305AUTOLINK_SUPPORT = YES
306
307# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
308# to include (a tag file for) the STL sources as input, then you should set this
309# tag to YES in order to let doxygen match functions declarations and
310# definitions whose arguments contain STL classes (e.g. func(std::string);
311# versus func(std::string) {}). This also make the inheritance and collaboration
312# diagrams that involve STL classes more complete and accurate.
313# The default value is: NO.
314
315BUILTIN_STL_SUPPORT = YES
316
317# If you use Microsoft's C++/CLI language, you should set this option to YES to
318# enable parsing support.
319# The default value is: NO.
320
321CPP_CLI_SUPPORT = NO
322
323# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
324# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
325# will parse them like normal C++ but will assume all classes use public instead
326# of private inheritance when no explicit protection keyword is present.
327# The default value is: NO.
328
329SIP_SUPPORT = NO
330
331# For Microsoft's IDL there are propget and propput attributes to indicate
332# getter and setter methods for a property. Setting this option to YES will make
333# doxygen to replace the get and set methods by a property in the documentation.
334# This will only work if the methods are indeed getting or setting a simple
335# type. If this is not the case, or you want to show the methods anyway, you
336# should set this option to NO.
337# The default value is: YES.
338
339IDL_PROPERTY_SUPPORT = YES
340
341# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400342# tag is set to YES then doxygen will reuse the documentation of the first
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000343# member in the group (if any) for the other members of the group. By default
344# all members of a group must be documented explicitly.
345# The default value is: NO.
346
347DISTRIBUTE_GROUP_DOC = NO
348
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400349# If one adds a struct or class to a group and this option is enabled, then also
350# any nested class or struct is added to the same group. By default this option
351# is disabled and one has to add nested compounds explicitly via \ingroup.
352# The default value is: NO.
353
354GROUP_NESTED_COMPOUNDS = YES
355
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000356# Set the SUBGROUPING tag to YES to allow class member groups of the same type
357# (for instance a group of public functions) to be put as a subgroup of that
358# type (e.g. under the Public Functions section). Set it to NO to prevent
359# subgrouping. Alternatively, this can be done per class using the
360# \nosubgrouping command.
361# The default value is: YES.
362
363SUBGROUPING = YES
364
365# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
366# are shown inside the group in which they are included (e.g. using \ingroup)
367# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
368# and RTF).
369#
370# Note that this feature does not work in combination with
371# SEPARATE_MEMBER_PAGES.
372# The default value is: NO.
373
374INLINE_GROUPED_CLASSES = NO
375
376# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
377# with only public data fields or simple typedef fields will be shown inline in
378# the documentation of the scope in which they are defined (i.e. file,
379# namespace, or group documentation), provided this scope is documented. If set
380# to NO, structs, classes, and unions are shown on a separate page (for HTML and
381# Man pages) or section (for LaTeX and RTF).
382# The default value is: NO.
383
384INLINE_SIMPLE_STRUCTS = NO
385
386# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
387# enum is documented as struct, union, or enum with the name of the typedef. So
388# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
389# with name TypeT. When disabled the typedef will appear as a member of a file,
390# namespace, or class. And the struct will be named TypeS. This can typically be
391# useful for C code in case the coding convention dictates that all compound
392# types are typedef'ed and only the typedef is referenced, never the tag name.
393# The default value is: NO.
394
395TYPEDEF_HIDES_STRUCT = NO
396
397# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
398# cache is used to resolve symbols given their name and scope. Since this can be
399# an expensive process and often the same symbol appears multiple times in the
400# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
401# doxygen will become slower. If the cache is too large, memory is wasted. The
402# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
403# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
404# symbols. At the end of a run doxygen will report the cache usage and suggest
405# the optimal cache size from a speed point of view.
406# Minimum value: 0, maximum value: 9, default value: 0.
407
408LOOKUP_CACHE_SIZE = 0
409
410#---------------------------------------------------------------------------
411# Build related configuration options
412#---------------------------------------------------------------------------
413
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400414# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000415# documentation are documented, even if no documentation was available. Private
416# class members and static file members will be hidden unless the
417# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
418# Note: This will also disable the warnings about undocumented members that are
419# normally produced when WARNINGS is set to YES.
420# The default value is: NO.
421
422EXTRACT_ALL = YES
423
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400424# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000425# be included in the documentation.
426# The default value is: NO.
427
428EXTRACT_PRIVATE = NO
429
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400430# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000431# scope will be included in the documentation.
432# The default value is: NO.
433
434EXTRACT_PACKAGE = NO
435
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400436# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000437# included in the documentation.
438# The default value is: NO.
439
Davide Pesavento04566432021-06-07 23:37:05 -0400440EXTRACT_STATIC = NO
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000441
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400442# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
443# locally in source files will be included in the documentation. If set to NO,
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000444# only classes defined in header files are included. Does not have any effect
445# for Java sources.
446# The default value is: YES.
447
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400448EXTRACT_LOCAL_CLASSES = NO
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000449
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400450# This flag is only useful for Objective-C code. If set to YES, local methods,
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000451# which are defined in the implementation section but not in the interface are
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400452# included in the documentation. If set to NO, only methods in the interface are
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000453# included.
454# The default value is: NO.
455
456EXTRACT_LOCAL_METHODS = NO
457
458# If this flag is set to YES, the members of anonymous namespaces will be
459# extracted and appear in the documentation as a namespace called
460# 'anonymous_namespace{file}', where file will be replaced with the base name of
461# the file that contains the anonymous namespace. By default anonymous namespace
462# are hidden.
463# The default value is: NO.
464
465EXTRACT_ANON_NSPACES = NO
466
467# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
468# undocumented members inside documented classes or files. If set to NO these
469# members will be included in the various overviews, but no documentation
470# section is generated. This option has no effect if EXTRACT_ALL is enabled.
471# The default value is: NO.
472
473HIDE_UNDOC_MEMBERS = NO
474
475# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
476# undocumented classes that are normally visible in the class hierarchy. If set
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400477# to NO, these classes will be included in the various overviews. This option
478# has no effect if EXTRACT_ALL is enabled.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000479# The default value is: NO.
480
481HIDE_UNDOC_CLASSES = NO
482
483# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400484# (class|struct|union) declarations. If set to NO, these declarations will be
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000485# included in the documentation.
486# The default value is: NO.
487
488HIDE_FRIEND_COMPOUNDS = NO
489
490# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400491# documentation blocks found inside the body of a function. If set to NO, these
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000492# blocks will be appended to the function's detailed documentation block.
493# The default value is: NO.
494
495HIDE_IN_BODY_DOCS = NO
496
497# The INTERNAL_DOCS tag determines if documentation that is typed after a
498# \internal command is included. If the tag is set to NO then the documentation
499# will be excluded. Set it to YES to include the internal documentation.
500# The default value is: NO.
501
502INTERNAL_DOCS = NO
503
504# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400505# names in lower-case letters. If set to YES, upper-case letters are also
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000506# allowed. This is useful if you have classes or files whose names only differ
507# in case and if your file system supports case sensitive file names. Windows
508# and Mac users are advised to set this option to NO.
509# The default value is: system dependent.
510
511CASE_SENSE_NAMES = YES
512
513# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400514# their full class and namespace scopes in the documentation. If set to YES, the
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000515# scope will be hidden.
516# The default value is: NO.
517
518HIDE_SCOPE_NAMES = NO
519
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400520# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
521# append additional text to a page's title, such as Class Reference. If set to
522# YES the compound reference will be hidden.
523# The default value is: NO.
524
525HIDE_COMPOUND_REFERENCE= NO
526
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000527# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
528# the files that are included by a file in the documentation of that file.
529# The default value is: YES.
530
531SHOW_INCLUDE_FILES = YES
532
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400533# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
534# grouped member an include statement to the documentation, telling the reader
535# which file to include in order to use the member.
536# The default value is: NO.
537
538SHOW_GROUPED_MEMB_INC = NO
539
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000540# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
541# files with double quotes in the documentation rather than with sharp brackets.
542# The default value is: NO.
543
544FORCE_LOCAL_INCLUDES = NO
545
546# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
547# documentation for inline members.
548# The default value is: YES.
549
550INLINE_INFO = YES
551
552# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
553# (detailed) documentation of file and class members alphabetically by member
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400554# name. If set to NO, the members will appear in declaration order.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000555# The default value is: YES.
556
557SORT_MEMBER_DOCS = YES
558
559# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
560# descriptions of file, namespace and class members alphabetically by member
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400561# name. If set to NO, the members will appear in declaration order. Note that
562# this will also influence the order of the classes in the class list.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000563# The default value is: NO.
564
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400565SORT_BRIEF_DOCS = YES
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000566
567# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
568# (brief and detailed) documentation of class members so that constructors and
569# destructors are listed first. If set to NO the constructors will appear in the
570# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
571# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
572# member documentation.
573# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
574# detailed member documentation.
575# The default value is: NO.
576
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400577SORT_MEMBERS_CTORS_1ST = YES
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000578
579# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
580# of group names into alphabetical order. If set to NO the group names will
581# appear in their defined order.
582# The default value is: NO.
583
584SORT_GROUP_NAMES = YES
585
586# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
587# fully-qualified names, including namespaces. If set to NO, the class list will
588# be sorted only by class name, not including the namespace part.
589# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
590# Note: This option applies only to the class list, not to the alphabetical
591# list.
592# The default value is: NO.
593
594SORT_BY_SCOPE_NAME = NO
595
596# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
597# type resolution of all parameters of a function it will reject a match between
598# the prototype and the implementation of a member function even if there is
599# only one candidate or it is obvious which candidate to choose by doing a
600# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
601# accept a match between prototype and implementation in such cases.
602# The default value is: NO.
603
604STRICT_PROTO_MATCHING = NO
605
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400606# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
607# list. This list is created by putting \todo commands in the documentation.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000608# The default value is: YES.
609
610GENERATE_TODOLIST = YES
611
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400612# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
613# list. This list is created by putting \test commands in the documentation.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000614# The default value is: YES.
615
616GENERATE_TESTLIST = YES
617
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400618# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000619# list. This list is created by putting \bug commands in the documentation.
620# The default value is: YES.
621
622GENERATE_BUGLIST = YES
623
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400624# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000625# the deprecated list. This list is created by putting \deprecated commands in
626# the documentation.
627# The default value is: YES.
628
Alexander Afanasyev691c3ce2014-04-23 14:28:04 -0700629GENERATE_DEPRECATEDLIST= YES
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000630
631# The ENABLED_SECTIONS tag can be used to enable conditional documentation
632# sections, marked by \if <section_label> ... \endif and \cond <section_label>
633# ... \endcond blocks.
634
635ENABLED_SECTIONS =
636
637# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
638# initial value of a variable or macro / define can have for it to appear in the
639# documentation. If the initializer consists of more lines than specified here
640# it will be hidden. Use a value of 0 to hide initializers completely. The
641# appearance of the value of individual variables and macros / defines can be
642# controlled using \showinitializer or \hideinitializer command in the
643# documentation regardless of this setting.
644# Minimum value: 0, maximum value: 10000, default value: 30.
645
646MAX_INITIALIZER_LINES = 30
647
648# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400649# the bottom of the documentation of classes and structs. If set to YES, the
650# list will mention the files that were used to generate the documentation.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000651# The default value is: YES.
652
653SHOW_USED_FILES = NO
654
655# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
656# will remove the Files entry from the Quick Index and from the Folder Tree View
657# (if specified).
658# The default value is: YES.
659
660SHOW_FILES = YES
661
662# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
663# page. This will remove the Namespaces entry from the Quick Index and from the
664# Folder Tree View (if specified).
665# The default value is: YES.
666
667SHOW_NAMESPACES = YES
668
669# The FILE_VERSION_FILTER tag can be used to specify a program or script that
670# doxygen should invoke to get the current version for each file (typically from
671# the version control system). Doxygen will invoke the program by executing (via
672# popen()) the command command input-file, where command is the value of the
673# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
674# by doxygen. Whatever the program writes to standard output is used as the file
675# version. For an example see the documentation.
676
677FILE_VERSION_FILTER =
678
679# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
680# by doxygen. The layout file controls the global structure of the generated
681# output files in an output format independent way. To create the layout file
682# that represents doxygen's defaults, run doxygen with the -l option. You can
683# optionally specify a file name after the option, if omitted DoxygenLayout.xml
684# will be used as the name of the layout file.
685#
686# Note that if you run doxygen from a directory containing a file called
687# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
688# tag is left empty.
689
690LAYOUT_FILE =
691
692# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
693# the reference definitions. This must be a list of .bib files. The .bib
694# extension is automatically appended if omitted. This requires the bibtex tool
695# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
696# For LaTeX the style of the bibliography can be controlled using
697# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400698# search path. See also \cite for info how to create references.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000699
700CITE_BIB_FILES =
701
702#---------------------------------------------------------------------------
703# Configuration options related to warning and progress messages
704#---------------------------------------------------------------------------
705
706# The QUIET tag can be used to turn on/off the messages that are generated to
707# standard output by doxygen. If QUIET is set to YES this implies that the
708# messages are off.
709# The default value is: NO.
710
711QUIET = YES
712
713# The WARNINGS tag can be used to turn on/off the warning messages that are
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400714# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000715# this implies that the warnings are on.
716#
717# Tip: Turn warnings on while writing the documentation.
718# The default value is: YES.
719
720WARNINGS = YES
721
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400722# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000723# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
724# will automatically be disabled.
725# The default value is: YES.
726
727WARN_IF_UNDOCUMENTED = YES
728
729# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
730# potential errors in the documentation, such as not documenting some parameters
731# in a documented function, or documenting parameters that don't exist or using
732# markup commands wrongly.
733# The default value is: YES.
734
735WARN_IF_DOC_ERROR = YES
736
737# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
738# are documented, but have no documentation for their parameters or return
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400739# value. If set to NO, doxygen will only warn about wrong or incomplete
740# parameter documentation, but not about the absence of documentation.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000741# The default value is: NO.
742
743WARN_NO_PARAMDOC = YES
744
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400745# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
746# a warning is encountered.
747# The default value is: NO.
748
749WARN_AS_ERROR = NO
750
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000751# The WARN_FORMAT tag determines the format of the warning messages that doxygen
752# can produce. The string should contain the $file, $line, and $text tags, which
753# will be replaced by the file and line number from which the warning originated
754# and the warning text. Optionally the format may contain $version, which will
755# be replaced by the version of the file (if it could be obtained via
756# FILE_VERSION_FILTER)
757# The default value is: $file:$line: $text.
758
759WARN_FORMAT = "$file:$line: $text"
760
761# The WARN_LOGFILE tag can be used to specify a file to which warning and error
762# messages should be written. If left blank the output is written to standard
763# error (stderr).
764
765WARN_LOGFILE =
766
767#---------------------------------------------------------------------------
768# Configuration options related to the input files
769#---------------------------------------------------------------------------
770
771# The INPUT tag is used to specify the files and/or directories that contain
772# documented source files. You may enter file names like myfile.cpp or
773# directories like /usr/src/myproject. Separate the files or directories with
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400774# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000775# Note: If this tag is empty the current directory is searched.
776
Davide Pesavento19442812018-11-23 14:00:04 -0500777INPUT = ndn-cxx
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000778
779# This tag can be used to specify the character encoding of the source files
780# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
781# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
782# documentation (see: http://www.gnu.org/software/libiconv) for the list of
783# possible encodings.
784# The default value is: UTF-8.
785
786INPUT_ENCODING = UTF-8
787
788# If the value of the INPUT tag contains directories, you can use the
789# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400790# *.h) to filter out the source-files in the directories.
791#
792# Note that for custom extensions or not directly supported extensions you also
793# need to set EXTENSION_MAPPING for the extension otherwise the files are not
794# read by doxygen.
795#
796# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
797# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
798# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
799# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
800# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000801
802FILE_PATTERNS =
803
804# The RECURSIVE tag can be used to specify whether or not subdirectories should
805# be searched for input files as well.
806# The default value is: NO.
807
808RECURSIVE = YES
809
810# The EXCLUDE tag can be used to specify files and/or directories that should be
811# excluded from the INPUT source files. This way you can easily exclude a
812# subdirectory from a directory tree whose root is specified with the INPUT tag.
813#
814# Note that relative paths are relative to the directory from which doxygen is
815# run.
816
817EXCLUDE =
818
819# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
820# directories that are symbolic links (a Unix file system feature) are excluded
821# from the input.
822# The default value is: NO.
823
824EXCLUDE_SYMLINKS = NO
825
826# If the value of the INPUT tag contains directories, you can use the
827# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
828# certain files from those directories.
829#
830# Note that the wildcards are matched against the file with absolute path, so to
831# exclude all test directories for example use the pattern */test/*
832
Davide Pesavento81bd6962020-06-17 16:03:23 -0400833EXCLUDE_PATTERNS = */ndn-cxx/impl/* */ndn-cxx/*/impl/* */ndn-cxx/util/nonstd/*
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000834
835# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
836# (namespaces, classes, functions, etc.) that should be excluded from the
837# output. The symbol name can be a fully qualified name, a word, or if the
838# wildcard * is used, a substring. Examples: ANamespace, AClass,
839# AClass::ANamespace, ANamespace::*Test
840#
841# Note that the wildcards are matched against the file with absolute path, so to
842# exclude all test directories use the pattern */test/*
843
844EXCLUDE_SYMBOLS =
845
846# The EXAMPLE_PATH tag can be used to specify one or more files or directories
847# that contain example code fragments that are included (see the \include
848# command).
849
Alexander Afanasyevf2a46222015-09-17 18:01:30 -0700850EXAMPLE_PATH =
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000851
852# If the value of the EXAMPLE_PATH tag contains directories, you can use the
853# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
854# *.h) to filter out the source-files in the directories. If left blank all
855# files are included.
856
857EXAMPLE_PATTERNS =
858
859# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
860# searched for input files to be used with the \include or \dontinclude commands
861# irrespective of the value of the RECURSIVE tag.
862# The default value is: NO.
863
864EXAMPLE_RECURSIVE = YES
865
866# The IMAGE_PATH tag can be used to specify one or more files or directories
867# that contain images that are to be included in the documentation (see the
868# \image command).
869
870IMAGE_PATH =
871
872# The INPUT_FILTER tag can be used to specify a program that doxygen should
873# invoke to filter for each input file. Doxygen will invoke the filter program
874# by executing (via popen()) the command:
875#
876# <filter> <input-file>
877#
878# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
879# name of an input file. Doxygen will then use the output that the filter
880# program writes to standard output. If FILTER_PATTERNS is specified, this tag
881# will be ignored.
882#
883# Note that the filter must not add or remove lines; it is applied before the
884# code is scanned, but not when the output code is generated. If lines are added
885# or removed, the anchors will not be placed correctly.
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400886#
887# Note that for custom extensions or not directly supported extensions you also
888# need to set EXTENSION_MAPPING for the extension otherwise the files are not
889# properly processed by doxygen.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000890
891INPUT_FILTER =
892
893# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
894# basis. Doxygen will compare the file name with each pattern and apply the
895# filter if there is a match. The filters are a list of the form: pattern=filter
896# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
897# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
898# patterns match the file name, INPUT_FILTER is applied.
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400899#
900# Note that for custom extensions or not directly supported extensions you also
901# need to set EXTENSION_MAPPING for the extension otherwise the files are not
902# properly processed by doxygen.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000903
904FILTER_PATTERNS =
905
906# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400907# INPUT_FILTER) will also be used to filter the input files that are used for
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000908# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
909# The default value is: NO.
910
911FILTER_SOURCE_FILES = NO
912
913# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
914# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
915# it is also possible to disable source filtering for a specific pattern using
916# *.ext= (so without naming a filter).
917# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
918
919FILTER_SOURCE_PATTERNS =
920
921# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
922# is part of the input, its contents will be placed on the main page
923# (index.html). This can be useful if you have a project on for instance GitHub
924# and want to reuse the introduction page also for the doxygen output.
925
926USE_MDFILE_AS_MAINPAGE =
927
928#---------------------------------------------------------------------------
929# Configuration options related to source browsing
930#---------------------------------------------------------------------------
931
932# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
933# generated. Documented entities will be cross-referenced with these sources.
934#
935# Note: To get rid of all source code in the generated output, make sure that
936# also VERBATIM_HEADERS is set to NO.
937# The default value is: NO.
938
939SOURCE_BROWSER = YES
940
941# Setting the INLINE_SOURCES tag to YES will include the body of functions,
942# classes and enums directly into the documentation.
943# The default value is: NO.
944
945INLINE_SOURCES = NO
946
947# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
948# special comment blocks from generated source code fragments. Normal C, C++ and
949# Fortran comments will always remain visible.
950# The default value is: YES.
951
952STRIP_CODE_COMMENTS = YES
953
954# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
955# function all documented functions referencing it will be listed.
956# The default value is: NO.
957
958REFERENCED_BY_RELATION = NO
959
960# If the REFERENCES_RELATION tag is set to YES then for each documented function
961# all documented entities called/used by that function will be listed.
962# The default value is: NO.
963
964REFERENCES_RELATION = NO
965
966# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400967# to YES then the hyperlinks from functions in REFERENCES_RELATION and
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000968# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
969# link to the documentation.
970# The default value is: YES.
971
972REFERENCES_LINK_SOURCE = YES
973
974# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
975# source code will show a tooltip with additional information such as prototype,
976# brief description and links to the definition and documentation. Since this
977# will make the HTML file larger and loading of large files a bit slower, you
978# can opt to disable this feature.
979# The default value is: YES.
980# This tag requires that the tag SOURCE_BROWSER is set to YES.
981
982SOURCE_TOOLTIPS = YES
983
984# If the USE_HTAGS tag is set to YES then the references to source code will
985# point to the HTML generated by the htags(1) tool instead of doxygen built-in
986# source browser. The htags tool is part of GNU's global source tagging system
987# (see http://www.gnu.org/software/global/global.html). You will need version
988# 4.8.6 or higher.
989#
990# To use it do the following:
991# - Install the latest version of global
992# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
993# - Make sure the INPUT points to the root of the source tree
994# - Run doxygen as normal
995#
996# Doxygen will invoke htags (and that will in turn invoke gtags), so these
997# tools must be available from the command line (i.e. in the search path).
998#
999# The result: instead of the source browser generated by doxygen, the links to
1000# source code will now point to the output of htags.
1001# The default value is: NO.
1002# This tag requires that the tag SOURCE_BROWSER is set to YES.
1003
1004USE_HTAGS = NO
1005
1006# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1007# verbatim copy of the header file for each class for which an include is
1008# specified. Set to NO to disable this.
1009# See also: Section \class.
1010# The default value is: YES.
1011
1012VERBATIM_HEADERS = YES
1013
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001014# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1015# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1016# cost of reduced performance. This can be particularly helpful with template
1017# rich C++ code for which doxygen's built-in parser lacks the necessary type
1018# information.
1019# Note: The availability of this option depends on whether or not doxygen was
1020# generated with the -Duse-libclang=ON option for CMake.
1021# The default value is: NO.
1022
1023# CLANG_ASSISTED_PARSING = NO
1024
1025# If clang assisted parsing is enabled you can provide the compiler with command
1026# line options that you would normally use when invoking the compiler. Note that
1027# the include paths will already be set by doxygen for the files and directories
1028# specified with INPUT and INCLUDE_PATH.
1029# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1030
1031# CLANG_OPTIONS =
1032
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001033#---------------------------------------------------------------------------
1034# Configuration options related to the alphabetical class index
1035#---------------------------------------------------------------------------
1036
1037# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1038# compounds will be generated. Enable this if the project contains a lot of
1039# classes, structs, unions or interfaces.
1040# The default value is: YES.
1041
1042ALPHABETICAL_INDEX = YES
1043
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001044# In case all classes in a project start with a common prefix, all classes will
1045# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1046# can be used to specify a prefix (or a list of prefixes) that should be ignored
1047# while generating the index headers.
1048# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1049
1050IGNORE_PREFIX =
1051
1052#---------------------------------------------------------------------------
1053# Configuration options related to the HTML output
1054#---------------------------------------------------------------------------
1055
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001056# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001057# The default value is: YES.
1058
1059GENERATE_HTML = YES
1060
1061# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1062# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1063# it.
1064# The default directory is: html.
1065# This tag requires that the tag GENERATE_HTML is set to YES.
1066
1067HTML_OUTPUT = ./
1068
1069# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1070# generated HTML page (for example: .htm, .php, .asp).
1071# The default value is: .html.
1072# This tag requires that the tag GENERATE_HTML is set to YES.
1073
1074HTML_FILE_EXTENSION = .html
1075
1076# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1077# each generated HTML page. If the tag is left blank doxygen will generate a
1078# standard header.
1079#
1080# To get valid HTML the header file that includes any scripts and style sheets
1081# that doxygen needs, which is dependent on the configuration options used (e.g.
1082# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1083# default header using
1084# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1085# YourConfigFile
1086# and then modify the file new_header.html. See also section "Doxygen usage"
1087# for information on how to generate the default header that doxygen normally
1088# uses.
1089# Note: The header is subject to change so you typically have to regenerate the
1090# default header when upgrading to a newer version of doxygen. For a description
1091# of the possible markers and block names see the documentation.
1092# This tag requires that the tag GENERATE_HTML is set to YES.
1093
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07001094HTML_HEADER = ../docs/named_data_theme/named_data_header.html
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001095
1096# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1097# generated HTML page. If the tag is left blank doxygen will generate a standard
1098# footer. See HTML_HEADER for more information on how to generate a default
1099# footer and what special commands can be used inside the footer. See also
1100# section "Doxygen usage" for information on how to generate the default footer
1101# that doxygen normally uses.
1102# This tag requires that the tag GENERATE_HTML is set to YES.
1103
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -07001104HTML_FOOTER = @HTML_FOOTER@
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001105
1106# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1107# sheet that is used by each HTML page. It can be used to fine-tune the look of
1108# the HTML output. If left blank doxygen will generate a default style sheet.
1109# See also section "Doxygen usage" for information on how to generate the style
1110# sheet that doxygen normally uses.
1111# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1112# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1113# obsolete.
1114# This tag requires that the tag GENERATE_HTML is set to YES.
1115
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07001116HTML_STYLESHEET = ../docs/named_data_theme/static/named_data_doxygen.css
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001117
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001118# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1119# cascading style sheets that are included after the standard style sheets
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001120# created by doxygen. Using this option one can overrule certain style aspects.
1121# This is preferred over using HTML_STYLESHEET since it does not replace the
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001122# standard style sheet and is therefore more robust against future updates.
1123# Doxygen will copy the style sheet files to the output directory.
1124# Note: The order of the extra style sheet files is of importance (e.g. the last
1125# style sheet in the list overrules the setting of the previous ones in the
1126# list). For an example see the documentation.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001127# This tag requires that the tag GENERATE_HTML is set to YES.
1128
1129HTML_EXTRA_STYLESHEET =
1130
1131# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1132# other source files which should be copied to the HTML output directory. Note
1133# that these files will be copied to the base HTML output directory. Use the
1134# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1135# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1136# files will be copied as-is; there are no commands or markers available.
1137# This tag requires that the tag GENERATE_HTML is set to YES.
1138
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07001139HTML_EXTRA_FILES = ../docs/named_data_theme/static/doxygen.css \
1140 ../docs/named_data_theme/static/base.css \
1141 ../docs/named_data_theme/static/foundation.css \
1142 ../docs/named_data_theme/static/bar-top.png
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001143
1144# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001145# will adjust the colors in the style sheet and background images according to
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001146# this color. Hue is specified as an angle on a colorwheel, see
1147# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1148# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1149# purple, and 360 is red again.
1150# Minimum value: 0, maximum value: 359, default value: 220.
1151# This tag requires that the tag GENERATE_HTML is set to YES.
1152
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07001153HTML_COLORSTYLE_HUE = 0
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001154
1155# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1156# in the HTML output. For a value of 0 the output will use grayscales only. A
1157# value of 255 will produce the most vivid colors.
1158# Minimum value: 0, maximum value: 255, default value: 100.
1159# This tag requires that the tag GENERATE_HTML is set to YES.
1160
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07001161HTML_COLORSTYLE_SAT = 0
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001162
1163# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1164# luminance component of the colors in the HTML output. Values below 100
1165# gradually make the output lighter, whereas values above 100 make the output
1166# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1167# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1168# change the gamma.
1169# Minimum value: 40, maximum value: 240, default value: 80.
1170# This tag requires that the tag GENERATE_HTML is set to YES.
1171
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07001172HTML_COLORSTYLE_GAMMA = 91
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001173
1174# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1175# page will contain the date and time when the page was generated. Setting this
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001176# to YES can help to show when doxygen was last run and thus if the
1177# documentation is up to date.
1178# The default value is: NO.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001179# This tag requires that the tag GENERATE_HTML is set to YES.
1180
1181HTML_TIMESTAMP = YES
1182
1183# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1184# documentation will contain sections that can be hidden and shown after the
1185# page has loaded.
1186# The default value is: NO.
1187# This tag requires that the tag GENERATE_HTML is set to YES.
1188
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001189HTML_DYNAMIC_SECTIONS = YES
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001190
1191# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1192# shown in the various tree structured indices initially; the user can expand
1193# and collapse entries dynamically later on. Doxygen will expand the tree to
1194# such a level that at most the specified number of entries are visible (unless
1195# a fully collapsed tree already exceeds this amount). So setting the number of
1196# entries 1 will produce a full collapsed tree by default. 0 is a special value
1197# representing an infinite number of entries and will result in a full expanded
1198# tree by default.
1199# Minimum value: 0, maximum value: 9999, default value: 100.
1200# This tag requires that the tag GENERATE_HTML is set to YES.
1201
1202HTML_INDEX_NUM_ENTRIES = 100
1203
1204# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1205# generated that can be used as input for Apple's Xcode 3 integrated development
1206# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1207# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1208# Makefile in the HTML output directory. Running make will produce the docset in
1209# that directory and running make install will install the docset in
1210# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1211# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1212# for more information.
1213# The default value is: NO.
1214# This tag requires that the tag GENERATE_HTML is set to YES.
1215
1216GENERATE_DOCSET = NO
1217
1218# This tag determines the name of the docset feed. A documentation feed provides
1219# an umbrella under which multiple documentation sets from a single provider
1220# (such as a company or product suite) can be grouped.
1221# The default value is: Doxygen generated docs.
1222# This tag requires that the tag GENERATE_DOCSET is set to YES.
1223
1224DOCSET_FEEDNAME = "Doxygen generated docs"
1225
1226# This tag specifies a string that should uniquely identify the documentation
1227# set bundle. This should be a reverse domain-name style string, e.g.
1228# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1229# The default value is: org.doxygen.Project.
1230# This tag requires that the tag GENERATE_DOCSET is set to YES.
1231
1232DOCSET_BUNDLE_ID = org.doxygen.Project
1233
1234# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1235# the documentation publisher. This should be a reverse domain-name style
1236# string, e.g. com.mycompany.MyDocSet.documentation.
1237# The default value is: org.doxygen.Publisher.
1238# This tag requires that the tag GENERATE_DOCSET is set to YES.
1239
1240DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1241
1242# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1243# The default value is: Publisher.
1244# This tag requires that the tag GENERATE_DOCSET is set to YES.
1245
1246DOCSET_PUBLISHER_NAME = Publisher
1247
1248# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1249# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1250# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1251# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1252# Windows.
1253#
1254# The HTML Help Workshop contains a compiler that can convert all HTML output
1255# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1256# files are now used as the Windows 98 help format, and will replace the old
1257# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1258# HTML files also contain an index, a table of contents, and you can search for
1259# words in the documentation. The HTML workshop also contains a viewer for
1260# compressed HTML files.
1261# The default value is: NO.
1262# This tag requires that the tag GENERATE_HTML is set to YES.
1263
1264GENERATE_HTMLHELP = NO
1265
1266# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1267# file. You can add a path in front of the file if the result should not be
1268# written to the html output directory.
1269# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1270
1271CHM_FILE =
1272
1273# The HHC_LOCATION tag can be used to specify the location (absolute path
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001274# including file name) of the HTML help compiler (hhc.exe). If non-empty,
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001275# doxygen will try to run the HTML help compiler on the generated index.hhp.
1276# The file has to be specified with full path.
1277# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1278
1279HHC_LOCATION =
1280
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001281# The GENERATE_CHI flag controls if a separate .chi index file is generated
1282# (YES) or that it should be included in the master .chm file (NO).
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001283# The default value is: NO.
1284# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1285
1286GENERATE_CHI = NO
1287
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001288# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001289# and project file content.
1290# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1291
1292CHM_INDEX_ENCODING =
1293
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001294# The BINARY_TOC flag controls whether a binary table of contents is generated
1295# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1296# enables the Previous and Next buttons.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001297# The default value is: NO.
1298# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1299
1300BINARY_TOC = NO
1301
1302# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1303# the table of contents of the HTML help documentation and to the tree view.
1304# The default value is: NO.
1305# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1306
1307TOC_EXPAND = NO
1308
1309# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1310# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1311# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1312# (.qch) of the generated HTML documentation.
1313# The default value is: NO.
1314# This tag requires that the tag GENERATE_HTML is set to YES.
1315
1316GENERATE_QHP = NO
1317
1318# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1319# the file name of the resulting .qch file. The path specified is relative to
1320# the HTML output folder.
1321# This tag requires that the tag GENERATE_QHP is set to YES.
1322
1323QCH_FILE =
1324
1325# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1326# Project output. For more information please see Qt Help Project / Namespace
1327# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1328# The default value is: org.doxygen.Project.
1329# This tag requires that the tag GENERATE_QHP is set to YES.
1330
1331QHP_NAMESPACE = org.doxygen.Project
1332
1333# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1334# Help Project output. For more information please see Qt Help Project / Virtual
1335# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1336# folders).
1337# The default value is: doc.
1338# This tag requires that the tag GENERATE_QHP is set to YES.
1339
1340QHP_VIRTUAL_FOLDER = doc
1341
1342# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1343# filter to add. For more information please see Qt Help Project / Custom
1344# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1345# filters).
1346# This tag requires that the tag GENERATE_QHP is set to YES.
1347
1348QHP_CUST_FILTER_NAME =
1349
1350# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1351# custom filter to add. For more information please see Qt Help Project / Custom
1352# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1353# filters).
1354# This tag requires that the tag GENERATE_QHP is set to YES.
1355
1356QHP_CUST_FILTER_ATTRS =
1357
1358# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1359# project's filter section matches. Qt Help Project / Filter Attributes (see:
1360# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1361# This tag requires that the tag GENERATE_QHP is set to YES.
1362
1363QHP_SECT_FILTER_ATTRS =
1364
1365# The QHG_LOCATION tag can be used to specify the location of Qt's
1366# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1367# generated .qhp file.
1368# This tag requires that the tag GENERATE_QHP is set to YES.
1369
1370QHG_LOCATION =
1371
1372# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1373# generated, together with the HTML files, they form an Eclipse help plugin. To
1374# install this plugin and make it available under the help contents menu in
1375# Eclipse, the contents of the directory containing the HTML and XML files needs
1376# to be copied into the plugins directory of eclipse. The name of the directory
1377# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1378# After copying Eclipse needs to be restarted before the help appears.
1379# The default value is: NO.
1380# This tag requires that the tag GENERATE_HTML is set to YES.
1381
1382GENERATE_ECLIPSEHELP = NO
1383
1384# A unique identifier for the Eclipse help plugin. When installing the plugin
1385# the directory name containing the HTML and XML files should also have this
1386# name. Each documentation set should have its own identifier.
1387# The default value is: org.doxygen.Project.
1388# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1389
1390ECLIPSE_DOC_ID = org.doxygen.Project
1391
1392# If you want full control over the layout of the generated HTML pages it might
1393# be necessary to disable the index and replace it with your own. The
1394# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1395# of each HTML page. A value of NO enables the index and the value YES disables
1396# it. Since the tabs in the index contain the same information as the navigation
1397# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1398# The default value is: NO.
1399# This tag requires that the tag GENERATE_HTML is set to YES.
1400
1401DISABLE_INDEX = NO
1402
1403# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1404# structure should be generated to display hierarchical information. If the tag
1405# value is set to YES, a side panel will be generated containing a tree-like
1406# index structure (just like the one that is generated for HTML Help). For this
1407# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1408# (i.e. any modern browser). Windows users are probably better off using the
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001409# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001410# further fine-tune the look of the index. As an example, the default style
1411# sheet generated by doxygen has an example that shows how to put an image at
1412# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1413# the same information as the tab index, you could consider setting
1414# DISABLE_INDEX to YES when enabling this option.
1415# The default value is: NO.
1416# This tag requires that the tag GENERATE_HTML is set to YES.
1417
1418GENERATE_TREEVIEW = YES
1419
1420# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1421# doxygen will group on one line in the generated HTML documentation.
1422#
1423# Note that a value of 0 will completely suppress the enum values from appearing
1424# in the overview section.
1425# Minimum value: 0, maximum value: 20, default value: 4.
1426# This tag requires that the tag GENERATE_HTML is set to YES.
1427
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001428ENUM_VALUES_PER_LINE = 1
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001429
1430# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1431# to set the initial width (in pixels) of the frame in which the tree is shown.
1432# Minimum value: 0, maximum value: 1500, default value: 250.
1433# This tag requires that the tag GENERATE_HTML is set to YES.
1434
1435TREEVIEW_WIDTH = 250
1436
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001437# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001438# external symbols imported via tag files in a separate window.
1439# The default value is: NO.
1440# This tag requires that the tag GENERATE_HTML is set to YES.
1441
1442EXT_LINKS_IN_WINDOW = NO
1443
1444# Use this tag to change the font size of LaTeX formulas included as images in
1445# the HTML documentation. When you change the font size after a successful
1446# doxygen run you need to manually remove any form_*.png images from the HTML
1447# output directory to force them to be regenerated.
1448# Minimum value: 8, maximum value: 50, default value: 10.
1449# This tag requires that the tag GENERATE_HTML is set to YES.
1450
1451FORMULA_FONTSIZE = 10
1452
1453# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1454# generated for formulas are transparent PNGs. Transparent PNGs are not
1455# supported properly for IE 6.0, but are supported on all modern browsers.
1456#
1457# Note that when changing this option you need to delete any form_*.png files in
1458# the HTML output directory before the changes have effect.
1459# The default value is: YES.
1460# This tag requires that the tag GENERATE_HTML is set to YES.
1461
1462FORMULA_TRANSPARENT = YES
1463
1464# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1465# http://www.mathjax.org) which uses client side Javascript for the rendering
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001466# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001467# installed or if you want to formulas look prettier in the HTML output. When
1468# enabled you may also need to install MathJax separately and configure the path
1469# to it using the MATHJAX_RELPATH option.
1470# The default value is: NO.
1471# This tag requires that the tag GENERATE_HTML is set to YES.
1472
1473USE_MATHJAX = NO
1474
1475# When MathJax is enabled you can set the default output format to be used for
1476# the MathJax output. See the MathJax site (see:
1477# http://docs.mathjax.org/en/latest/output.html) for more details.
1478# Possible values are: HTML-CSS (which is slower, but has the best
1479# compatibility), NativeMML (i.e. MathML) and SVG.
1480# The default value is: HTML-CSS.
1481# This tag requires that the tag USE_MATHJAX is set to YES.
1482
1483MATHJAX_FORMAT = HTML-CSS
1484
1485# When MathJax is enabled you need to specify the location relative to the HTML
1486# output directory using the MATHJAX_RELPATH option. The destination directory
1487# should contain the MathJax.js script. For instance, if the mathjax directory
1488# is located at the same level as the HTML output directory, then
1489# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1490# Content Delivery Network so you can quickly see the result without installing
1491# MathJax. However, it is strongly recommended to install a local copy of
1492# MathJax from http://www.mathjax.org before deployment.
1493# The default value is: http://cdn.mathjax.org/mathjax/latest.
1494# This tag requires that the tag USE_MATHJAX is set to YES.
1495
1496MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1497
1498# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1499# extension names that should be enabled during MathJax rendering. For example
1500# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1501# This tag requires that the tag USE_MATHJAX is set to YES.
1502
1503MATHJAX_EXTENSIONS =
1504
1505# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1506# of code that will be used on startup of the MathJax code. See the MathJax site
1507# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1508# example see the documentation.
1509# This tag requires that the tag USE_MATHJAX is set to YES.
1510
1511MATHJAX_CODEFILE =
1512
1513# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1514# the HTML output. The underlying search engine uses javascript and DHTML and
1515# should work on any modern browser. Note that when using HTML help
1516# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1517# there is already a search function so this one should typically be disabled.
1518# For large projects the javascript based search engine can be slow, then
1519# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1520# search using the keyboard; to jump to the search box use <access key> + S
1521# (what the <access key> is depends on the OS and browser, but it is typically
1522# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1523# key> to jump into the search results window, the results can be navigated
1524# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1525# the search. The filter options can be selected when the cursor is inside the
1526# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1527# to select a filter and <Enter> or <escape> to activate or cancel the filter
1528# option.
1529# The default value is: YES.
1530# This tag requires that the tag GENERATE_HTML is set to YES.
1531
1532SEARCHENGINE = YES
1533
1534# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1535# implemented using a web server instead of a web client using Javascript. There
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001536# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1537# setting. When disabled, doxygen will generate a PHP script for searching and
1538# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1539# and searching needs to be provided by external tools. See the section
1540# "External Indexing and Searching" for details.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001541# The default value is: NO.
1542# This tag requires that the tag SEARCHENGINE is set to YES.
1543
1544SERVER_BASED_SEARCH = NO
1545
1546# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1547# script for searching. Instead the search results are written to an XML file
1548# which needs to be processed by an external indexer. Doxygen will invoke an
1549# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1550# search results.
1551#
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001552# Doxygen ships with an example indexer (doxyindexer) and search engine
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001553# (doxysearch.cgi) which are based on the open source search engine library
1554# Xapian (see: http://xapian.org/).
1555#
1556# See the section "External Indexing and Searching" for details.
1557# The default value is: NO.
1558# This tag requires that the tag SEARCHENGINE is set to YES.
1559
1560EXTERNAL_SEARCH = NO
1561
1562# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1563# which will return the search results when EXTERNAL_SEARCH is enabled.
1564#
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001565# Doxygen ships with an example indexer (doxyindexer) and search engine
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001566# (doxysearch.cgi) which are based on the open source search engine library
1567# Xapian (see: http://xapian.org/). See the section "External Indexing and
1568# Searching" for details.
1569# This tag requires that the tag SEARCHENGINE is set to YES.
1570
1571SEARCHENGINE_URL =
1572
1573# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1574# search data is written to a file for indexing by an external tool. With the
1575# SEARCHDATA_FILE tag the name of this file can be specified.
1576# The default file is: searchdata.xml.
1577# This tag requires that the tag SEARCHENGINE is set to YES.
1578
1579SEARCHDATA_FILE = searchdata.xml
1580
1581# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1582# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1583# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1584# projects and redirect the results back to the right project.
1585# This tag requires that the tag SEARCHENGINE is set to YES.
1586
1587EXTERNAL_SEARCH_ID =
1588
1589# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1590# projects other than the one defined by this configuration file, but that are
1591# all added to the same external search index. Each project needs to have a
1592# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1593# to a relative location where the documentation can be found. The format is:
1594# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1595# This tag requires that the tag SEARCHENGINE is set to YES.
1596
1597EXTRA_SEARCH_MAPPINGS =
1598
1599#---------------------------------------------------------------------------
1600# Configuration options related to the LaTeX output
1601#---------------------------------------------------------------------------
1602
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001603# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001604# The default value is: YES.
1605
1606GENERATE_LATEX = NO
1607
1608# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1609# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1610# it.
1611# The default directory is: latex.
1612# This tag requires that the tag GENERATE_LATEX is set to YES.
1613
1614LATEX_OUTPUT = latex
1615
1616# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1617# invoked.
1618#
1619# Note that when enabling USE_PDFLATEX this option is only used for generating
1620# bitmaps for formulas in the HTML output, but not in the Makefile that is
1621# written to the output directory.
1622# The default file is: latex.
1623# This tag requires that the tag GENERATE_LATEX is set to YES.
1624
1625LATEX_CMD_NAME = latex
1626
1627# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1628# index for LaTeX.
1629# The default file is: makeindex.
1630# This tag requires that the tag GENERATE_LATEX is set to YES.
1631
1632MAKEINDEX_CMD_NAME = makeindex
1633
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001634# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001635# documents. This may be useful for small projects and may help to save some
1636# trees in general.
1637# The default value is: NO.
1638# This tag requires that the tag GENERATE_LATEX is set to YES.
1639
1640COMPACT_LATEX = NO
1641
1642# The PAPER_TYPE tag can be used to set the paper type that is used by the
1643# printer.
1644# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1645# 14 inches) and executive (7.25 x 10.5 inches).
1646# The default value is: a4.
1647# This tag requires that the tag GENERATE_LATEX is set to YES.
1648
1649PAPER_TYPE = a4
1650
1651# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001652# that should be included in the LaTeX output. The package can be specified just
1653# by its name or with the correct syntax as to be used with the LaTeX
1654# \usepackage command. To get the times font for instance you can specify :
1655# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1656# To use the option intlimits with the amsmath package you can specify:
1657# EXTRA_PACKAGES=[intlimits]{amsmath}
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001658# If left blank no extra packages will be included.
1659# This tag requires that the tag GENERATE_LATEX is set to YES.
1660
1661EXTRA_PACKAGES =
1662
1663# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1664# generated LaTeX document. The header should contain everything until the first
1665# chapter. If it is left blank doxygen will generate a standard header. See
1666# section "Doxygen usage" for information on how to let doxygen write the
1667# default header to a separate file.
1668#
1669# Note: Only use a user-defined header if you know what you are doing! The
1670# following commands have a special meaning inside the header: $title,
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001671# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1672# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1673# string, for the replacement values of the other commands the user is referred
1674# to HTML_HEADER.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001675# This tag requires that the tag GENERATE_LATEX is set to YES.
1676
1677LATEX_HEADER =
1678
1679# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1680# generated LaTeX document. The footer should contain everything after the last
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001681# chapter. If it is left blank doxygen will generate a standard footer. See
1682# LATEX_HEADER for more information on how to generate a default footer and what
1683# special commands can be used inside the footer.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001684#
1685# Note: Only use a user-defined footer if you know what you are doing!
1686# This tag requires that the tag GENERATE_LATEX is set to YES.
1687
1688LATEX_FOOTER =
1689
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001690# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1691# LaTeX style sheets that are included after the standard style sheets created
1692# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1693# will copy the style sheet files to the output directory.
1694# Note: The order of the extra style sheet files is of importance (e.g. the last
1695# style sheet in the list overrules the setting of the previous ones in the
1696# list).
1697# This tag requires that the tag GENERATE_LATEX is set to YES.
1698
1699LATEX_EXTRA_STYLESHEET =
1700
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001701# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1702# other source files which should be copied to the LATEX_OUTPUT output
1703# directory. Note that the files will be copied as-is; there are no commands or
1704# markers available.
1705# This tag requires that the tag GENERATE_LATEX is set to YES.
1706
1707LATEX_EXTRA_FILES =
1708
1709# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1710# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1711# contain links (just like the HTML output) instead of page references. This
1712# makes the output suitable for online browsing using a PDF viewer.
1713# The default value is: YES.
1714# This tag requires that the tag GENERATE_LATEX is set to YES.
1715
1716PDF_HYPERLINKS = YES
1717
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001718# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1719# the PDF file directly from the LaTeX files. Set this option to YES, to get a
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001720# higher quality PDF documentation.
1721# The default value is: YES.
1722# This tag requires that the tag GENERATE_LATEX is set to YES.
1723
1724USE_PDFLATEX = YES
1725
1726# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1727# command to the generated LaTeX files. This will instruct LaTeX to keep running
1728# if errors occur, instead of asking the user for help. This option is also used
1729# when generating formulas in HTML.
1730# The default value is: NO.
1731# This tag requires that the tag GENERATE_LATEX is set to YES.
1732
1733LATEX_BATCHMODE = NO
1734
1735# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1736# index chapters (such as File Index, Compound Index, etc.) in the output.
1737# The default value is: NO.
1738# This tag requires that the tag GENERATE_LATEX is set to YES.
1739
1740LATEX_HIDE_INDICES = NO
1741
1742# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1743# code with syntax highlighting in the LaTeX output.
1744#
1745# Note that which sources are shown also depends on other settings such as
1746# SOURCE_BROWSER.
1747# The default value is: NO.
1748# This tag requires that the tag GENERATE_LATEX is set to YES.
1749
1750LATEX_SOURCE_CODE = NO
1751
1752# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1753# bibliography, e.g. plainnat, or ieeetr. See
1754# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1755# The default value is: plain.
1756# This tag requires that the tag GENERATE_LATEX is set to YES.
1757
1758LATEX_BIB_STYLE = plain
1759
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001760# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1761# page will contain the date and time when the page was generated. Setting this
1762# to NO can help when comparing the output of multiple runs.
1763# The default value is: NO.
1764# This tag requires that the tag GENERATE_LATEX is set to YES.
1765
1766LATEX_TIMESTAMP = NO
1767
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001768#---------------------------------------------------------------------------
1769# Configuration options related to the RTF output
1770#---------------------------------------------------------------------------
1771
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001772# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001773# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1774# readers/editors.
1775# The default value is: NO.
1776
1777GENERATE_RTF = NO
1778
1779# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1780# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1781# it.
1782# The default directory is: rtf.
1783# This tag requires that the tag GENERATE_RTF is set to YES.
1784
1785RTF_OUTPUT = rtf
1786
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001787# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001788# documents. This may be useful for small projects and may help to save some
1789# trees in general.
1790# The default value is: NO.
1791# This tag requires that the tag GENERATE_RTF is set to YES.
1792
1793COMPACT_RTF = NO
1794
1795# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1796# contain hyperlink fields. The RTF file will contain links (just like the HTML
1797# output) instead of page references. This makes the output suitable for online
1798# browsing using Word or some other Word compatible readers that support those
1799# fields.
1800#
1801# Note: WordPad (write) and others do not support links.
1802# The default value is: NO.
1803# This tag requires that the tag GENERATE_RTF is set to YES.
1804
1805RTF_HYPERLINKS = NO
1806
1807# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1808# file, i.e. a series of assignments. You only have to provide replacements,
1809# missing definitions are set to their default value.
1810#
1811# See also section "Doxygen usage" for information on how to generate the
1812# default style sheet that doxygen normally uses.
1813# This tag requires that the tag GENERATE_RTF is set to YES.
1814
1815RTF_STYLESHEET_FILE =
1816
1817# Set optional variables used in the generation of an RTF document. Syntax is
1818# similar to doxygen's config file. A template extensions file can be generated
1819# using doxygen -e rtf extensionFile.
1820# This tag requires that the tag GENERATE_RTF is set to YES.
1821
1822RTF_EXTENSIONS_FILE =
1823
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001824# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1825# with syntax highlighting in the RTF output.
1826#
1827# Note that which sources are shown also depends on other settings such as
1828# SOURCE_BROWSER.
1829# The default value is: NO.
1830# This tag requires that the tag GENERATE_RTF is set to YES.
1831
1832RTF_SOURCE_CODE = NO
1833
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001834#---------------------------------------------------------------------------
1835# Configuration options related to the man page output
1836#---------------------------------------------------------------------------
1837
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001838# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001839# classes and files.
1840# The default value is: NO.
1841
1842GENERATE_MAN = NO
1843
1844# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1845# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1846# it. A directory man3 will be created inside the directory specified by
1847# MAN_OUTPUT.
1848# The default directory is: man.
1849# This tag requires that the tag GENERATE_MAN is set to YES.
1850
1851MAN_OUTPUT = man
1852
1853# The MAN_EXTENSION tag determines the extension that is added to the generated
1854# man pages. In case the manual section does not start with a number, the number
1855# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1856# optional.
1857# The default value is: .3.
1858# This tag requires that the tag GENERATE_MAN is set to YES.
1859
1860MAN_EXTENSION = .3
1861
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001862# The MAN_SUBDIR tag determines the name of the directory created within
1863# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1864# MAN_EXTENSION with the initial . removed.
1865# This tag requires that the tag GENERATE_MAN is set to YES.
1866
1867MAN_SUBDIR =
1868
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001869# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1870# will generate one additional man file for each entity documented in the real
1871# man page(s). These additional files only source the real man page, but without
1872# them the man command would be unable to find the correct page.
1873# The default value is: NO.
1874# This tag requires that the tag GENERATE_MAN is set to YES.
1875
1876MAN_LINKS = NO
1877
1878#---------------------------------------------------------------------------
1879# Configuration options related to the XML output
1880#---------------------------------------------------------------------------
1881
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001882# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001883# captures the structure of the code including all documentation.
1884# The default value is: NO.
1885
1886GENERATE_XML = NO
1887
1888# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1889# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1890# it.
1891# The default directory is: xml.
1892# This tag requires that the tag GENERATE_XML is set to YES.
1893
1894XML_OUTPUT = xml
1895
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001896# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001897# listings (including syntax highlighting and cross-referencing information) to
1898# the XML output. Note that enabling this will significantly increase the size
1899# of the XML output.
1900# The default value is: YES.
1901# This tag requires that the tag GENERATE_XML is set to YES.
1902
1903XML_PROGRAMLISTING = YES
1904
1905#---------------------------------------------------------------------------
1906# Configuration options related to the DOCBOOK output
1907#---------------------------------------------------------------------------
1908
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001909# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001910# that can be used to generate PDF.
1911# The default value is: NO.
1912
1913GENERATE_DOCBOOK = NO
1914
1915# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1916# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1917# front of it.
1918# The default directory is: docbook.
1919# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1920
1921DOCBOOK_OUTPUT = docbook
1922
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001923# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1924# program listings (including syntax highlighting and cross-referencing
1925# information) to the DOCBOOK output. Note that enabling this will significantly
1926# increase the size of the DOCBOOK output.
1927# The default value is: NO.
1928# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1929
1930DOCBOOK_PROGRAMLISTING = NO
1931
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001932#---------------------------------------------------------------------------
1933# Configuration options for the AutoGen Definitions output
1934#---------------------------------------------------------------------------
1935
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001936# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1937# AutoGen Definitions (see http://autogen.sf.net) file that captures the
1938# structure of the code including all documentation. Note that this feature is
1939# still experimental and incomplete at the moment.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001940# The default value is: NO.
1941
1942GENERATE_AUTOGEN_DEF = NO
1943
1944#---------------------------------------------------------------------------
1945# Configuration options related to the Perl module output
1946#---------------------------------------------------------------------------
1947
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001948# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001949# file that captures the structure of the code including all documentation.
1950#
1951# Note that this feature is still experimental and incomplete at the moment.
1952# The default value is: NO.
1953
1954GENERATE_PERLMOD = NO
1955
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001956# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001957# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1958# output from the Perl module output.
1959# The default value is: NO.
1960# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1961
1962PERLMOD_LATEX = NO
1963
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001964# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001965# formatted so it can be parsed by a human reader. This is useful if you want to
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001966# understand what is going on. On the other hand, if this tag is set to NO, the
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001967# size of the Perl module output will be much smaller and Perl will parse it
1968# just the same.
1969# The default value is: YES.
1970# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1971
1972PERLMOD_PRETTY = YES
1973
1974# The names of the make variables in the generated doxyrules.make file are
1975# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1976# so different doxyrules.make files included by the same Makefile don't
1977# overwrite each other's variables.
1978# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1979
1980PERLMOD_MAKEVAR_PREFIX =
1981
1982#---------------------------------------------------------------------------
1983# Configuration options related to the preprocessor
1984#---------------------------------------------------------------------------
1985
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001986# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001987# C-preprocessor directives found in the sources and include files.
1988# The default value is: YES.
1989
1990ENABLE_PREPROCESSING = YES
1991
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001992# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
1993# in the source code. If set to NO, only conditional compilation will be
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001994# performed. Macro expansion can be done in a controlled way by setting
1995# EXPAND_ONLY_PREDEF to YES.
1996# The default value is: NO.
1997# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1998
Yingdi Yu0eb5d722014-06-10 15:06:25 -07001999MACRO_EXPANSION = YES
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002000
2001# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2002# the macro expansion is limited to the macros specified with the PREDEFINED and
2003# EXPAND_AS_DEFINED tags.
2004# The default value is: NO.
2005# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2006
2007EXPAND_ONLY_PREDEF = NO
2008
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002009# If the SEARCH_INCLUDES tag is set to YES, the include files in the
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002010# INCLUDE_PATH will be searched if a #include is found.
2011# The default value is: YES.
2012# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2013
2014SEARCH_INCLUDES = YES
2015
2016# The INCLUDE_PATH tag can be used to specify one or more directories that
2017# contain include files that are not input files but should be processed by the
2018# preprocessor.
2019# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2020
Davide Pesavento7e780642018-11-24 15:51:34 -05002021INCLUDE_PATH = ..
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002022
2023# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2024# patterns (like *.h and *.hpp) to filter out the header-files in the
2025# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2026# used.
2027# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2028
2029INCLUDE_FILE_PATTERNS =
2030
2031# The PREDEFINED tag can be used to specify one or more macro names that are
2032# defined before the preprocessor is started (similar to the -D option of e.g.
2033# gcc). The argument of the tag is a list of macros of the form: name or
2034# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2035# is assumed. To prevent a macro definition from being undefined via #undef or
2036# recursively expanded use the := operator instead of the = operator.
2037# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2038
Alexander Afanasyev5946ed12015-01-19 23:41:39 -08002039PREDEFINED = DOXYGEN \
Davide Pesavento1fd00242018-05-20 00:11:01 -04002040 BOOST_CONCEPT_ASSERT(x)= \
2041 BOOST_CONCEPT_REQUIRES(x)= \
Davide Pesavento88a0d812017-08-19 21:31:42 -04002042 NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(x)= \
2043 NDN_LOG_INIT(x)= \
Davide Pesavento1fd00242018-05-20 00:11:01 -04002044 NDN_LOG_MEMBER_DECL()= \
2045 NDN_LOG_MEMBER_DECL_SPECIALIZED(x)= \
2046 NDN_LOG_MEMBER_INIT(x,y)= \
2047 NDN_LOG_MEMBER_INIT_SPECIALIZED(x,y)= \
Davide Pesavento38912442019-04-06 22:03:39 -04002048 NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PROTECTED=protected \
2049 NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE=private \
2050 NDN_CXX_PROTECTED_WITH_TESTS_ELSE_PRIVATE=private \
2051 NDN_CXX_VIRTUAL_WITH_TESTS=
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002052
2053# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2054# tag can be used to specify a list of macro names that should be expanded. The
2055# macro definition that is found in the sources will be used. Use the PREDEFINED
2056# tag if you want to use a different macro definition that overrules the
2057# definition found in the source code.
2058# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2059
2060EXPAND_AS_DEFINED =
2061
2062# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002063# remove all references to function-like macros that are alone on a line, have
2064# an all uppercase name, and do not end with a semicolon. Such function macros
2065# are typically used for boiler-plate code, and will confuse the parser if not
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002066# removed.
2067# The default value is: YES.
2068# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2069
2070SKIP_FUNCTION_MACROS = YES
2071
2072#---------------------------------------------------------------------------
2073# Configuration options related to external references
2074#---------------------------------------------------------------------------
2075
2076# The TAGFILES tag can be used to specify one or more tag files. For each tag
2077# file the location of the external documentation should be added. The format of
2078# a tag file without this location is as follows:
2079# TAGFILES = file1 file2 ...
2080# Adding location for the tag files is done as follows:
2081# TAGFILES = file1=loc1 "file2 = loc2" ...
2082# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2083# section "Linking to external documentation" for more information about the use
2084# of tag files.
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002085# Note: Each tag file must have a unique name (where the name does NOT include
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002086# the path). If a tag file is not located in the directory in which doxygen is
2087# run, you must also specify the path to the tagfile here.
2088
2089TAGFILES =
2090
2091# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2092# tag file that is based on the input files it reads. See section "Linking to
2093# external documentation" for more information about the usage of tag files.
2094
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -07002095GENERATE_TAGFILE = ndn-cxx.tag
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002096
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002097# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2098# the class index. If set to NO, only the inherited external classes will be
2099# listed.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002100# The default value is: NO.
2101
2102ALLEXTERNALS = NO
2103
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002104# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2105# in the modules index. If set to NO, only the current project's groups will be
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002106# listed.
2107# The default value is: YES.
2108
2109EXTERNAL_GROUPS = YES
2110
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002111# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002112# the related pages index. If set to NO, only the current project's pages will
2113# be listed.
2114# The default value is: YES.
2115
2116EXTERNAL_PAGES = YES
2117
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002118#---------------------------------------------------------------------------
2119# Configuration options related to the dot tool
2120#---------------------------------------------------------------------------
2121
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002122# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002123# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2124# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2125# disabled, but it is recommended to install and use dot, since it yields more
2126# powerful graphs.
2127# The default value is: YES.
2128
2129CLASS_DIAGRAMS = YES
2130
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002131# You can include diagrams made with dia in doxygen documentation. Doxygen will
2132# then run dia to produce the diagram and insert it in the documentation. The
2133# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2134# If left empty dia is assumed to be found in the default search path.
2135
2136DIA_PATH =
2137
2138# If set to YES the inheritance and collaboration graphs will hide inheritance
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002139# and usage relations if the target is undocumented or is not a class.
2140# The default value is: YES.
2141
2142HIDE_UNDOC_RELATIONS = YES
2143
2144# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2145# available from the path. This tool is part of Graphviz (see:
2146# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2147# Bell Labs. The other options in this section have no effect if this option is
2148# set to NO
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002149# The default value is: YES.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002150
Davide Pesaventodbe645f2021-04-16 00:42:52 -04002151HAVE_DOT = @HAVE_DOT@
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002152
2153# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2154# to run in parallel. When set to 0 doxygen will base this on the number of
2155# processors available in the system. You can set it explicitly to a value
2156# larger than 0 to get control over the balance between CPU load and processing
2157# speed.
2158# Minimum value: 0, maximum value: 32, default value: 0.
2159# This tag requires that the tag HAVE_DOT is set to YES.
2160
2161DOT_NUM_THREADS = 0
2162
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002163# When you want a differently looking font in the dot files that doxygen
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002164# generates you can specify the font name using DOT_FONTNAME. You need to make
2165# sure dot is able to find the font, which can be done by putting it in a
2166# standard location or by setting the DOTFONTPATH environment variable or by
2167# setting DOT_FONTPATH to the directory containing the font.
2168# The default value is: Helvetica.
2169# This tag requires that the tag HAVE_DOT is set to YES.
2170
2171DOT_FONTNAME = Helvetica
2172
2173# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2174# dot graphs.
2175# Minimum value: 4, maximum value: 24, default value: 10.
2176# This tag requires that the tag HAVE_DOT is set to YES.
2177
2178DOT_FONTSIZE = 10
2179
2180# By default doxygen will tell dot to use the default font as specified with
2181# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2182# the path where dot can find it using this tag.
2183# This tag requires that the tag HAVE_DOT is set to YES.
2184
2185DOT_FONTPATH =
2186
2187# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2188# each documented class showing the direct and indirect inheritance relations.
2189# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2190# The default value is: YES.
2191# This tag requires that the tag HAVE_DOT is set to YES.
2192
2193CLASS_GRAPH = YES
2194
2195# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2196# graph for each documented class showing the direct and indirect implementation
2197# dependencies (inheritance, containment, and class references variables) of the
2198# class with other documented classes.
2199# The default value is: YES.
2200# This tag requires that the tag HAVE_DOT is set to YES.
2201
2202COLLABORATION_GRAPH = YES
2203
2204# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2205# groups, showing the direct groups dependencies.
2206# The default value is: YES.
2207# This tag requires that the tag HAVE_DOT is set to YES.
2208
2209GROUP_GRAPHS = YES
2210
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002211# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002212# collaboration diagrams in a style similar to the OMG's Unified Modeling
2213# Language.
2214# The default value is: NO.
2215# This tag requires that the tag HAVE_DOT is set to YES.
2216
Alexander Afanasyev3aeeaeb2014-04-22 23:34:23 -07002217UML_LOOK = NO
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002218
2219# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2220# class node. If there are many fields or methods and many nodes the graph may
2221# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2222# number of items for each type to make the size more manageable. Set this to 0
2223# for no limit. Note that the threshold may be exceeded by 50% before the limit
2224# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2225# but if the number exceeds 15, the total amount of fields shown is limited to
2226# 10.
2227# Minimum value: 0, maximum value: 100, default value: 10.
2228# This tag requires that the tag HAVE_DOT is set to YES.
2229
2230UML_LIMIT_NUM_FIELDS = 10
2231
2232# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2233# collaboration graphs will show the relations between templates and their
2234# instances.
2235# The default value is: NO.
2236# This tag requires that the tag HAVE_DOT is set to YES.
2237
2238TEMPLATE_RELATIONS = YES
2239
2240# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2241# YES then doxygen will generate a graph for each documented file showing the
2242# direct and indirect include dependencies of the file with other documented
2243# files.
2244# The default value is: YES.
2245# This tag requires that the tag HAVE_DOT is set to YES.
2246
2247INCLUDE_GRAPH = YES
2248
2249# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2250# set to YES then doxygen will generate a graph for each documented file showing
2251# the direct and indirect include dependencies of the file with other documented
2252# files.
2253# The default value is: YES.
2254# This tag requires that the tag HAVE_DOT is set to YES.
2255
2256INCLUDED_BY_GRAPH = YES
2257
2258# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2259# dependency graph for every global function or class method.
2260#
2261# Note that enabling this option will significantly increase the time of a run.
2262# So in most cases it will be better to enable call graphs for selected
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002263# functions only using the \callgraph command. Disabling a call graph can be
2264# accomplished by means of the command \hidecallgraph.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002265# The default value is: NO.
2266# This tag requires that the tag HAVE_DOT is set to YES.
2267
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07002268CALL_GRAPH = NO
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002269
2270# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2271# dependency graph for every global function or class method.
2272#
2273# Note that enabling this option will significantly increase the time of a run.
2274# So in most cases it will be better to enable caller graphs for selected
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002275# functions only using the \callergraph command. Disabling a caller graph can be
2276# accomplished by means of the command \hidecallergraph.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002277# The default value is: NO.
2278# This tag requires that the tag HAVE_DOT is set to YES.
2279
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07002280CALLER_GRAPH = NO
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002281
2282# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2283# hierarchy of all classes instead of a textual one.
2284# The default value is: YES.
2285# This tag requires that the tag HAVE_DOT is set to YES.
2286
2287GRAPHICAL_HIERARCHY = YES
2288
2289# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2290# dependencies a directory has on other directories in a graphical way. The
2291# dependency relations are determined by the #include relations between the
2292# files in the directories.
2293# The default value is: YES.
2294# This tag requires that the tag HAVE_DOT is set to YES.
2295
2296DIRECTORY_GRAPH = YES
2297
2298# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002299# generated by dot. For an explanation of the image formats see the section
2300# output formats in the documentation of the dot tool (Graphviz (see:
2301# http://www.graphviz.org/)).
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002302# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2303# to make the SVG files visible in IE 9+ (other browsers do not have this
2304# requirement).
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002305# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2306# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2307# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
2308# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2309# png:gdiplus:gdiplus.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002310# The default value is: png.
2311# This tag requires that the tag HAVE_DOT is set to YES.
2312
2313DOT_IMAGE_FORMAT = svg
2314
2315# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2316# enable generation of interactive SVG images that allow zooming and panning.
2317#
2318# Note that this requires a modern browser other than Internet Explorer. Tested
2319# and working are Firefox, Chrome, Safari, and Opera.
2320# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2321# the SVG files visible. Older versions of IE do not have SVG support.
2322# The default value is: NO.
2323# This tag requires that the tag HAVE_DOT is set to YES.
2324
2325INTERACTIVE_SVG = NO
2326
2327# The DOT_PATH tag can be used to specify the path where the dot tool can be
2328# found. If left blank, it is assumed the dot tool can be found in the path.
2329# This tag requires that the tag HAVE_DOT is set to YES.
2330
2331DOT_PATH =
2332
2333# The DOTFILE_DIRS tag can be used to specify one or more directories that
2334# contain dot files that are included in the documentation (see the \dotfile
2335# command).
2336# This tag requires that the tag HAVE_DOT is set to YES.
2337
2338DOTFILE_DIRS =
2339
2340# The MSCFILE_DIRS tag can be used to specify one or more directories that
2341# contain msc files that are included in the documentation (see the \mscfile
2342# command).
2343
2344MSCFILE_DIRS =
2345
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002346# The DIAFILE_DIRS tag can be used to specify one or more directories that
2347# contain dia files that are included in the documentation (see the \diafile
2348# command).
2349
2350DIAFILE_DIRS =
2351
2352# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2353# path where java can find the plantuml.jar file. If left blank, it is assumed
2354# PlantUML is not used or called during a preprocessing step. Doxygen will
2355# generate a warning when it encounters a \startuml command in this case and
2356# will not generate output for the diagram.
2357
2358PLANTUML_JAR_PATH =
2359
2360# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2361# configuration file for plantuml.
2362
2363# PLANTUML_CFG_FILE =
2364
2365# When using plantuml, the specified paths are searched for files specified by
2366# the !include statement in a plantuml block.
2367
2368PLANTUML_INCLUDE_PATH =
2369
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002370# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2371# that will be shown in the graph. If the number of nodes in a graph becomes
2372# larger than this value, doxygen will truncate the graph, which is visualized
2373# by representing a node as a red box. Note that doxygen if the number of direct
2374# children of the root node in a graph is already larger than
2375# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2376# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2377# Minimum value: 0, maximum value: 10000, default value: 50.
2378# This tag requires that the tag HAVE_DOT is set to YES.
2379
Alexander Afanasyevf2a46222015-09-17 18:01:30 -07002380DOT_GRAPH_MAX_NODES = 10000
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002381
2382# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2383# generated by dot. A depth value of 3 means that only nodes reachable from the
2384# root by following a path via at most 3 edges will be shown. Nodes that lay
2385# further from the root node will be omitted. Note that setting this option to 1
2386# or 2 may greatly reduce the computation time needed for large code bases. Also
2387# note that the size of a graph can be further restricted by
2388# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2389# Minimum value: 0, maximum value: 1000, default value: 0.
2390# This tag requires that the tag HAVE_DOT is set to YES.
2391
2392MAX_DOT_GRAPH_DEPTH = 0
2393
2394# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2395# background. This is disabled by default, because dot on Windows does not seem
2396# to support this out of the box.
2397#
2398# Warning: Depending on the platform used, enabling this option may lead to
2399# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2400# read).
2401# The default value is: NO.
2402# This tag requires that the tag HAVE_DOT is set to YES.
2403
2404DOT_TRANSPARENT = YES
2405
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002406# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002407# files in one run (i.e. multiple -o and -T options on the command line). This
2408# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2409# this, this feature is disabled by default.
2410# The default value is: NO.
2411# This tag requires that the tag HAVE_DOT is set to YES.
2412
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002413DOT_MULTI_TARGETS = YES
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002414
2415# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2416# explaining the meaning of the various boxes and arrows in the dot generated
2417# graphs.
2418# The default value is: YES.
2419# This tag requires that the tag HAVE_DOT is set to YES.
2420
2421GENERATE_LEGEND = YES
2422
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002423# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002424# files that are used to generate the various graphs.
2425# The default value is: YES.
2426# This tag requires that the tag HAVE_DOT is set to YES.
2427
2428DOT_CLEANUP = YES