blob: 8b06194d349a1a2eee32d008377c39186248e381 [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
143FULL_PATH_NAMES = NO
144
145# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
146# Stripping is only done if one of the specified strings matches the left-hand
147# part of the path. The tag can be used to show relative paths in the file list.
148# If left blank the directory from which doxygen is run is used as the path to
149# strip.
150#
151# Note that you can specify absolute paths here, but also relative paths, which
152# will be relative from the directory where doxygen is started.
153# This tag requires that the tag FULL_PATH_NAMES is set to YES.
154
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
164STRIP_FROM_INC_PATH =
165
166# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
167# less readable) file names. This can be useful is your file systems doesn't
168# support long names like on DOS, Mac, or CD-ROM.
169# The default value is: NO.
170
171SHORT_NAMES = NO
172
173# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
174# first line (until the first dot) of a Javadoc-style comment as the brief
175# description. If set to NO, the Javadoc-style will behave just like regular Qt-
176# style comments (thus requiring an explicit @brief command for a brief
177# description.)
178# The default value is: NO.
179
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
233# This tag can be used to specify a number of word-keyword mappings (TCL only).
234# A mapping has the form "name=value". For example adding "class=itcl::class"
235# will allow you to use the command class in the itcl::class meaning.
236
237TCL_SUBST =
238
239# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
240# only. Doxygen will then generate output that is more tailored for C. For
241# instance, some of the names that are used will be different. The list of all
242# members will be omitted, etc.
243# The default value is: NO.
244
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400245OPTIMIZE_OUTPUT_FOR_C = NO
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000246
247# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
248# Python sources only. Doxygen will then generate output that is more tailored
249# for that language. For instance, namespaces will be presented as packages,
250# qualified scopes will look different, etc.
251# The default value is: NO.
252
253OPTIMIZE_OUTPUT_JAVA = NO
254
255# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
256# sources. Doxygen will then generate output that is tailored for Fortran.
257# The default value is: NO.
258
259OPTIMIZE_FOR_FORTRAN = NO
260
261# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
262# sources. Doxygen will then generate output that is tailored for VHDL.
263# The default value is: NO.
264
265OPTIMIZE_OUTPUT_VHDL = NO
266
267# Doxygen selects the parser to use depending on the extension of the files it
268# parses. With this tag you can assign which parser to use for a given
269# extension. Doxygen has a built-in mapping, but you can override or extend it
270# using this tag. The format is ext=language, where ext is a file extension, and
271# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400272# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
273# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
274# Fortran. In the later case the parser tries to guess whether the code is fixed
275# or free formatted code, this is the default for Fortran type files), VHDL. For
276# instance to make doxygen treat .inc files as Fortran files (default is PHP),
277# and .f files as C (default is Fortran), use: inc=Fortran f=C.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000278#
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400279# Note: For files without extension you can use no_extension as a placeholder.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000280#
281# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
282# the files are not read by doxygen.
283
284EXTENSION_MAPPING =
285
286# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
287# according to the Markdown format, which allows for more readable
288# documentation. See http://daringfireball.net/projects/markdown/ for details.
289# The output of markdown processing is further processed by doxygen, so you can
290# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
291# case of backward compatibilities issues.
292# The default value is: YES.
293
294MARKDOWN_SUPPORT = YES
295
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400296# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
297# to that level are automatically included in the table of contents, even if
298# they do not have an id attribute.
299# Note: This feature currently applies only to Markdown headings.
300# Minimum value: 0, maximum value: 99, default value: 0.
301# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
302
303# TOC_INCLUDE_HEADINGS = 0
304
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000305# When enabled doxygen tries to link words that correspond to documented
306# classes, or namespaces to their corresponding documentation. Such a link can
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400307# be prevented in individual cases by putting a % sign in front of the word or
308# globally by setting AUTOLINK_SUPPORT to NO.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000309# The default value is: YES.
310
311AUTOLINK_SUPPORT = YES
312
313# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
314# to include (a tag file for) the STL sources as input, then you should set this
315# tag to YES in order to let doxygen match functions declarations and
316# definitions whose arguments contain STL classes (e.g. func(std::string);
317# versus func(std::string) {}). This also make the inheritance and collaboration
318# diagrams that involve STL classes more complete and accurate.
319# The default value is: NO.
320
321BUILTIN_STL_SUPPORT = YES
322
323# If you use Microsoft's C++/CLI language, you should set this option to YES to
324# enable parsing support.
325# The default value is: NO.
326
327CPP_CLI_SUPPORT = NO
328
329# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
330# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
331# will parse them like normal C++ but will assume all classes use public instead
332# of private inheritance when no explicit protection keyword is present.
333# The default value is: NO.
334
335SIP_SUPPORT = NO
336
337# For Microsoft's IDL there are propget and propput attributes to indicate
338# getter and setter methods for a property. Setting this option to YES will make
339# doxygen to replace the get and set methods by a property in the documentation.
340# This will only work if the methods are indeed getting or setting a simple
341# type. If this is not the case, or you want to show the methods anyway, you
342# should set this option to NO.
343# The default value is: YES.
344
345IDL_PROPERTY_SUPPORT = YES
346
347# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400348# tag is set to YES then doxygen will reuse the documentation of the first
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000349# member in the group (if any) for the other members of the group. By default
350# all members of a group must be documented explicitly.
351# The default value is: NO.
352
353DISTRIBUTE_GROUP_DOC = NO
354
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400355# If one adds a struct or class to a group and this option is enabled, then also
356# any nested class or struct is added to the same group. By default this option
357# is disabled and one has to add nested compounds explicitly via \ingroup.
358# The default value is: NO.
359
360GROUP_NESTED_COMPOUNDS = YES
361
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000362# Set the SUBGROUPING tag to YES to allow class member groups of the same type
363# (for instance a group of public functions) to be put as a subgroup of that
364# type (e.g. under the Public Functions section). Set it to NO to prevent
365# subgrouping. Alternatively, this can be done per class using the
366# \nosubgrouping command.
367# The default value is: YES.
368
369SUBGROUPING = YES
370
371# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
372# are shown inside the group in which they are included (e.g. using \ingroup)
373# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
374# and RTF).
375#
376# Note that this feature does not work in combination with
377# SEPARATE_MEMBER_PAGES.
378# The default value is: NO.
379
380INLINE_GROUPED_CLASSES = NO
381
382# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
383# with only public data fields or simple typedef fields will be shown inline in
384# the documentation of the scope in which they are defined (i.e. file,
385# namespace, or group documentation), provided this scope is documented. If set
386# to NO, structs, classes, and unions are shown on a separate page (for HTML and
387# Man pages) or section (for LaTeX and RTF).
388# The default value is: NO.
389
390INLINE_SIMPLE_STRUCTS = NO
391
392# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
393# enum is documented as struct, union, or enum with the name of the typedef. So
394# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
395# with name TypeT. When disabled the typedef will appear as a member of a file,
396# namespace, or class. And the struct will be named TypeS. This can typically be
397# useful for C code in case the coding convention dictates that all compound
398# types are typedef'ed and only the typedef is referenced, never the tag name.
399# The default value is: NO.
400
401TYPEDEF_HIDES_STRUCT = NO
402
403# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
404# cache is used to resolve symbols given their name and scope. Since this can be
405# an expensive process and often the same symbol appears multiple times in the
406# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
407# doxygen will become slower. If the cache is too large, memory is wasted. The
408# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
409# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
410# symbols. At the end of a run doxygen will report the cache usage and suggest
411# the optimal cache size from a speed point of view.
412# Minimum value: 0, maximum value: 9, default value: 0.
413
414LOOKUP_CACHE_SIZE = 0
415
416#---------------------------------------------------------------------------
417# Build related configuration options
418#---------------------------------------------------------------------------
419
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400420# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000421# documentation are documented, even if no documentation was available. Private
422# class members and static file members will be hidden unless the
423# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
424# Note: This will also disable the warnings about undocumented members that are
425# normally produced when WARNINGS is set to YES.
426# The default value is: NO.
427
428EXTRACT_ALL = YES
429
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400430# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000431# be included in the documentation.
432# The default value is: NO.
433
434EXTRACT_PRIVATE = NO
435
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400436# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000437# scope will be included in the documentation.
438# The default value is: NO.
439
440EXTRACT_PACKAGE = NO
441
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400442# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000443# included in the documentation.
444# The default value is: NO.
445
446EXTRACT_STATIC = YES
447
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400448# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
449# locally in source files will be included in the documentation. If set to NO,
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000450# only classes defined in header files are included. Does not have any effect
451# for Java sources.
452# The default value is: YES.
453
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400454EXTRACT_LOCAL_CLASSES = NO
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000455
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400456# This flag is only useful for Objective-C code. If set to YES, local methods,
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000457# which are defined in the implementation section but not in the interface are
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400458# included in the documentation. If set to NO, only methods in the interface are
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000459# included.
460# The default value is: NO.
461
462EXTRACT_LOCAL_METHODS = NO
463
464# If this flag is set to YES, the members of anonymous namespaces will be
465# extracted and appear in the documentation as a namespace called
466# 'anonymous_namespace{file}', where file will be replaced with the base name of
467# the file that contains the anonymous namespace. By default anonymous namespace
468# are hidden.
469# The default value is: NO.
470
471EXTRACT_ANON_NSPACES = NO
472
473# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
474# undocumented members inside documented classes or files. If set to NO these
475# members will be included in the various overviews, but no documentation
476# section is generated. This option has no effect if EXTRACT_ALL is enabled.
477# The default value is: NO.
478
479HIDE_UNDOC_MEMBERS = NO
480
481# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
482# undocumented classes that are normally visible in the class hierarchy. If set
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400483# to NO, these classes will be included in the various overviews. This option
484# has no effect if EXTRACT_ALL is enabled.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000485# The default value is: NO.
486
487HIDE_UNDOC_CLASSES = NO
488
489# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400490# (class|struct|union) declarations. If set to NO, these declarations will be
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000491# included in the documentation.
492# The default value is: NO.
493
494HIDE_FRIEND_COMPOUNDS = NO
495
496# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400497# documentation blocks found inside the body of a function. If set to NO, these
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000498# blocks will be appended to the function's detailed documentation block.
499# The default value is: NO.
500
501HIDE_IN_BODY_DOCS = NO
502
503# The INTERNAL_DOCS tag determines if documentation that is typed after a
504# \internal command is included. If the tag is set to NO then the documentation
505# will be excluded. Set it to YES to include the internal documentation.
506# The default value is: NO.
507
508INTERNAL_DOCS = NO
509
510# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400511# names in lower-case letters. If set to YES, upper-case letters are also
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000512# allowed. This is useful if you have classes or files whose names only differ
513# in case and if your file system supports case sensitive file names. Windows
514# and Mac users are advised to set this option to NO.
515# The default value is: system dependent.
516
517CASE_SENSE_NAMES = YES
518
519# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400520# their full class and namespace scopes in the documentation. If set to YES, the
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000521# scope will be hidden.
522# The default value is: NO.
523
524HIDE_SCOPE_NAMES = NO
525
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400526# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
527# append additional text to a page's title, such as Class Reference. If set to
528# YES the compound reference will be hidden.
529# The default value is: NO.
530
531HIDE_COMPOUND_REFERENCE= NO
532
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000533# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
534# the files that are included by a file in the documentation of that file.
535# The default value is: YES.
536
537SHOW_INCLUDE_FILES = YES
538
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400539# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
540# grouped member an include statement to the documentation, telling the reader
541# which file to include in order to use the member.
542# The default value is: NO.
543
544SHOW_GROUPED_MEMB_INC = NO
545
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000546# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
547# files with double quotes in the documentation rather than with sharp brackets.
548# The default value is: NO.
549
550FORCE_LOCAL_INCLUDES = NO
551
552# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
553# documentation for inline members.
554# The default value is: YES.
555
556INLINE_INFO = YES
557
558# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
559# (detailed) documentation of file and class members alphabetically by member
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400560# name. If set to NO, the members will appear in declaration order.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000561# The default value is: YES.
562
563SORT_MEMBER_DOCS = YES
564
565# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
566# descriptions of file, namespace and class members alphabetically by member
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400567# name. If set to NO, the members will appear in declaration order. Note that
568# this will also influence the order of the classes in the class list.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000569# The default value is: NO.
570
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400571SORT_BRIEF_DOCS = YES
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000572
573# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
574# (brief and detailed) documentation of class members so that constructors and
575# destructors are listed first. If set to NO the constructors will appear in the
576# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
577# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
578# member documentation.
579# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
580# detailed member documentation.
581# The default value is: NO.
582
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400583SORT_MEMBERS_CTORS_1ST = YES
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000584
585# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
586# of group names into alphabetical order. If set to NO the group names will
587# appear in their defined order.
588# The default value is: NO.
589
590SORT_GROUP_NAMES = YES
591
592# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
593# fully-qualified names, including namespaces. If set to NO, the class list will
594# be sorted only by class name, not including the namespace part.
595# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
596# Note: This option applies only to the class list, not to the alphabetical
597# list.
598# The default value is: NO.
599
600SORT_BY_SCOPE_NAME = NO
601
602# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
603# type resolution of all parameters of a function it will reject a match between
604# the prototype and the implementation of a member function even if there is
605# only one candidate or it is obvious which candidate to choose by doing a
606# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
607# accept a match between prototype and implementation in such cases.
608# The default value is: NO.
609
610STRICT_PROTO_MATCHING = NO
611
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400612# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
613# list. This list is created by putting \todo commands in the documentation.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000614# The default value is: YES.
615
616GENERATE_TODOLIST = YES
617
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400618# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
619# list. This list is created by putting \test commands in the documentation.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000620# The default value is: YES.
621
622GENERATE_TESTLIST = YES
623
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400624# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000625# list. This list is created by putting \bug commands in the documentation.
626# The default value is: YES.
627
628GENERATE_BUGLIST = YES
629
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400630# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000631# the deprecated list. This list is created by putting \deprecated commands in
632# the documentation.
633# The default value is: YES.
634
Alexander Afanasyev691c3ce2014-04-23 14:28:04 -0700635GENERATE_DEPRECATEDLIST= YES
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000636
637# The ENABLED_SECTIONS tag can be used to enable conditional documentation
638# sections, marked by \if <section_label> ... \endif and \cond <section_label>
639# ... \endcond blocks.
640
641ENABLED_SECTIONS =
642
643# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
644# initial value of a variable or macro / define can have for it to appear in the
645# documentation. If the initializer consists of more lines than specified here
646# it will be hidden. Use a value of 0 to hide initializers completely. The
647# appearance of the value of individual variables and macros / defines can be
648# controlled using \showinitializer or \hideinitializer command in the
649# documentation regardless of this setting.
650# Minimum value: 0, maximum value: 10000, default value: 30.
651
652MAX_INITIALIZER_LINES = 30
653
654# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400655# the bottom of the documentation of classes and structs. If set to YES, the
656# list will mention the files that were used to generate the documentation.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000657# The default value is: YES.
658
659SHOW_USED_FILES = NO
660
661# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
662# will remove the Files entry from the Quick Index and from the Folder Tree View
663# (if specified).
664# The default value is: YES.
665
666SHOW_FILES = YES
667
668# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
669# page. This will remove the Namespaces entry from the Quick Index and from the
670# Folder Tree View (if specified).
671# The default value is: YES.
672
673SHOW_NAMESPACES = YES
674
675# The FILE_VERSION_FILTER tag can be used to specify a program or script that
676# doxygen should invoke to get the current version for each file (typically from
677# the version control system). Doxygen will invoke the program by executing (via
678# popen()) the command command input-file, where command is the value of the
679# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
680# by doxygen. Whatever the program writes to standard output is used as the file
681# version. For an example see the documentation.
682
683FILE_VERSION_FILTER =
684
685# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
686# by doxygen. The layout file controls the global structure of the generated
687# output files in an output format independent way. To create the layout file
688# that represents doxygen's defaults, run doxygen with the -l option. You can
689# optionally specify a file name after the option, if omitted DoxygenLayout.xml
690# will be used as the name of the layout file.
691#
692# Note that if you run doxygen from a directory containing a file called
693# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
694# tag is left empty.
695
696LAYOUT_FILE =
697
698# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
699# the reference definitions. This must be a list of .bib files. The .bib
700# extension is automatically appended if omitted. This requires the bibtex tool
701# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
702# For LaTeX the style of the bibliography can be controlled using
703# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400704# search path. See also \cite for info how to create references.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000705
706CITE_BIB_FILES =
707
708#---------------------------------------------------------------------------
709# Configuration options related to warning and progress messages
710#---------------------------------------------------------------------------
711
712# The QUIET tag can be used to turn on/off the messages that are generated to
713# standard output by doxygen. If QUIET is set to YES this implies that the
714# messages are off.
715# The default value is: NO.
716
717QUIET = YES
718
719# The WARNINGS tag can be used to turn on/off the warning messages that are
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400720# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000721# this implies that the warnings are on.
722#
723# Tip: Turn warnings on while writing the documentation.
724# The default value is: YES.
725
726WARNINGS = YES
727
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400728# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000729# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
730# will automatically be disabled.
731# The default value is: YES.
732
733WARN_IF_UNDOCUMENTED = YES
734
735# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
736# potential errors in the documentation, such as not documenting some parameters
737# in a documented function, or documenting parameters that don't exist or using
738# markup commands wrongly.
739# The default value is: YES.
740
741WARN_IF_DOC_ERROR = YES
742
743# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
744# are documented, but have no documentation for their parameters or return
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400745# value. If set to NO, doxygen will only warn about wrong or incomplete
746# parameter documentation, but not about the absence of documentation.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000747# The default value is: NO.
748
749WARN_NO_PARAMDOC = YES
750
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400751# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
752# a warning is encountered.
753# The default value is: NO.
754
755WARN_AS_ERROR = NO
756
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000757# The WARN_FORMAT tag determines the format of the warning messages that doxygen
758# can produce. The string should contain the $file, $line, and $text tags, which
759# will be replaced by the file and line number from which the warning originated
760# and the warning text. Optionally the format may contain $version, which will
761# be replaced by the version of the file (if it could be obtained via
762# FILE_VERSION_FILTER)
763# The default value is: $file:$line: $text.
764
765WARN_FORMAT = "$file:$line: $text"
766
767# The WARN_LOGFILE tag can be used to specify a file to which warning and error
768# messages should be written. If left blank the output is written to standard
769# error (stderr).
770
771WARN_LOGFILE =
772
773#---------------------------------------------------------------------------
774# Configuration options related to the input files
775#---------------------------------------------------------------------------
776
777# The INPUT tag is used to specify the files and/or directories that contain
778# documented source files. You may enter file names like myfile.cpp or
779# directories like /usr/src/myproject. Separate the files or directories with
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400780# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000781# Note: If this tag is empty the current directory is searched.
782
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400783INPUT = src
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000784
785# This tag can be used to specify the character encoding of the source files
786# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
787# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
788# documentation (see: http://www.gnu.org/software/libiconv) for the list of
789# possible encodings.
790# The default value is: UTF-8.
791
792INPUT_ENCODING = UTF-8
793
794# If the value of the INPUT tag contains directories, you can use the
795# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400796# *.h) to filter out the source-files in the directories.
797#
798# Note that for custom extensions or not directly supported extensions you also
799# need to set EXTENSION_MAPPING for the extension otherwise the files are not
800# read by doxygen.
801#
802# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
803# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
804# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
805# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
806# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000807
808FILE_PATTERNS =
809
810# The RECURSIVE tag can be used to specify whether or not subdirectories should
811# be searched for input files as well.
812# The default value is: NO.
813
814RECURSIVE = YES
815
816# The EXCLUDE tag can be used to specify files and/or directories that should be
817# excluded from the INPUT source files. This way you can easily exclude a
818# subdirectory from a directory tree whose root is specified with the INPUT tag.
819#
820# Note that relative paths are relative to the directory from which doxygen is
821# run.
822
823EXCLUDE =
824
825# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
826# directories that are symbolic links (a Unix file system feature) are excluded
827# from the input.
828# The default value is: NO.
829
830EXCLUDE_SYMLINKS = NO
831
832# If the value of the INPUT tag contains directories, you can use the
833# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
834# certain files from those directories.
835#
836# Note that the wildcards are matched against the file with absolute path, so to
837# exclude all test directories for example use the pattern */test/*
838
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400839EXCLUDE_PATTERNS = */src/detail/* */src/*/detail/*
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000840
841# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
842# (namespaces, classes, functions, etc.) that should be excluded from the
843# output. The symbol name can be a fully qualified name, a word, or if the
844# wildcard * is used, a substring. Examples: ANamespace, AClass,
845# AClass::ANamespace, ANamespace::*Test
846#
847# Note that the wildcards are matched against the file with absolute path, so to
848# exclude all test directories use the pattern */test/*
849
850EXCLUDE_SYMBOLS =
851
852# The EXAMPLE_PATH tag can be used to specify one or more files or directories
853# that contain example code fragments that are included (see the \include
854# command).
855
Alexander Afanasyevf2a46222015-09-17 18:01:30 -0700856EXAMPLE_PATH =
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000857
858# If the value of the EXAMPLE_PATH tag contains directories, you can use the
859# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
860# *.h) to filter out the source-files in the directories. If left blank all
861# files are included.
862
863EXAMPLE_PATTERNS =
864
865# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
866# searched for input files to be used with the \include or \dontinclude commands
867# irrespective of the value of the RECURSIVE tag.
868# The default value is: NO.
869
870EXAMPLE_RECURSIVE = YES
871
872# The IMAGE_PATH tag can be used to specify one or more files or directories
873# that contain images that are to be included in the documentation (see the
874# \image command).
875
876IMAGE_PATH =
877
878# The INPUT_FILTER tag can be used to specify a program that doxygen should
879# invoke to filter for each input file. Doxygen will invoke the filter program
880# by executing (via popen()) the command:
881#
882# <filter> <input-file>
883#
884# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
885# name of an input file. Doxygen will then use the output that the filter
886# program writes to standard output. If FILTER_PATTERNS is specified, this tag
887# will be ignored.
888#
889# Note that the filter must not add or remove lines; it is applied before the
890# code is scanned, but not when the output code is generated. If lines are added
891# or removed, the anchors will not be placed correctly.
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400892#
893# Note that for custom extensions or not directly supported extensions you also
894# need to set EXTENSION_MAPPING for the extension otherwise the files are not
895# properly processed by doxygen.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000896
897INPUT_FILTER =
898
899# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
900# basis. Doxygen will compare the file name with each pattern and apply the
901# filter if there is a match. The filters are a list of the form: pattern=filter
902# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
903# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
904# patterns match the file name, INPUT_FILTER is applied.
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400905#
906# Note that for custom extensions or not directly supported extensions you also
907# need to set EXTENSION_MAPPING for the extension otherwise the files are not
908# properly processed by doxygen.
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000909
910FILTER_PATTERNS =
911
912# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400913# INPUT_FILTER) will also be used to filter the input files that are used for
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000914# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
915# The default value is: NO.
916
917FILTER_SOURCE_FILES = NO
918
919# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
920# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
921# it is also possible to disable source filtering for a specific pattern using
922# *.ext= (so without naming a filter).
923# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
924
925FILTER_SOURCE_PATTERNS =
926
927# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
928# is part of the input, its contents will be placed on the main page
929# (index.html). This can be useful if you have a project on for instance GitHub
930# and want to reuse the introduction page also for the doxygen output.
931
932USE_MDFILE_AS_MAINPAGE =
933
934#---------------------------------------------------------------------------
935# Configuration options related to source browsing
936#---------------------------------------------------------------------------
937
938# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
939# generated. Documented entities will be cross-referenced with these sources.
940#
941# Note: To get rid of all source code in the generated output, make sure that
942# also VERBATIM_HEADERS is set to NO.
943# The default value is: NO.
944
945SOURCE_BROWSER = YES
946
947# Setting the INLINE_SOURCES tag to YES will include the body of functions,
948# classes and enums directly into the documentation.
949# The default value is: NO.
950
951INLINE_SOURCES = NO
952
953# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
954# special comment blocks from generated source code fragments. Normal C, C++ and
955# Fortran comments will always remain visible.
956# The default value is: YES.
957
958STRIP_CODE_COMMENTS = YES
959
960# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
961# function all documented functions referencing it will be listed.
962# The default value is: NO.
963
964REFERENCED_BY_RELATION = NO
965
966# If the REFERENCES_RELATION tag is set to YES then for each documented function
967# all documented entities called/used by that function will be listed.
968# The default value is: NO.
969
970REFERENCES_RELATION = NO
971
972# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400973# to YES then the hyperlinks from functions in REFERENCES_RELATION and
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000974# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
975# link to the documentation.
976# The default value is: YES.
977
978REFERENCES_LINK_SOURCE = YES
979
980# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
981# source code will show a tooltip with additional information such as prototype,
982# brief description and links to the definition and documentation. Since this
983# will make the HTML file larger and loading of large files a bit slower, you
984# can opt to disable this feature.
985# The default value is: YES.
986# This tag requires that the tag SOURCE_BROWSER is set to YES.
987
988SOURCE_TOOLTIPS = YES
989
990# If the USE_HTAGS tag is set to YES then the references to source code will
991# point to the HTML generated by the htags(1) tool instead of doxygen built-in
992# source browser. The htags tool is part of GNU's global source tagging system
993# (see http://www.gnu.org/software/global/global.html). You will need version
994# 4.8.6 or higher.
995#
996# To use it do the following:
997# - Install the latest version of global
998# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
999# - Make sure the INPUT points to the root of the source tree
1000# - Run doxygen as normal
1001#
1002# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1003# tools must be available from the command line (i.e. in the search path).
1004#
1005# The result: instead of the source browser generated by doxygen, the links to
1006# source code will now point to the output of htags.
1007# The default value is: NO.
1008# This tag requires that the tag SOURCE_BROWSER is set to YES.
1009
1010USE_HTAGS = NO
1011
1012# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1013# verbatim copy of the header file for each class for which an include is
1014# specified. Set to NO to disable this.
1015# See also: Section \class.
1016# The default value is: YES.
1017
1018VERBATIM_HEADERS = YES
1019
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001020# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1021# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1022# cost of reduced performance. This can be particularly helpful with template
1023# rich C++ code for which doxygen's built-in parser lacks the necessary type
1024# information.
1025# Note: The availability of this option depends on whether or not doxygen was
1026# generated with the -Duse-libclang=ON option for CMake.
1027# The default value is: NO.
1028
1029# CLANG_ASSISTED_PARSING = NO
1030
1031# If clang assisted parsing is enabled you can provide the compiler with command
1032# line options that you would normally use when invoking the compiler. Note that
1033# the include paths will already be set by doxygen for the files and directories
1034# specified with INPUT and INCLUDE_PATH.
1035# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1036
1037# CLANG_OPTIONS =
1038
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001039#---------------------------------------------------------------------------
1040# Configuration options related to the alphabetical class index
1041#---------------------------------------------------------------------------
1042
1043# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1044# compounds will be generated. Enable this if the project contains a lot of
1045# classes, structs, unions or interfaces.
1046# The default value is: YES.
1047
1048ALPHABETICAL_INDEX = YES
1049
1050# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1051# which the alphabetical index list will be split.
1052# Minimum value: 1, maximum value: 20, default value: 5.
1053# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1054
1055COLS_IN_ALPHA_INDEX = 5
1056
1057# In case all classes in a project start with a common prefix, all classes will
1058# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1059# can be used to specify a prefix (or a list of prefixes) that should be ignored
1060# while generating the index headers.
1061# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1062
1063IGNORE_PREFIX =
1064
1065#---------------------------------------------------------------------------
1066# Configuration options related to the HTML output
1067#---------------------------------------------------------------------------
1068
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001069# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001070# The default value is: YES.
1071
1072GENERATE_HTML = YES
1073
1074# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1075# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1076# it.
1077# The default directory is: html.
1078# This tag requires that the tag GENERATE_HTML is set to YES.
1079
1080HTML_OUTPUT = ./
1081
1082# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1083# generated HTML page (for example: .htm, .php, .asp).
1084# The default value is: .html.
1085# This tag requires that the tag GENERATE_HTML is set to YES.
1086
1087HTML_FILE_EXTENSION = .html
1088
1089# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1090# each generated HTML page. If the tag is left blank doxygen will generate a
1091# standard header.
1092#
1093# To get valid HTML the header file that includes any scripts and style sheets
1094# that doxygen needs, which is dependent on the configuration options used (e.g.
1095# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1096# default header using
1097# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1098# YourConfigFile
1099# and then modify the file new_header.html. See also section "Doxygen usage"
1100# for information on how to generate the default header that doxygen normally
1101# uses.
1102# Note: The header is subject to change so you typically have to regenerate the
1103# default header when upgrading to a newer version of doxygen. For a description
1104# of the possible markers and block names see the documentation.
1105# This tag requires that the tag GENERATE_HTML is set to YES.
1106
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07001107HTML_HEADER = ../docs/named_data_theme/named_data_header.html
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001108
1109# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1110# generated HTML page. If the tag is left blank doxygen will generate a standard
1111# footer. See HTML_HEADER for more information on how to generate a default
1112# footer and what special commands can be used inside the footer. See also
1113# section "Doxygen usage" for information on how to generate the default footer
1114# that doxygen normally uses.
1115# This tag requires that the tag GENERATE_HTML is set to YES.
1116
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -07001117HTML_FOOTER = @HTML_FOOTER@
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001118
1119# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1120# sheet that is used by each HTML page. It can be used to fine-tune the look of
1121# the HTML output. If left blank doxygen will generate a default style sheet.
1122# See also section "Doxygen usage" for information on how to generate the style
1123# sheet that doxygen normally uses.
1124# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1125# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1126# obsolete.
1127# This tag requires that the tag GENERATE_HTML is set to YES.
1128
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07001129HTML_STYLESHEET = ../docs/named_data_theme/static/named_data_doxygen.css
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001130
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001131# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1132# cascading style sheets that are included after the standard style sheets
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001133# created by doxygen. Using this option one can overrule certain style aspects.
1134# This is preferred over using HTML_STYLESHEET since it does not replace the
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001135# standard style sheet and is therefore more robust against future updates.
1136# Doxygen will copy the style sheet files to the output directory.
1137# Note: The order of the extra style sheet files is of importance (e.g. the last
1138# style sheet in the list overrules the setting of the previous ones in the
1139# list). For an example see the documentation.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001140# This tag requires that the tag GENERATE_HTML is set to YES.
1141
1142HTML_EXTRA_STYLESHEET =
1143
1144# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1145# other source files which should be copied to the HTML output directory. Note
1146# that these files will be copied to the base HTML output directory. Use the
1147# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1148# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1149# files will be copied as-is; there are no commands or markers available.
1150# This tag requires that the tag GENERATE_HTML is set to YES.
1151
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07001152HTML_EXTRA_FILES = ../docs/named_data_theme/static/doxygen.css \
1153 ../docs/named_data_theme/static/base.css \
1154 ../docs/named_data_theme/static/foundation.css \
1155 ../docs/named_data_theme/static/bar-top.png
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001156
1157# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001158# will adjust the colors in the style sheet and background images according to
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001159# this color. Hue is specified as an angle on a colorwheel, see
1160# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1161# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1162# purple, and 360 is red again.
1163# Minimum value: 0, maximum value: 359, default value: 220.
1164# This tag requires that the tag GENERATE_HTML is set to YES.
1165
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07001166HTML_COLORSTYLE_HUE = 0
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001167
1168# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1169# in the HTML output. For a value of 0 the output will use grayscales only. A
1170# value of 255 will produce the most vivid colors.
1171# Minimum value: 0, maximum value: 255, default value: 100.
1172# This tag requires that the tag GENERATE_HTML is set to YES.
1173
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07001174HTML_COLORSTYLE_SAT = 0
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001175
1176# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1177# luminance component of the colors in the HTML output. Values below 100
1178# gradually make the output lighter, whereas values above 100 make the output
1179# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1180# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1181# change the gamma.
1182# Minimum value: 40, maximum value: 240, default value: 80.
1183# This tag requires that the tag GENERATE_HTML is set to YES.
1184
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07001185HTML_COLORSTYLE_GAMMA = 91
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001186
1187# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1188# page will contain the date and time when the page was generated. Setting this
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001189# to YES can help to show when doxygen was last run and thus if the
1190# documentation is up to date.
1191# The default value is: NO.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001192# This tag requires that the tag GENERATE_HTML is set to YES.
1193
1194HTML_TIMESTAMP = YES
1195
1196# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1197# documentation will contain sections that can be hidden and shown after the
1198# page has loaded.
1199# The default value is: NO.
1200# This tag requires that the tag GENERATE_HTML is set to YES.
1201
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001202HTML_DYNAMIC_SECTIONS = YES
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001203
1204# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1205# shown in the various tree structured indices initially; the user can expand
1206# and collapse entries dynamically later on. Doxygen will expand the tree to
1207# such a level that at most the specified number of entries are visible (unless
1208# a fully collapsed tree already exceeds this amount). So setting the number of
1209# entries 1 will produce a full collapsed tree by default. 0 is a special value
1210# representing an infinite number of entries and will result in a full expanded
1211# tree by default.
1212# Minimum value: 0, maximum value: 9999, default value: 100.
1213# This tag requires that the tag GENERATE_HTML is set to YES.
1214
1215HTML_INDEX_NUM_ENTRIES = 100
1216
1217# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1218# generated that can be used as input for Apple's Xcode 3 integrated development
1219# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1220# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1221# Makefile in the HTML output directory. Running make will produce the docset in
1222# that directory and running make install will install the docset in
1223# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1224# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1225# for more information.
1226# The default value is: NO.
1227# This tag requires that the tag GENERATE_HTML is set to YES.
1228
1229GENERATE_DOCSET = NO
1230
1231# This tag determines the name of the docset feed. A documentation feed provides
1232# an umbrella under which multiple documentation sets from a single provider
1233# (such as a company or product suite) can be grouped.
1234# The default value is: Doxygen generated docs.
1235# This tag requires that the tag GENERATE_DOCSET is set to YES.
1236
1237DOCSET_FEEDNAME = "Doxygen generated docs"
1238
1239# This tag specifies a string that should uniquely identify the documentation
1240# set bundle. This should be a reverse domain-name style string, e.g.
1241# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1242# The default value is: org.doxygen.Project.
1243# This tag requires that the tag GENERATE_DOCSET is set to YES.
1244
1245DOCSET_BUNDLE_ID = org.doxygen.Project
1246
1247# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1248# the documentation publisher. This should be a reverse domain-name style
1249# string, e.g. com.mycompany.MyDocSet.documentation.
1250# The default value is: org.doxygen.Publisher.
1251# This tag requires that the tag GENERATE_DOCSET is set to YES.
1252
1253DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1254
1255# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1256# The default value is: Publisher.
1257# This tag requires that the tag GENERATE_DOCSET is set to YES.
1258
1259DOCSET_PUBLISHER_NAME = Publisher
1260
1261# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1262# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1263# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1264# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1265# Windows.
1266#
1267# The HTML Help Workshop contains a compiler that can convert all HTML output
1268# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1269# files are now used as the Windows 98 help format, and will replace the old
1270# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1271# HTML files also contain an index, a table of contents, and you can search for
1272# words in the documentation. The HTML workshop also contains a viewer for
1273# compressed HTML files.
1274# The default value is: NO.
1275# This tag requires that the tag GENERATE_HTML is set to YES.
1276
1277GENERATE_HTMLHELP = NO
1278
1279# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1280# file. You can add a path in front of the file if the result should not be
1281# written to the html output directory.
1282# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1283
1284CHM_FILE =
1285
1286# The HHC_LOCATION tag can be used to specify the location (absolute path
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001287# including file name) of the HTML help compiler (hhc.exe). If non-empty,
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001288# doxygen will try to run the HTML help compiler on the generated index.hhp.
1289# The file has to be specified with full path.
1290# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1291
1292HHC_LOCATION =
1293
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001294# The GENERATE_CHI flag controls if a separate .chi index file is generated
1295# (YES) or that it should be included in the master .chm file (NO).
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001296# The default value is: NO.
1297# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1298
1299GENERATE_CHI = NO
1300
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001301# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001302# and project file content.
1303# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1304
1305CHM_INDEX_ENCODING =
1306
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001307# The BINARY_TOC flag controls whether a binary table of contents is generated
1308# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1309# enables the Previous and Next buttons.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001310# The default value is: NO.
1311# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1312
1313BINARY_TOC = NO
1314
1315# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1316# the table of contents of the HTML help documentation and to the tree view.
1317# The default value is: NO.
1318# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1319
1320TOC_EXPAND = NO
1321
1322# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1323# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1324# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1325# (.qch) of the generated HTML documentation.
1326# The default value is: NO.
1327# This tag requires that the tag GENERATE_HTML is set to YES.
1328
1329GENERATE_QHP = NO
1330
1331# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1332# the file name of the resulting .qch file. The path specified is relative to
1333# the HTML output folder.
1334# This tag requires that the tag GENERATE_QHP is set to YES.
1335
1336QCH_FILE =
1337
1338# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1339# Project output. For more information please see Qt Help Project / Namespace
1340# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1341# The default value is: org.doxygen.Project.
1342# This tag requires that the tag GENERATE_QHP is set to YES.
1343
1344QHP_NAMESPACE = org.doxygen.Project
1345
1346# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1347# Help Project output. For more information please see Qt Help Project / Virtual
1348# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1349# folders).
1350# The default value is: doc.
1351# This tag requires that the tag GENERATE_QHP is set to YES.
1352
1353QHP_VIRTUAL_FOLDER = doc
1354
1355# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1356# filter to add. For more information please see Qt Help Project / Custom
1357# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1358# filters).
1359# This tag requires that the tag GENERATE_QHP is set to YES.
1360
1361QHP_CUST_FILTER_NAME =
1362
1363# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1364# custom filter to add. For more information please see Qt Help Project / Custom
1365# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1366# filters).
1367# This tag requires that the tag GENERATE_QHP is set to YES.
1368
1369QHP_CUST_FILTER_ATTRS =
1370
1371# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1372# project's filter section matches. Qt Help Project / Filter Attributes (see:
1373# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1374# This tag requires that the tag GENERATE_QHP is set to YES.
1375
1376QHP_SECT_FILTER_ATTRS =
1377
1378# The QHG_LOCATION tag can be used to specify the location of Qt's
1379# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1380# generated .qhp file.
1381# This tag requires that the tag GENERATE_QHP is set to YES.
1382
1383QHG_LOCATION =
1384
1385# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1386# generated, together with the HTML files, they form an Eclipse help plugin. To
1387# install this plugin and make it available under the help contents menu in
1388# Eclipse, the contents of the directory containing the HTML and XML files needs
1389# to be copied into the plugins directory of eclipse. The name of the directory
1390# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1391# After copying Eclipse needs to be restarted before the help appears.
1392# The default value is: NO.
1393# This tag requires that the tag GENERATE_HTML is set to YES.
1394
1395GENERATE_ECLIPSEHELP = NO
1396
1397# A unique identifier for the Eclipse help plugin. When installing the plugin
1398# the directory name containing the HTML and XML files should also have this
1399# name. Each documentation set should have its own identifier.
1400# The default value is: org.doxygen.Project.
1401# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1402
1403ECLIPSE_DOC_ID = org.doxygen.Project
1404
1405# If you want full control over the layout of the generated HTML pages it might
1406# be necessary to disable the index and replace it with your own. The
1407# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1408# of each HTML page. A value of NO enables the index and the value YES disables
1409# it. Since the tabs in the index contain the same information as the navigation
1410# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1411# The default value is: NO.
1412# This tag requires that the tag GENERATE_HTML is set to YES.
1413
1414DISABLE_INDEX = NO
1415
1416# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1417# structure should be generated to display hierarchical information. If the tag
1418# value is set to YES, a side panel will be generated containing a tree-like
1419# index structure (just like the one that is generated for HTML Help). For this
1420# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1421# (i.e. any modern browser). Windows users are probably better off using the
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001422# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001423# further fine-tune the look of the index. As an example, the default style
1424# sheet generated by doxygen has an example that shows how to put an image at
1425# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1426# the same information as the tab index, you could consider setting
1427# DISABLE_INDEX to YES when enabling this option.
1428# The default value is: NO.
1429# This tag requires that the tag GENERATE_HTML is set to YES.
1430
1431GENERATE_TREEVIEW = YES
1432
1433# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1434# doxygen will group on one line in the generated HTML documentation.
1435#
1436# Note that a value of 0 will completely suppress the enum values from appearing
1437# in the overview section.
1438# Minimum value: 0, maximum value: 20, default value: 4.
1439# This tag requires that the tag GENERATE_HTML is set to YES.
1440
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001441ENUM_VALUES_PER_LINE = 1
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001442
1443# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1444# to set the initial width (in pixels) of the frame in which the tree is shown.
1445# Minimum value: 0, maximum value: 1500, default value: 250.
1446# This tag requires that the tag GENERATE_HTML is set to YES.
1447
1448TREEVIEW_WIDTH = 250
1449
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001450# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001451# external symbols imported via tag files in a separate window.
1452# The default value is: NO.
1453# This tag requires that the tag GENERATE_HTML is set to YES.
1454
1455EXT_LINKS_IN_WINDOW = NO
1456
1457# Use this tag to change the font size of LaTeX formulas included as images in
1458# the HTML documentation. When you change the font size after a successful
1459# doxygen run you need to manually remove any form_*.png images from the HTML
1460# output directory to force them to be regenerated.
1461# Minimum value: 8, maximum value: 50, default value: 10.
1462# This tag requires that the tag GENERATE_HTML is set to YES.
1463
1464FORMULA_FONTSIZE = 10
1465
1466# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1467# generated for formulas are transparent PNGs. Transparent PNGs are not
1468# supported properly for IE 6.0, but are supported on all modern browsers.
1469#
1470# Note that when changing this option you need to delete any form_*.png files in
1471# the HTML output directory before the changes have effect.
1472# The default value is: YES.
1473# This tag requires that the tag GENERATE_HTML is set to YES.
1474
1475FORMULA_TRANSPARENT = YES
1476
1477# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1478# http://www.mathjax.org) which uses client side Javascript for the rendering
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001479# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001480# installed or if you want to formulas look prettier in the HTML output. When
1481# enabled you may also need to install MathJax separately and configure the path
1482# to it using the MATHJAX_RELPATH option.
1483# The default value is: NO.
1484# This tag requires that the tag GENERATE_HTML is set to YES.
1485
1486USE_MATHJAX = NO
1487
1488# When MathJax is enabled you can set the default output format to be used for
1489# the MathJax output. See the MathJax site (see:
1490# http://docs.mathjax.org/en/latest/output.html) for more details.
1491# Possible values are: HTML-CSS (which is slower, but has the best
1492# compatibility), NativeMML (i.e. MathML) and SVG.
1493# The default value is: HTML-CSS.
1494# This tag requires that the tag USE_MATHJAX is set to YES.
1495
1496MATHJAX_FORMAT = HTML-CSS
1497
1498# When MathJax is enabled you need to specify the location relative to the HTML
1499# output directory using the MATHJAX_RELPATH option. The destination directory
1500# should contain the MathJax.js script. For instance, if the mathjax directory
1501# is located at the same level as the HTML output directory, then
1502# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1503# Content Delivery Network so you can quickly see the result without installing
1504# MathJax. However, it is strongly recommended to install a local copy of
1505# MathJax from http://www.mathjax.org before deployment.
1506# The default value is: http://cdn.mathjax.org/mathjax/latest.
1507# This tag requires that the tag USE_MATHJAX is set to YES.
1508
1509MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1510
1511# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1512# extension names that should be enabled during MathJax rendering. For example
1513# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1514# This tag requires that the tag USE_MATHJAX is set to YES.
1515
1516MATHJAX_EXTENSIONS =
1517
1518# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1519# of code that will be used on startup of the MathJax code. See the MathJax site
1520# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1521# example see the documentation.
1522# This tag requires that the tag USE_MATHJAX is set to YES.
1523
1524MATHJAX_CODEFILE =
1525
1526# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1527# the HTML output. The underlying search engine uses javascript and DHTML and
1528# should work on any modern browser. Note that when using HTML help
1529# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1530# there is already a search function so this one should typically be disabled.
1531# For large projects the javascript based search engine can be slow, then
1532# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1533# search using the keyboard; to jump to the search box use <access key> + S
1534# (what the <access key> is depends on the OS and browser, but it is typically
1535# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1536# key> to jump into the search results window, the results can be navigated
1537# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1538# the search. The filter options can be selected when the cursor is inside the
1539# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1540# to select a filter and <Enter> or <escape> to activate or cancel the filter
1541# option.
1542# The default value is: YES.
1543# This tag requires that the tag GENERATE_HTML is set to YES.
1544
1545SEARCHENGINE = YES
1546
1547# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1548# implemented using a web server instead of a web client using Javascript. There
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001549# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1550# setting. When disabled, doxygen will generate a PHP script for searching and
1551# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1552# and searching needs to be provided by external tools. See the section
1553# "External Indexing and Searching" for details.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001554# The default value is: NO.
1555# This tag requires that the tag SEARCHENGINE is set to YES.
1556
1557SERVER_BASED_SEARCH = NO
1558
1559# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1560# script for searching. Instead the search results are written to an XML file
1561# which needs to be processed by an external indexer. Doxygen will invoke an
1562# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1563# search results.
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/).
1568#
1569# See the section "External Indexing and Searching" for details.
1570# The default value is: NO.
1571# This tag requires that the tag SEARCHENGINE is set to YES.
1572
1573EXTERNAL_SEARCH = NO
1574
1575# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1576# which will return the search results when EXTERNAL_SEARCH is enabled.
1577#
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001578# Doxygen ships with an example indexer (doxyindexer) and search engine
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001579# (doxysearch.cgi) which are based on the open source search engine library
1580# Xapian (see: http://xapian.org/). See the section "External Indexing and
1581# Searching" for details.
1582# This tag requires that the tag SEARCHENGINE is set to YES.
1583
1584SEARCHENGINE_URL =
1585
1586# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1587# search data is written to a file for indexing by an external tool. With the
1588# SEARCHDATA_FILE tag the name of this file can be specified.
1589# The default file is: searchdata.xml.
1590# This tag requires that the tag SEARCHENGINE is set to YES.
1591
1592SEARCHDATA_FILE = searchdata.xml
1593
1594# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1595# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1596# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1597# projects and redirect the results back to the right project.
1598# This tag requires that the tag SEARCHENGINE is set to YES.
1599
1600EXTERNAL_SEARCH_ID =
1601
1602# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1603# projects other than the one defined by this configuration file, but that are
1604# all added to the same external search index. Each project needs to have a
1605# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1606# to a relative location where the documentation can be found. The format is:
1607# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1608# This tag requires that the tag SEARCHENGINE is set to YES.
1609
1610EXTRA_SEARCH_MAPPINGS =
1611
1612#---------------------------------------------------------------------------
1613# Configuration options related to the LaTeX output
1614#---------------------------------------------------------------------------
1615
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001616# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001617# The default value is: YES.
1618
1619GENERATE_LATEX = NO
1620
1621# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1622# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1623# it.
1624# The default directory is: latex.
1625# This tag requires that the tag GENERATE_LATEX is set to YES.
1626
1627LATEX_OUTPUT = latex
1628
1629# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1630# invoked.
1631#
1632# Note that when enabling USE_PDFLATEX this option is only used for generating
1633# bitmaps for formulas in the HTML output, but not in the Makefile that is
1634# written to the output directory.
1635# The default file is: latex.
1636# This tag requires that the tag GENERATE_LATEX is set to YES.
1637
1638LATEX_CMD_NAME = latex
1639
1640# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1641# index for LaTeX.
1642# The default file is: makeindex.
1643# This tag requires that the tag GENERATE_LATEX is set to YES.
1644
1645MAKEINDEX_CMD_NAME = makeindex
1646
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001647# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001648# documents. This may be useful for small projects and may help to save some
1649# trees in general.
1650# The default value is: NO.
1651# This tag requires that the tag GENERATE_LATEX is set to YES.
1652
1653COMPACT_LATEX = NO
1654
1655# The PAPER_TYPE tag can be used to set the paper type that is used by the
1656# printer.
1657# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1658# 14 inches) and executive (7.25 x 10.5 inches).
1659# The default value is: a4.
1660# This tag requires that the tag GENERATE_LATEX is set to YES.
1661
1662PAPER_TYPE = a4
1663
1664# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001665# that should be included in the LaTeX output. The package can be specified just
1666# by its name or with the correct syntax as to be used with the LaTeX
1667# \usepackage command. To get the times font for instance you can specify :
1668# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1669# To use the option intlimits with the amsmath package you can specify:
1670# EXTRA_PACKAGES=[intlimits]{amsmath}
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001671# If left blank no extra packages will be included.
1672# This tag requires that the tag GENERATE_LATEX is set to YES.
1673
1674EXTRA_PACKAGES =
1675
1676# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1677# generated LaTeX document. The header should contain everything until the first
1678# chapter. If it is left blank doxygen will generate a standard header. See
1679# section "Doxygen usage" for information on how to let doxygen write the
1680# default header to a separate file.
1681#
1682# Note: Only use a user-defined header if you know what you are doing! The
1683# following commands have a special meaning inside the header: $title,
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001684# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1685# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1686# string, for the replacement values of the other commands the user is referred
1687# to HTML_HEADER.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001688# This tag requires that the tag GENERATE_LATEX is set to YES.
1689
1690LATEX_HEADER =
1691
1692# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1693# generated LaTeX document. The footer should contain everything after the last
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001694# chapter. If it is left blank doxygen will generate a standard footer. See
1695# LATEX_HEADER for more information on how to generate a default footer and what
1696# special commands can be used inside the footer.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001697#
1698# Note: Only use a user-defined footer if you know what you are doing!
1699# This tag requires that the tag GENERATE_LATEX is set to YES.
1700
1701LATEX_FOOTER =
1702
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001703# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1704# LaTeX style sheets that are included after the standard style sheets created
1705# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1706# will copy the style sheet files to the output directory.
1707# Note: The order of the extra style sheet files is of importance (e.g. the last
1708# style sheet in the list overrules the setting of the previous ones in the
1709# list).
1710# This tag requires that the tag GENERATE_LATEX is set to YES.
1711
1712LATEX_EXTRA_STYLESHEET =
1713
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001714# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1715# other source files which should be copied to the LATEX_OUTPUT output
1716# directory. Note that the files will be copied as-is; there are no commands or
1717# markers available.
1718# This tag requires that the tag GENERATE_LATEX is set to YES.
1719
1720LATEX_EXTRA_FILES =
1721
1722# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1723# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1724# contain links (just like the HTML output) instead of page references. This
1725# makes the output suitable for online browsing using a PDF viewer.
1726# The default value is: YES.
1727# This tag requires that the tag GENERATE_LATEX is set to YES.
1728
1729PDF_HYPERLINKS = YES
1730
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001731# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1732# the PDF file directly from the LaTeX files. Set this option to YES, to get a
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001733# higher quality PDF documentation.
1734# The default value is: YES.
1735# This tag requires that the tag GENERATE_LATEX is set to YES.
1736
1737USE_PDFLATEX = YES
1738
1739# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1740# command to the generated LaTeX files. This will instruct LaTeX to keep running
1741# if errors occur, instead of asking the user for help. This option is also used
1742# when generating formulas in HTML.
1743# The default value is: NO.
1744# This tag requires that the tag GENERATE_LATEX is set to YES.
1745
1746LATEX_BATCHMODE = NO
1747
1748# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1749# index chapters (such as File Index, Compound Index, etc.) in the output.
1750# The default value is: NO.
1751# This tag requires that the tag GENERATE_LATEX is set to YES.
1752
1753LATEX_HIDE_INDICES = NO
1754
1755# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1756# code with syntax highlighting in the LaTeX output.
1757#
1758# Note that which sources are shown also depends on other settings such as
1759# SOURCE_BROWSER.
1760# The default value is: NO.
1761# This tag requires that the tag GENERATE_LATEX is set to YES.
1762
1763LATEX_SOURCE_CODE = NO
1764
1765# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1766# bibliography, e.g. plainnat, or ieeetr. See
1767# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1768# The default value is: plain.
1769# This tag requires that the tag GENERATE_LATEX is set to YES.
1770
1771LATEX_BIB_STYLE = plain
1772
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001773# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1774# page will contain the date and time when the page was generated. Setting this
1775# to NO can help when comparing the output of multiple runs.
1776# The default value is: NO.
1777# This tag requires that the tag GENERATE_LATEX is set to YES.
1778
1779LATEX_TIMESTAMP = NO
1780
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001781#---------------------------------------------------------------------------
1782# Configuration options related to the RTF output
1783#---------------------------------------------------------------------------
1784
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001785# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001786# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1787# readers/editors.
1788# The default value is: NO.
1789
1790GENERATE_RTF = NO
1791
1792# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1793# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1794# it.
1795# The default directory is: rtf.
1796# This tag requires that the tag GENERATE_RTF is set to YES.
1797
1798RTF_OUTPUT = rtf
1799
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001800# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001801# documents. This may be useful for small projects and may help to save some
1802# trees in general.
1803# The default value is: NO.
1804# This tag requires that the tag GENERATE_RTF is set to YES.
1805
1806COMPACT_RTF = NO
1807
1808# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1809# contain hyperlink fields. The RTF file will contain links (just like the HTML
1810# output) instead of page references. This makes the output suitable for online
1811# browsing using Word or some other Word compatible readers that support those
1812# fields.
1813#
1814# Note: WordPad (write) and others do not support links.
1815# The default value is: NO.
1816# This tag requires that the tag GENERATE_RTF is set to YES.
1817
1818RTF_HYPERLINKS = NO
1819
1820# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1821# file, i.e. a series of assignments. You only have to provide replacements,
1822# missing definitions are set to their default value.
1823#
1824# See also section "Doxygen usage" for information on how to generate the
1825# default style sheet that doxygen normally uses.
1826# This tag requires that the tag GENERATE_RTF is set to YES.
1827
1828RTF_STYLESHEET_FILE =
1829
1830# Set optional variables used in the generation of an RTF document. Syntax is
1831# similar to doxygen's config file. A template extensions file can be generated
1832# using doxygen -e rtf extensionFile.
1833# This tag requires that the tag GENERATE_RTF is set to YES.
1834
1835RTF_EXTENSIONS_FILE =
1836
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001837# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1838# with syntax highlighting in the RTF output.
1839#
1840# Note that which sources are shown also depends on other settings such as
1841# SOURCE_BROWSER.
1842# The default value is: NO.
1843# This tag requires that the tag GENERATE_RTF is set to YES.
1844
1845RTF_SOURCE_CODE = NO
1846
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001847#---------------------------------------------------------------------------
1848# Configuration options related to the man page output
1849#---------------------------------------------------------------------------
1850
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001851# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001852# classes and files.
1853# The default value is: NO.
1854
1855GENERATE_MAN = NO
1856
1857# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1858# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1859# it. A directory man3 will be created inside the directory specified by
1860# MAN_OUTPUT.
1861# The default directory is: man.
1862# This tag requires that the tag GENERATE_MAN is set to YES.
1863
1864MAN_OUTPUT = man
1865
1866# The MAN_EXTENSION tag determines the extension that is added to the generated
1867# man pages. In case the manual section does not start with a number, the number
1868# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1869# optional.
1870# The default value is: .3.
1871# This tag requires that the tag GENERATE_MAN is set to YES.
1872
1873MAN_EXTENSION = .3
1874
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001875# The MAN_SUBDIR tag determines the name of the directory created within
1876# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1877# MAN_EXTENSION with the initial . removed.
1878# This tag requires that the tag GENERATE_MAN is set to YES.
1879
1880MAN_SUBDIR =
1881
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001882# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1883# will generate one additional man file for each entity documented in the real
1884# man page(s). These additional files only source the real man page, but without
1885# them the man command would be unable to find the correct page.
1886# The default value is: NO.
1887# This tag requires that the tag GENERATE_MAN is set to YES.
1888
1889MAN_LINKS = NO
1890
1891#---------------------------------------------------------------------------
1892# Configuration options related to the XML output
1893#---------------------------------------------------------------------------
1894
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001895# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001896# captures the structure of the code including all documentation.
1897# The default value is: NO.
1898
1899GENERATE_XML = NO
1900
1901# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1902# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1903# it.
1904# The default directory is: xml.
1905# This tag requires that the tag GENERATE_XML is set to YES.
1906
1907XML_OUTPUT = xml
1908
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001909# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001910# listings (including syntax highlighting and cross-referencing information) to
1911# the XML output. Note that enabling this will significantly increase the size
1912# of the XML output.
1913# The default value is: YES.
1914# This tag requires that the tag GENERATE_XML is set to YES.
1915
1916XML_PROGRAMLISTING = YES
1917
1918#---------------------------------------------------------------------------
1919# Configuration options related to the DOCBOOK output
1920#---------------------------------------------------------------------------
1921
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001922# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001923# that can be used to generate PDF.
1924# The default value is: NO.
1925
1926GENERATE_DOCBOOK = NO
1927
1928# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1929# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1930# front of it.
1931# The default directory is: docbook.
1932# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1933
1934DOCBOOK_OUTPUT = docbook
1935
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001936# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1937# program listings (including syntax highlighting and cross-referencing
1938# information) to the DOCBOOK output. Note that enabling this will significantly
1939# increase the size of the DOCBOOK output.
1940# The default value is: NO.
1941# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1942
1943DOCBOOK_PROGRAMLISTING = NO
1944
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001945#---------------------------------------------------------------------------
1946# Configuration options for the AutoGen Definitions output
1947#---------------------------------------------------------------------------
1948
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001949# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1950# AutoGen Definitions (see http://autogen.sf.net) file that captures the
1951# structure of the code including all documentation. Note that this feature is
1952# still experimental and incomplete at the moment.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001953# The default value is: NO.
1954
1955GENERATE_AUTOGEN_DEF = NO
1956
1957#---------------------------------------------------------------------------
1958# Configuration options related to the Perl module output
1959#---------------------------------------------------------------------------
1960
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001961# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001962# file that captures the structure of the code including all documentation.
1963#
1964# Note that this feature is still experimental and incomplete at the moment.
1965# The default value is: NO.
1966
1967GENERATE_PERLMOD = NO
1968
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001969# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001970# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1971# output from the Perl module output.
1972# The default value is: NO.
1973# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1974
1975PERLMOD_LATEX = NO
1976
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001977# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001978# formatted so it can be parsed by a human reader. This is useful if you want to
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001979# understand what is going on. On the other hand, if this tag is set to NO, the
Alexander Afanasyev401a2362014-03-02 00:03:11 +00001980# size of the Perl module output will be much smaller and Perl will parse it
1981# just the same.
1982# The default value is: YES.
1983# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1984
1985PERLMOD_PRETTY = YES
1986
1987# The names of the make variables in the generated doxyrules.make file are
1988# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1989# so different doxyrules.make files included by the same Makefile don't
1990# overwrite each other's variables.
1991# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1992
1993PERLMOD_MAKEVAR_PREFIX =
1994
1995#---------------------------------------------------------------------------
1996# Configuration options related to the preprocessor
1997#---------------------------------------------------------------------------
1998
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04001999# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002000# C-preprocessor directives found in the sources and include files.
2001# The default value is: YES.
2002
2003ENABLE_PREPROCESSING = YES
2004
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002005# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2006# in the source code. If set to NO, only conditional compilation will be
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002007# performed. Macro expansion can be done in a controlled way by setting
2008# EXPAND_ONLY_PREDEF to YES.
2009# The default value is: NO.
2010# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2011
Yingdi Yu0eb5d722014-06-10 15:06:25 -07002012MACRO_EXPANSION = YES
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002013
2014# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2015# the macro expansion is limited to the macros specified with the PREDEFINED and
2016# EXPAND_AS_DEFINED tags.
2017# The default value is: NO.
2018# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2019
2020EXPAND_ONLY_PREDEF = NO
2021
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002022# If the SEARCH_INCLUDES tag is set to YES, the include files in the
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002023# INCLUDE_PATH will be searched if a #include is found.
2024# The default value is: YES.
2025# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2026
2027SEARCH_INCLUDES = YES
2028
2029# The INCLUDE_PATH tag can be used to specify one or more directories that
2030# contain include files that are not input files but should be processed by the
2031# preprocessor.
2032# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2033
2034INCLUDE_PATH =
2035
2036# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2037# patterns (like *.h and *.hpp) to filter out the header-files in the
2038# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2039# used.
2040# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2041
2042INCLUDE_FILE_PATTERNS =
2043
2044# The PREDEFINED tag can be used to specify one or more macro names that are
2045# defined before the preprocessor is started (similar to the -D option of e.g.
2046# gcc). The argument of the tag is a list of macros of the form: name or
2047# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2048# is assumed. To prevent a macro definition from being undefined via #undef or
2049# recursively expanded use the := operator instead of the = operator.
2050# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2051
Alexander Afanasyev5946ed12015-01-19 23:41:39 -08002052PREDEFINED = DOXYGEN \
Davide Pesavento88a0d812017-08-19 21:31:42 -04002053 DEPRECATED(x)=x \
2054 NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(x)= \
2055 NDN_LOG_INIT(x)= \
Alexander Afanasyev5946ed12015-01-19 23:41:39 -08002056 PUBLIC_WITH_TESTS_ELSE_PROTECTED=protected \
2057 PUBLIC_WITH_TESTS_ELSE_PRIVATE=private \
2058 PROTECTED_WITH_TESTS_ELSE_PRIVATE=private \
Davide Pesavento88a0d812017-08-19 21:31:42 -04002059 VIRTUAL_WITH_TESTS=
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002060
2061# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2062# tag can be used to specify a list of macro names that should be expanded. The
2063# macro definition that is found in the sources will be used. Use the PREDEFINED
2064# tag if you want to use a different macro definition that overrules the
2065# definition found in the source code.
2066# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2067
2068EXPAND_AS_DEFINED =
2069
2070# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002071# remove all references to function-like macros that are alone on a line, have
2072# an all uppercase name, and do not end with a semicolon. Such function macros
2073# are typically used for boiler-plate code, and will confuse the parser if not
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002074# removed.
2075# The default value is: YES.
2076# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2077
2078SKIP_FUNCTION_MACROS = YES
2079
2080#---------------------------------------------------------------------------
2081# Configuration options related to external references
2082#---------------------------------------------------------------------------
2083
2084# The TAGFILES tag can be used to specify one or more tag files. For each tag
2085# file the location of the external documentation should be added. The format of
2086# a tag file without this location is as follows:
2087# TAGFILES = file1 file2 ...
2088# Adding location for the tag files is done as follows:
2089# TAGFILES = file1=loc1 "file2 = loc2" ...
2090# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2091# section "Linking to external documentation" for more information about the use
2092# of tag files.
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002093# Note: Each tag file must have a unique name (where the name does NOT include
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002094# the path). If a tag file is not located in the directory in which doxygen is
2095# run, you must also specify the path to the tagfile here.
2096
2097TAGFILES =
2098
2099# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2100# tag file that is based on the input files it reads. See section "Linking to
2101# external documentation" for more information about the usage of tag files.
2102
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -07002103GENERATE_TAGFILE = ndn-cxx.tag
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002104
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002105# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2106# the class index. If set to NO, only the inherited external classes will be
2107# listed.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002108# The default value is: NO.
2109
2110ALLEXTERNALS = NO
2111
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002112# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2113# in the modules index. If set to NO, only the current project's groups will be
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002114# listed.
2115# The default value is: YES.
2116
2117EXTERNAL_GROUPS = YES
2118
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002119# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002120# the related pages index. If set to NO, only the current project's pages will
2121# be listed.
2122# The default value is: YES.
2123
2124EXTERNAL_PAGES = YES
2125
2126# The PERL_PATH should be the absolute path and name of the perl script
2127# interpreter (i.e. the result of 'which perl').
2128# The default file (with absolute path) is: /usr/bin/perl.
2129
2130PERL_PATH = /usr/bin/perl
2131
2132#---------------------------------------------------------------------------
2133# Configuration options related to the dot tool
2134#---------------------------------------------------------------------------
2135
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002136# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002137# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2138# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2139# disabled, but it is recommended to install and use dot, since it yields more
2140# powerful graphs.
2141# The default value is: YES.
2142
2143CLASS_DIAGRAMS = YES
2144
2145# You can define message sequence charts within doxygen comments using the \msc
2146# command. Doxygen will then run the mscgen tool (see:
2147# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2148# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2149# the mscgen tool resides. If left empty the tool is assumed to be found in the
2150# default search path.
2151
2152MSCGEN_PATH =
2153
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002154# You can include diagrams made with dia in doxygen documentation. Doxygen will
2155# then run dia to produce the diagram and insert it in the documentation. The
2156# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2157# If left empty dia is assumed to be found in the default search path.
2158
2159DIA_PATH =
2160
2161# If set to YES the inheritance and collaboration graphs will hide inheritance
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002162# and usage relations if the target is undocumented or is not a class.
2163# The default value is: YES.
2164
2165HIDE_UNDOC_RELATIONS = YES
2166
2167# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2168# available from the path. This tool is part of Graphviz (see:
2169# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2170# Bell Labs. The other options in this section have no effect if this option is
2171# set to NO
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002172# The default value is: YES.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002173
2174HAVE_DOT = YES
2175
2176# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2177# to run in parallel. When set to 0 doxygen will base this on the number of
2178# processors available in the system. You can set it explicitly to a value
2179# larger than 0 to get control over the balance between CPU load and processing
2180# speed.
2181# Minimum value: 0, maximum value: 32, default value: 0.
2182# This tag requires that the tag HAVE_DOT is set to YES.
2183
2184DOT_NUM_THREADS = 0
2185
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002186# When you want a differently looking font in the dot files that doxygen
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002187# generates you can specify the font name using DOT_FONTNAME. You need to make
2188# sure dot is able to find the font, which can be done by putting it in a
2189# standard location or by setting the DOTFONTPATH environment variable or by
2190# setting DOT_FONTPATH to the directory containing the font.
2191# The default value is: Helvetica.
2192# This tag requires that the tag HAVE_DOT is set to YES.
2193
2194DOT_FONTNAME = Helvetica
2195
2196# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2197# dot graphs.
2198# Minimum value: 4, maximum value: 24, default value: 10.
2199# This tag requires that the tag HAVE_DOT is set to YES.
2200
2201DOT_FONTSIZE = 10
2202
2203# By default doxygen will tell dot to use the default font as specified with
2204# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2205# the path where dot can find it using this tag.
2206# This tag requires that the tag HAVE_DOT is set to YES.
2207
2208DOT_FONTPATH =
2209
2210# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2211# each documented class showing the direct and indirect inheritance relations.
2212# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2213# The default value is: YES.
2214# This tag requires that the tag HAVE_DOT is set to YES.
2215
2216CLASS_GRAPH = YES
2217
2218# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2219# graph for each documented class showing the direct and indirect implementation
2220# dependencies (inheritance, containment, and class references variables) of the
2221# class with other documented classes.
2222# The default value is: YES.
2223# This tag requires that the tag HAVE_DOT is set to YES.
2224
2225COLLABORATION_GRAPH = YES
2226
2227# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2228# groups, showing the direct groups dependencies.
2229# The default value is: YES.
2230# This tag requires that the tag HAVE_DOT is set to YES.
2231
2232GROUP_GRAPHS = YES
2233
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002234# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002235# collaboration diagrams in a style similar to the OMG's Unified Modeling
2236# Language.
2237# The default value is: NO.
2238# This tag requires that the tag HAVE_DOT is set to YES.
2239
Alexander Afanasyev3aeeaeb2014-04-22 23:34:23 -07002240UML_LOOK = NO
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002241
2242# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2243# class node. If there are many fields or methods and many nodes the graph may
2244# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2245# number of items for each type to make the size more manageable. Set this to 0
2246# for no limit. Note that the threshold may be exceeded by 50% before the limit
2247# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2248# but if the number exceeds 15, the total amount of fields shown is limited to
2249# 10.
2250# Minimum value: 0, maximum value: 100, default value: 10.
2251# This tag requires that the tag HAVE_DOT is set to YES.
2252
2253UML_LIMIT_NUM_FIELDS = 10
2254
2255# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2256# collaboration graphs will show the relations between templates and their
2257# instances.
2258# The default value is: NO.
2259# This tag requires that the tag HAVE_DOT is set to YES.
2260
2261TEMPLATE_RELATIONS = YES
2262
2263# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2264# YES then doxygen will generate a graph for each documented file showing the
2265# direct and indirect include dependencies of the file with other documented
2266# files.
2267# The default value is: YES.
2268# This tag requires that the tag HAVE_DOT is set to YES.
2269
2270INCLUDE_GRAPH = YES
2271
2272# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2273# set to YES then doxygen will generate a graph for each documented file showing
2274# the direct and indirect include dependencies of the file with other documented
2275# files.
2276# The default value is: YES.
2277# This tag requires that the tag HAVE_DOT is set to YES.
2278
2279INCLUDED_BY_GRAPH = YES
2280
2281# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2282# dependency graph for every global function or class method.
2283#
2284# Note that enabling this option will significantly increase the time of a run.
2285# So in most cases it will be better to enable call graphs for selected
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002286# functions only using the \callgraph command. Disabling a call graph can be
2287# accomplished by means of the command \hidecallgraph.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002288# The default value is: NO.
2289# This tag requires that the tag HAVE_DOT is set to YES.
2290
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07002291CALL_GRAPH = NO
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002292
2293# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2294# dependency graph for every global function or class method.
2295#
2296# Note that enabling this option will significantly increase the time of a run.
2297# So in most cases it will be better to enable caller graphs for selected
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002298# functions only using the \callergraph command. Disabling a caller graph can be
2299# accomplished by means of the command \hidecallergraph.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002300# The default value is: NO.
2301# This tag requires that the tag HAVE_DOT is set to YES.
2302
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -07002303CALLER_GRAPH = NO
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002304
2305# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2306# hierarchy of all classes instead of a textual one.
2307# The default value is: YES.
2308# This tag requires that the tag HAVE_DOT is set to YES.
2309
2310GRAPHICAL_HIERARCHY = YES
2311
2312# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2313# dependencies a directory has on other directories in a graphical way. The
2314# dependency relations are determined by the #include relations between the
2315# files in the directories.
2316# The default value is: YES.
2317# This tag requires that the tag HAVE_DOT is set to YES.
2318
2319DIRECTORY_GRAPH = YES
2320
2321# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002322# generated by dot. For an explanation of the image formats see the section
2323# output formats in the documentation of the dot tool (Graphviz (see:
2324# http://www.graphviz.org/)).
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002325# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2326# to make the SVG files visible in IE 9+ (other browsers do not have this
2327# requirement).
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002328# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2329# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2330# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
2331# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2332# png:gdiplus:gdiplus.
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002333# The default value is: png.
2334# This tag requires that the tag HAVE_DOT is set to YES.
2335
2336DOT_IMAGE_FORMAT = svg
2337
2338# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2339# enable generation of interactive SVG images that allow zooming and panning.
2340#
2341# Note that this requires a modern browser other than Internet Explorer. Tested
2342# and working are Firefox, Chrome, Safari, and Opera.
2343# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2344# the SVG files visible. Older versions of IE do not have SVG support.
2345# The default value is: NO.
2346# This tag requires that the tag HAVE_DOT is set to YES.
2347
2348INTERACTIVE_SVG = NO
2349
2350# The DOT_PATH tag can be used to specify the path where the dot tool can be
2351# found. If left blank, it is assumed the dot tool can be found in the path.
2352# This tag requires that the tag HAVE_DOT is set to YES.
2353
2354DOT_PATH =
2355
2356# The DOTFILE_DIRS tag can be used to specify one or more directories that
2357# contain dot files that are included in the documentation (see the \dotfile
2358# command).
2359# This tag requires that the tag HAVE_DOT is set to YES.
2360
2361DOTFILE_DIRS =
2362
2363# The MSCFILE_DIRS tag can be used to specify one or more directories that
2364# contain msc files that are included in the documentation (see the \mscfile
2365# command).
2366
2367MSCFILE_DIRS =
2368
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002369# The DIAFILE_DIRS tag can be used to specify one or more directories that
2370# contain dia files that are included in the documentation (see the \diafile
2371# command).
2372
2373DIAFILE_DIRS =
2374
2375# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2376# path where java can find the plantuml.jar file. If left blank, it is assumed
2377# PlantUML is not used or called during a preprocessing step. Doxygen will
2378# generate a warning when it encounters a \startuml command in this case and
2379# will not generate output for the diagram.
2380
2381PLANTUML_JAR_PATH =
2382
2383# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2384# configuration file for plantuml.
2385
2386# PLANTUML_CFG_FILE =
2387
2388# When using plantuml, the specified paths are searched for files specified by
2389# the !include statement in a plantuml block.
2390
2391PLANTUML_INCLUDE_PATH =
2392
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002393# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2394# that will be shown in the graph. If the number of nodes in a graph becomes
2395# larger than this value, doxygen will truncate the graph, which is visualized
2396# by representing a node as a red box. Note that doxygen if the number of direct
2397# children of the root node in a graph is already larger than
2398# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2399# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2400# Minimum value: 0, maximum value: 10000, default value: 50.
2401# This tag requires that the tag HAVE_DOT is set to YES.
2402
Alexander Afanasyevf2a46222015-09-17 18:01:30 -07002403DOT_GRAPH_MAX_NODES = 10000
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002404
2405# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2406# generated by dot. A depth value of 3 means that only nodes reachable from the
2407# root by following a path via at most 3 edges will be shown. Nodes that lay
2408# further from the root node will be omitted. Note that setting this option to 1
2409# or 2 may greatly reduce the computation time needed for large code bases. Also
2410# note that the size of a graph can be further restricted by
2411# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2412# Minimum value: 0, maximum value: 1000, default value: 0.
2413# This tag requires that the tag HAVE_DOT is set to YES.
2414
2415MAX_DOT_GRAPH_DEPTH = 0
2416
2417# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2418# background. This is disabled by default, because dot on Windows does not seem
2419# to support this out of the box.
2420#
2421# Warning: Depending on the platform used, enabling this option may lead to
2422# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2423# read).
2424# The default value is: NO.
2425# This tag requires that the tag HAVE_DOT is set to YES.
2426
2427DOT_TRANSPARENT = YES
2428
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002429# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002430# files in one run (i.e. multiple -o and -T options on the command line). This
2431# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2432# this, this feature is disabled by default.
2433# The default value is: NO.
2434# This tag requires that the tag HAVE_DOT is set to YES.
2435
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002436DOT_MULTI_TARGETS = YES
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002437
2438# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2439# explaining the meaning of the various boxes and arrows in the dot generated
2440# graphs.
2441# The default value is: YES.
2442# This tag requires that the tag HAVE_DOT is set to YES.
2443
2444GENERATE_LEGEND = YES
2445
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -04002446# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
Alexander Afanasyev401a2362014-03-02 00:03:11 +00002447# files that are used to generate the various graphs.
2448# The default value is: YES.
2449# This tag requires that the tag HAVE_DOT is set to YES.
2450
2451DOT_CLEANUP = YES