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