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