3
# This file describes the settings to be used by the documentation system
4
# doxygen (www.doxygen.org) for a project.
6
# All text after a double hash (##) is considered a comment and is placed in
7
# front of the TAG it is preceding.
9
# All text after a single hash (#) is considered a comment and will be ignored.
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 (\" \").
16
#---------------------------------------------------------------------------
17
# Project related configuration options
18
#---------------------------------------------------------------------------
20
# This tag specifies the encoding used for all characters in the configuration
21
# file that follow. The default is UTF-8 which is also the encoding used for all
22
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
23
# iconv built into libc) for the transcoding. See
24
# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
25
# The default value is: UTF-8.
27
DOXYFILE_ENCODING = UTF-8
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.
35
PROJECT_NAME = "My Project"
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.
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.
49
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
50
# in the documentation. The maximum height of the logo should not exceed 55
51
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
52
# the logo to the output directory.
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.
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.
73
# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74
# characters to appear in the names of generated files. If set to NO, non-ASCII
75
# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
77
# The default value is: NO.
79
ALLOW_UNICODE_NAMES = NO
81
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
82
# documentation generated by doxygen is written. Doxygen will use this
83
# information to generate all constant output in the proper language.
84
# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
85
# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
86
# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
87
# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
88
# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
89
# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
90
# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
91
# Ukrainian and Vietnamese.
92
# The default value is: English.
94
OUTPUT_LANGUAGE = English
96
# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
97
# documentation generated by doxygen is written. Doxygen will use this
98
# information to generate all generated output in the proper direction.
99
# Possible values are: None, LTR, RTL and Context.
100
# The default value is: None.
102
OUTPUT_TEXT_DIRECTION = None
104
# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
105
# descriptions after the members that are listed in the file and class
106
# documentation (similar to Javadoc). Set to NO to disable this.
107
# The default value is: YES.
109
BRIEF_MEMBER_DESC = YES
111
# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
112
# description of a member or function before the detailed description
114
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
115
# brief descriptions will be completely suppressed.
116
# The default value is: YES.
120
# This tag implements a quasi-intelligent brief description abbreviator that is
121
# used to form the text in various listings. Each string in this list, if found
122
# as the leading text of the brief description, will be stripped from the text
123
# and the result, after processing the whole list, is used as the annotated
124
# text. Otherwise, the brief description is used as-is. If left blank, the
125
# following values are used ($name is automatically replaced with the name of
126
# the entity):The $name class, The $name widget, The $name file, is, provides,
127
# specifies, contains, represents, a, an and the.
129
ABBREVIATE_BRIEF = "The $name class" \
141
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
142
# doxygen will generate a detailed section even if there is only a brief
144
# The default value is: NO.
146
ALWAYS_DETAILED_SEC = NO
148
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
149
# inherited members of a class in the documentation of that class as if those
150
# members were ordinary class members. Constructors, destructors and assignment
151
# operators of the base classes will not be shown.
152
# The default value is: NO.
154
INLINE_INHERITED_MEMB = NO
156
# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
157
# before files name in the file list and in the header files. If set to NO the
158
# shortest path that makes the file name unique will be used
159
# The default value is: YES.
163
# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
164
# Stripping is only done if one of the specified strings matches the left-hand
165
# part of the path. The tag can be used to show relative paths in the file list.
166
# If left blank the directory from which doxygen is run is used as the path to
169
# Note that you can specify absolute paths here, but also relative paths, which
170
# will be relative from the directory where doxygen is started.
171
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
175
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
176
# path mentioned in the documentation of a class, which tells the reader which
177
# header file to include in order to use a class. If left blank only the name of
178
# the header file containing the class definition is used. Otherwise one should
179
# specify the list of include paths that are normally passed to the compiler
184
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
185
# less readable) file names. This can be useful is your file systems doesn't
186
# support long names like on DOS, Mac, or CD-ROM.
187
# The default value is: NO.
191
# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
192
# first line (until the first dot) of a Javadoc-style comment as the brief
193
# description. If set to NO, the Javadoc-style will behave just like regular Qt-
194
# style comments (thus requiring an explicit @brief command for a brief
196
# The default value is: NO.
198
JAVADOC_AUTOBRIEF = NO
200
# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
203
# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
204
# Javadoc-style will behave just like regular comments and it will not be
205
# interpreted by doxygen.
206
# The default value is: NO.
210
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
211
# line (until the first dot) of a Qt-style comment as the brief description. If
212
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
213
# requiring an explicit \brief command for a brief description.)
214
# The default value is: NO.
218
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
219
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
220
# a brief description. This used to be the default behavior. The new default is
221
# to treat a multi-line C++ comment block as a detailed description. Set this
222
# tag to YES if you prefer the old behavior instead.
224
# Note that setting this tag to YES also means that rational rose comments are
225
# not recognized any more.
226
# The default value is: NO.
228
MULTILINE_CPP_IS_BRIEF = NO
230
# By default Python docstrings are displayed as preformatted text and doxygen's
231
# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
232
# doxygen's special commands can be used and the contents of the docstring
233
# documentation blocks is shown as doxygen documentation.
234
# The default value is: YES.
236
PYTHON_DOCSTRING = YES
238
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
239
# documentation from any documented member that it re-implements.
240
# The default value is: YES.
244
# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
245
# page for each member. If set to NO, the documentation of a member will be part
246
# of the file/class/namespace that contains it.
247
# The default value is: NO.
249
SEPARATE_MEMBER_PAGES = NO
251
# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
252
# uses this value to replace tabs by spaces in code fragments.
253
# Minimum value: 1, maximum value: 16, default value: 4.
257
# This tag can be used to specify a number of aliases that act as commands in
258
# the documentation. An alias has the form:
261
# "sideeffect=@par Side Effects:\n"
262
# will allow you to put the command \sideeffect (or @sideeffect) in the
263
# documentation, which will result in a user-defined paragraph with heading
264
# "Side Effects:". You can put \n's in the value part of an alias to insert
265
# newlines (in the resulting output). You can put ^^ in the value part of an
266
# alias to insert a newline as if a physical newline was in the original file.
267
# When you need a literal { or } or , in the value part of an alias you have to268
# escape them by means of a backslash (\), this can lead to conflicts with the
269
# commands \{ and \} for these it is advised to use the version @{ and @} or use270
# a double escape (\\{ and \\})274
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
275
# only. Doxygen will then generate output that is more tailored for C. For
276
# instance, some of the names that are used will be different. The list of all
277
# members will be omitted, etc.
278
# The default value is: NO.
280
OPTIMIZE_OUTPUT_FOR_C = NO
282
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
283
# Python sources only. Doxygen will then generate output that is more tailored
284
# for that language. For instance, namespaces will be presented as packages,
285
# qualified scopes will look different, etc.
286
# The default value is: NO.
288
OPTIMIZE_OUTPUT_JAVA = NO
290
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
291
# sources. Doxygen will then generate output that is tailored for Fortran.
292
# The default value is: NO.
294
OPTIMIZE_FOR_FORTRAN = NO
296
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
297
# sources. Doxygen will then generate output that is tailored for VHDL.
298
# The default value is: NO.
300
OPTIMIZE_OUTPUT_VHDL = NO
302
# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
303
# sources only. Doxygen will then generate output that is more tailored for that
304
# language. For instance, namespaces will be presented as modules, types will be
305
# separated into more groups, etc.
306
# The default value is: NO.
308
OPTIMIZE_OUTPUT_SLICE = NO
310
# Doxygen selects the parser to use depending on the extension of the files it
311
# parses. With this tag you can assign which parser to use for a given
312
# extension. Doxygen has a built-in mapping, but you can override or extend it
313
# using this tag. The format is ext=language, where ext is a file extension, and
314
# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
315
# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL,
316
# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
317
# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
318
# tries to guess whether the code is fixed or free formatted code, this is the
319
# default for Fortran type files). For instance to make doxygen treat .inc files
320
# as Fortran files (default is PHP), and .f files as C (default is Fortran),
321
# use: inc=Fortran f=C.
323
# Note: For files without extension you can use no_extension as a placeholder.
325
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
326
# the files are not read by doxygen. When specifying no_extension you should add
327
# * to the FILE_PATTERNS.
329
# Note see also the list of default file extension mappings.
333
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
334
# according to the Markdown format, which allows for more readable
335
# documentation. See https://daringfireball.net/projects/markdown/ for details.
336
# The output of markdown processing is further processed by doxygen, so you can
337
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
338
# case of backward compatibilities issues.
339
# The default value is: YES.
341
MARKDOWN_SUPPORT = YES
343
# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
344
# to that level are automatically included in the table of contents, even if
345
# they do not have an id attribute.
346
# Note: This feature currently applies only to Markdown headings.
347
# Minimum value: 0, maximum value: 99, default value: 5.
348
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
350
TOC_INCLUDE_HEADINGS = 5
352
# When enabled doxygen tries to link words that correspond to documented
353
# classes, or namespaces to their corresponding documentation. Such a link can
354
# be prevented in individual cases by putting a % sign in front of the word or
355
# globally by setting AUTOLINK_SUPPORT to NO.
356
# The default value is: YES.
358
AUTOLINK_SUPPORT = YES
360
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
361
# to include (a tag file for) the STL sources as input, then you should set this
362
# tag to YES in order to let doxygen match functions declarations and
363
# definitions whose arguments contain STL classes (e.g. func(std::string);
364
# versus func(std::string) {}). This also make the inheritance and collaboration365
# diagrams that involve STL classes more complete and accurate.
366
# The default value is: NO.
368
BUILTIN_STL_SUPPORT = NO
370
# If you use Microsoft's C++/CLI language, you should set this option to YES to
371
# enable parsing support.
372
# The default value is: NO.
376
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
377
# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
378
# will parse them like normal C++ but will assume all classes use public instead
379
# of private inheritance when no explicit protection keyword is present.
380
# The default value is: NO.
384
# For Microsoft's IDL there are propget and propput attributes to indicate
385
# getter and setter methods for a property. Setting this option to YES will make
386
# doxygen to replace the get and set methods by a property in the documentation.
387
# This will only work if the methods are indeed getting or setting a simple
388
# type. If this is not the case, or you want to show the methods anyway, you
389
# should set this option to NO.
390
# The default value is: YES.
392
IDL_PROPERTY_SUPPORT = YES
394
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
395
# tag is set to YES then doxygen will reuse the documentation of the first
396
# member in the group (if any) for the other members of the group. By default
397
# all members of a group must be documented explicitly.
398
# The default value is: NO.
400
DISTRIBUTE_GROUP_DOC = NO
402
# If one adds a struct or class to a group and this option is enabled, then also
403
# any nested class or struct is added to the same group. By default this option
404
# is disabled and one has to add nested compounds explicitly via \ingroup.
405
# The default value is: NO.
407
GROUP_NESTED_COMPOUNDS = NO
409
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
410
# (for instance a group of public functions) to be put as a subgroup of that
411
# type (e.g. under the Public Functions section). Set it to NO to prevent
412
# subgrouping. Alternatively, this can be done per class using the
413
# \nosubgrouping command.
414
# The default value is: YES.
418
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
419
# are shown inside the group in which they are included (e.g. using \ingroup)
420
# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
423
# Note that this feature does not work in combination with
424
# SEPARATE_MEMBER_PAGES.
425
# The default value is: NO.
427
INLINE_GROUPED_CLASSES = NO
429
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
430
# with only public data fields or simple typedef fields will be shown inline in
431
# the documentation of the scope in which they are defined (i.e. file,
432
# namespace, or group documentation), provided this scope is documented. If set
433
# to NO, structs, classes, and unions are shown on a separate page (for HTML and
434
# Man pages) or section (for LaTeX and RTF).
435
# The default value is: NO.
437
INLINE_SIMPLE_STRUCTS = NO
439
# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
440
# enum is documented as struct, union, or enum with the name of the typedef. So
441
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct442
# with name TypeT. When disabled the typedef will appear as a member of a file,
443
# namespace, or class. And the struct will be named TypeS. This can typically be
444
# useful for C code in case the coding convention dictates that all compound
445
# types are typedef'ed and only the typedef is referenced, never the tag name.
446
# The default value is: NO.
448
TYPEDEF_HIDES_STRUCT = NO
450
# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
451
# cache is used to resolve symbols given their name and scope. Since this can be
452
# an expensive process and often the same symbol appears multiple times in the
453
# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
454
# doxygen will become slower. If the cache is too large, memory is wasted. The
455
# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
456
# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
457
# symbols. At the end of a run doxygen will report the cache usage and suggest
458
# the optimal cache size from a speed point of view.
459
# Minimum value: 0, maximum value: 9, default value: 0.
463
# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use
464
# during processing. When set to 0 doxygen will based this on the number of
465
# cores available in the system. You can set it explicitly to a value larger
466
# than 0 to get more control over the balance between CPU load and processing
467
# speed. At this moment only the input processing can be done using multiple
468
# threads. Since this is still an experimental feature the default is set to 1,
469
# which efficively disables parallel processing. Please report any issues you
470
# encounter. Generating dot graphs in parallel is controlled by the
471
# DOT_NUM_THREADS setting.
472
# Minimum value: 0, maximum value: 32, default value: 1.
476
#---------------------------------------------------------------------------
477
# Build related configuration options
478
#---------------------------------------------------------------------------
480
# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
481
# documentation are documented, even if no documentation was available. Private
482
# class members and static file members will be hidden unless the
483
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
484
# Note: This will also disable the warnings about undocumented members that are
485
# normally produced when WARNINGS is set to YES.
486
# The default value is: NO.
490
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
491
# be included in the documentation.
492
# The default value is: NO.
496
# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
497
# methods of a class will be included in the documentation.
498
# The default value is: NO.
500
EXTRACT_PRIV_VIRTUAL = NO
502
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
503
# scope will be included in the documentation.
504
# The default value is: NO.
508
# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
509
# included in the documentation.
510
# The default value is: NO.
514
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
515
# locally in source files will be included in the documentation. If set to NO,
516
# only classes defined in header files are included. Does not have any effect
518
# The default value is: YES.
520
EXTRACT_LOCAL_CLASSES = YES
522
# This flag is only useful for Objective-C code. If set to YES, local methods,
523
# which are defined in the implementation section but not in the interface are
524
# included in the documentation. If set to NO, only methods in the interface are
526
# The default value is: NO.
528
EXTRACT_LOCAL_METHODS = NO
530
# If this flag is set to YES, the members of anonymous namespaces will be
531
# extracted and appear in the documentation as a namespace called
532
# 'anonymous_namespace{file}', where file will be replaced with the base name of533
# the file that contains the anonymous namespace. By default anonymous namespace
535
# The default value is: NO.
537
EXTRACT_ANON_NSPACES = NO
539
# If this flag is set to YES, the name of an unnamed parameter in a declaration
540
# will be determined by the corresponding definition. By default unnamed
541
# parameters remain unnamed in the output.
542
# The default value is: YES.
544
RESOLVE_UNNAMED_PARAMS = YES
546
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
547
# undocumented members inside documented classes or files. If set to NO these
548
# members will be included in the various overviews, but no documentation
549
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
550
# The default value is: NO.
552
HIDE_UNDOC_MEMBERS = NO
554
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
555
# undocumented classes that are normally visible in the class hierarchy. If set
556
# to NO, these classes will be included in the various overviews. This option
557
# has no effect if EXTRACT_ALL is enabled.
558
# The default value is: NO.
560
HIDE_UNDOC_CLASSES = NO
562
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
563
# declarations. If set to NO, these declarations will be included in the
565
# The default value is: NO.
567
HIDE_FRIEND_COMPOUNDS = NO
569
# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
570
# documentation blocks found inside the body of a function. If set to NO, these
571
# blocks will be appended to the function's detailed documentation block.
572
# The default value is: NO.
574
HIDE_IN_BODY_DOCS = NO
576
# The INTERNAL_DOCS tag determines if documentation that is typed after a
577
# \internal command is included. If the tag is set to NO then the documentation
578
# will be excluded. Set it to YES to include the internal documentation.
579
# The default value is: NO.
583
# With the correct setting of option CASE_SENSE_NAMES doxygen will better be
584
# able to match the capabilities of the underlying filesystem. In case the
585
# filesystem is case sensitive (i.e. it supports files in the same directory
586
# whose names only differ in casing), the option must be set to YES to properly
587
# deal with such files in case they appear in the input. For filesystems that
588
# are not case sensitive the option should be be set to NO to properly deal with
589
# output files written for symbols that only differ in casing, such as for two
590
# classes, one named CLASS and the other named Class, and to also support
591
# references to files without having to specify the exact matching casing. On
592
# Windows (including Cygwin) and MacOS, users should typically set this option
593
# to NO, whereas on Linux or other Unix flavors it should typically be set to
595
# The default value is: system dependent.
597
CASE_SENSE_NAMES = YES
599
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
600
# their full class and namespace scopes in the documentation. If set to YES, the
601
# scope will be hidden.
602
# The default value is: NO.
606
# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
607
# append additional text to a page's title, such as Class Reference. If set to
608
# YES the compound reference will be hidden.
609
# The default value is: NO.
611
HIDE_COMPOUND_REFERENCE= NO
613
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
614
# the files that are included by a file in the documentation of that file.
615
# The default value is: YES.
617
SHOW_INCLUDE_FILES = YES
619
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
620
# grouped member an include statement to the documentation, telling the reader
621
# which file to include in order to use the member.
622
# The default value is: NO.
624
SHOW_GROUPED_MEMB_INC = NO
626
# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
627
# files with double quotes in the documentation rather than with sharp brackets.
628
# The default value is: NO.
630
FORCE_LOCAL_INCLUDES = NO
632
# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
633
# documentation for inline members.
634
# The default value is: YES.
638
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
639
# (detailed) documentation of file and class members alphabetically by member
640
# name. If set to NO, the members will appear in declaration order.
641
# The default value is: YES.
643
SORT_MEMBER_DOCS = YES
645
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
646
# descriptions of file, namespace and class members alphabetically by member
647
# name. If set to NO, the members will appear in declaration order. Note that
648
# this will also influence the order of the classes in the class list.
649
# The default value is: NO.
653
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
654
# (brief and detailed) documentation of class members so that constructors and
655
# destructors are listed first. If set to NO the constructors will appear in the
656
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
657
# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
658
# member documentation.
659
# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
660
# detailed member documentation.
661
# The default value is: NO.
663
SORT_MEMBERS_CTORS_1ST = NO
665
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
666
# of group names into alphabetical order. If set to NO the group names will
667
# appear in their defined order.
668
# The default value is: NO.
672
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
673
# fully-qualified names, including namespaces. If set to NO, the class list will
674
# be sorted only by class name, not including the namespace part.
675
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
676
# Note: This option applies only to the class list, not to the alphabetical
678
# The default value is: NO.
680
SORT_BY_SCOPE_NAME = NO
682
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
683
# type resolution of all parameters of a function it will reject a match between
684
# the prototype and the implementation of a member function even if there is
685
# only one candidate or it is obvious which candidate to choose by doing a
686
# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
687
# accept a match between prototype and implementation in such cases.
688
# The default value is: NO.
690
STRICT_PROTO_MATCHING = NO
692
# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
693
# list. This list is created by putting \todo commands in the documentation.
694
# The default value is: YES.
696
GENERATE_TODOLIST = YES
698
# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
699
# list. This list is created by putting \test commands in the documentation.
700
# The default value is: YES.
702
GENERATE_TESTLIST = YES
704
# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
705
# list. This list is created by putting \bug commands in the documentation.
706
# The default value is: YES.
708
GENERATE_BUGLIST = YES
710
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
711
# the deprecated list. This list is created by putting \deprecated commands in
713
# The default value is: YES.
715
GENERATE_DEPRECATEDLIST= YES
717
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
718
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
719
# ... \endcond blocks.
723
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
724
# initial value of a variable or macro / define can have for it to appear in the
725
# documentation. If the initializer consists of more lines than specified here
726
# it will be hidden. Use a value of 0 to hide initializers completely. The
727
# appearance of the value of individual variables and macros / defines can be
728
# controlled using \showinitializer or \hideinitializer command in the
729
# documentation regardless of this setting.
730
# Minimum value: 0, maximum value: 10000, default value: 30.
732
MAX_INITIALIZER_LINES = 30
734
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
735
# the bottom of the documentation of classes and structs. If set to YES, the
736
# list will mention the files that were used to generate the documentation.
737
# The default value is: YES.
741
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
742
# will remove the Files entry from the Quick Index and from the Folder Tree View
744
# The default value is: YES.
748
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
749
# page. This will remove the Namespaces entry from the Quick Index and from the
750
# Folder Tree View (if specified).
751
# The default value is: YES.
755
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
756
# doxygen should invoke to get the current version for each file (typically from
757
# the version control system). Doxygen will invoke the program by executing (via
758
# popen()) the command command input-file, where command is the value of the
759
# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
760
# by doxygen. Whatever the program writes to standard output is used as the file
761
# version. For an example see the documentation.
765
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
766
# by doxygen. The layout file controls the global structure of the generated
767
# output files in an output format independent way. To create the layout file
768
# that represents doxygen's defaults, run doxygen with the -l option. You can
769
# optionally specify a file name after the option, if omitted DoxygenLayout.xml
770
# will be used as the name of the layout file.
772
# Note that if you run doxygen from a directory containing a file called
773
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
778
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
779
# the reference definitions. This must be a list of .bib files. The .bib
780
# extension is automatically appended if omitted. This requires the bibtex tool
781
# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
782
# For LaTeX the style of the bibliography can be controlled using
783
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
784
# search path. See also \cite for info how to create references.
788
#---------------------------------------------------------------------------
789
# Configuration options related to warning and progress messages
790
#---------------------------------------------------------------------------
792
# The QUIET tag can be used to turn on/off the messages that are generated to
793
# standard output by doxygen. If QUIET is set to YES this implies that the
795
# The default value is: NO.
799
# The WARNINGS tag can be used to turn on/off the warning messages that are
800
# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
801
# this implies that the warnings are on.
803
# Tip: Turn warnings on while writing the documentation.
804
# The default value is: YES.
808
# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
809
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
810
# will automatically be disabled.
811
# The default value is: YES.
813
WARN_IF_UNDOCUMENTED = YES
815
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
816
# potential errors in the documentation, such as not documenting some parameters
817
# in a documented function, or documenting parameters that don't exist or using
818
# markup commands wrongly.
819
# The default value is: YES.
821
WARN_IF_DOC_ERROR = YES
823
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
824
# are documented, but have no documentation for their parameters or return
825
# value. If set to NO, doxygen will only warn about wrong or incomplete
826
# parameter documentation, but not about the absence of documentation. If
827
# EXTRACT_ALL is set to YES then this flag will automatically be disabled.
828
# The default value is: NO.
832
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
833
# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
834
# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
835
# at the end of the doxygen process doxygen will return with a non-zero status.
836
# Possible values are: NO, YES and FAIL_ON_WARNINGS.
837
# The default value is: NO.
841
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
842
# can produce. The string should contain the $file, $line, and $text tags, which
843
# will be replaced by the file and line number from which the warning originated
844
# and the warning text. Optionally the format may contain $version, which will
845
# be replaced by the version of the file (if it could be obtained via
846
# FILE_VERSION_FILTER)
847
# The default value is: $file:$line: $text.
849
WARN_FORMAT = "$file:$line: $text"
851
# The WARN_LOGFILE tag can be used to specify a file to which warning and error
852
# messages should be written. If left blank the output is written to standard
857
#---------------------------------------------------------------------------
858
# Configuration options related to the input files
859
#---------------------------------------------------------------------------
861
# The INPUT tag is used to specify the files and/or directories that contain
862
# documented source files. You may enter file names like myfile.cpp or
863
# directories like /usr/src/myproject. Separate the files or directories with
864
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
865
# Note: If this tag is empty the current directory is searched.
869
# This tag can be used to specify the character encoding of the source files
870
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
871
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
873
# https://www.gnu.org/software/libiconv/) for the list of possible encodings.
874
# The default value is: UTF-8.
876
INPUT_ENCODING = UTF-8
878
# If the value of the INPUT tag contains directories, you can use the
879
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
880
# *.h) to filter out the source-files in the directories.
882
# Note that for custom extensions or not directly supported extensions you also
883
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
886
# Note the list of default checked file patterns might differ from the list of
887
# default file extension mappings.
889
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
890
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
891
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
892
# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
893
# *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl,
894
# *.ucf, *.qsf and *.ice.
896
# FILE_PATTERNS = *.c \
942
# The RECURSIVE tag can be used to specify whether or not subdirectories should
943
# be searched for input files as well.
944
# The default value is: NO.
948
# The EXCLUDE tag can be used to specify files and/or directories that should be
949
# excluded from the INPUT source files. This way you can easily exclude a
950
# subdirectory from a directory tree whose root is specified with the INPUT tag.
952
# Note that relative paths are relative to the directory from which doxygen is
957
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
958
# directories that are symbolic links (a Unix file system feature) are excluded
960
# The default value is: NO.
964
# If the value of the INPUT tag contains directories, you can use the
965
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
966
# certain files from those directories.
968
# Note that the wildcards are matched against the file with absolute path, so to
969
# exclude all test directories for example use the pattern */test/*
973
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
974
# (namespaces, classes, functions, etc.) that should be excluded from the
975
# output. The symbol name can be a fully qualified name, a word, or if the
976
# wildcard * is used, a substring. Examples: ANamespace, AClass,
977
# AClass::ANamespace, ANamespace::*Test
979
# Note that the wildcards are matched against the file with absolute path, so to
980
# exclude all test directories use the pattern */test/*
984
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
985
# that contain example code fragments that are included (see the \include
990
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
991
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
992
# *.h) to filter out the source-files in the directories. If left blank all
997
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
998
# searched for input files to be used with the \include or \dontinclude commands
999
# irrespective of the value of the RECURSIVE tag.
1000
# The default value is: NO.
1002
EXAMPLE_RECURSIVE = NO
1004
# The IMAGE_PATH tag can be used to specify one or more files or directories
1005
# that contain images that are to be included in the documentation (see the
1010
# The INPUT_FILTER tag can be used to specify a program that doxygen should
1011
# invoke to filter for each input file. Doxygen will invoke the filter program
1012
# by executing (via popen()) the command:
1014
# <filter> <input-file>
1016
# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1017
# name of an input file. Doxygen will then use the output that the filter
1018
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
1021
# Note that the filter must not add or remove lines; it is applied before the
1022
# code is scanned, but not when the output code is generated. If lines are added
1023
# or removed, the anchors will not be placed correctly.
1025
# Note that for custom extensions or not directly supported extensions you also
1026
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1027
# properly processed by doxygen.
1031
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1032
# basis. Doxygen will compare the file name with each pattern and apply the
1033
# filter if there is a match. The filters are a list of the form: pattern=filter
1034
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
1035
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1036
# patterns match the file name, INPUT_FILTER is applied.
1038
# Note that for custom extensions or not directly supported extensions you also
1039
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1040
# properly processed by doxygen.
1044
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1045
# INPUT_FILTER) will also be used to filter the input files that are used for
1046
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1047
# The default value is: NO.
1049
FILTER_SOURCE_FILES = NO
1051
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1052
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1053
# it is also possible to disable source filtering for a specific pattern using
1054
# *.ext= (so without naming a filter).
1055
# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1057
FILTER_SOURCE_PATTERNS =
1059
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1060
# is part of the input, its contents will be placed on the main page
1061
# (index.html). This can be useful if you have a project on for instance GitHub
1062
# and want to reuse the introduction page also for the doxygen output.
1064
USE_MDFILE_AS_MAINPAGE =
1066
#---------------------------------------------------------------------------
1067
# Configuration options related to source browsing
1068
#---------------------------------------------------------------------------
1070
# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1071
# generated. Documented entities will be cross-referenced with these sources.
1073
# Note: To get rid of all source code in the generated output, make sure that
1074
# also VERBATIM_HEADERS is set to NO.
1075
# The default value is: NO.
1079
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
1080
# classes and enums directly into the documentation.
1081
# The default value is: NO.
1085
# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1086
# special comment blocks from generated source code fragments. Normal C, C++ and
1087
# Fortran comments will always remain visible.
1088
# The default value is: YES.
1090
STRIP_CODE_COMMENTS = YES
1092
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1093
# entity all documented functions referencing it will be listed.
1094
# The default value is: NO.
1096
REFERENCED_BY_RELATION = NO
1098
# If the REFERENCES_RELATION tag is set to YES then for each documented function
1099
# all documented entities called/used by that function will be listed.
1100
# The default value is: NO.
1102
REFERENCES_RELATION = NO
1104
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1105
# to YES then the hyperlinks from functions in REFERENCES_RELATION and
1106
# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1107
# link to the documentation.
1108
# The default value is: YES.
1110
REFERENCES_LINK_SOURCE = YES
1112
# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1113
# source code will show a tooltip with additional information such as prototype,
1114
# brief description and links to the definition and documentation. Since this
1115
# will make the HTML file larger and loading of large files a bit slower, you
1116
# can opt to disable this feature.
1117
# The default value is: YES.
1118
# This tag requires that the tag SOURCE_BROWSER is set to YES.
1120
SOURCE_TOOLTIPS = YES
1122
# If the USE_HTAGS tag is set to YES then the references to source code will
1123
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
1124
# source browser. The htags tool is part of GNU's global source tagging system
1125
# (see https://www.gnu.org/software/global/global.html). You will need version
1128
# To use it do the following:
1129
# - Install the latest version of global
1130
# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1131
# - Make sure the INPUT points to the root of the source tree
1132
# - Run doxygen as normal
1134
# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1135
# tools must be available from the command line (i.e. in the search path).
1137
# The result: instead of the source browser generated by doxygen, the links to
1138
# source code will now point to the output of htags.
1139
# The default value is: NO.
1140
# This tag requires that the tag SOURCE_BROWSER is set to YES.
1144
# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1145
# verbatim copy of the header file for each class for which an include is
1146
# specified. Set to NO to disable this.
1147
# See also: Section \class.
1148
# The default value is: YES.
1150
VERBATIM_HEADERS = YES
1152
#---------------------------------------------------------------------------
1153
# Configuration options related to the alphabetical class index
1154
#---------------------------------------------------------------------------
1156
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1157
# compounds will be generated. Enable this if the project contains a lot of
1158
# classes, structs, unions or interfaces.
1159
# The default value is: YES.
1161
ALPHABETICAL_INDEX = YES
1163
# In case all classes in a project start with a common prefix, all classes will
1164
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1165
# can be used to specify a prefix (or a list of prefixes) that should be ignored
1166
# while generating the index headers.
1167
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1171
#---------------------------------------------------------------------------
1172
# Configuration options related to the HTML output
1173
#---------------------------------------------------------------------------
1175
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1176
# The default value is: YES.
1180
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1181
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1183
# The default directory is: html.
1184
# This tag requires that the tag GENERATE_HTML is set to YES.
1188
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1189
# generated HTML page (for example: .htm, .php, .asp).
1190
# The default value is: .html.
1191
# This tag requires that the tag GENERATE_HTML is set to YES.
1193
HTML_FILE_EXTENSION = .html
1195
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1196
# each generated HTML page. If the tag is left blank doxygen will generate a
1199
# To get valid HTML the header file that includes any scripts and style sheets
1200
# that doxygen needs, which is dependent on the configuration options used (e.g.
1201
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1202
# default header using
1203
# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1205
# and then modify the file new_header.html. See also section "Doxygen usage"
1206
# for information on how to generate the default header that doxygen normally
1208
# Note: The header is subject to change so you typically have to regenerate the
1209
# default header when upgrading to a newer version of doxygen. For a description
1210
# of the possible markers and block names see the documentation.
1211
# This tag requires that the tag GENERATE_HTML is set to YES.
1215
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1216
# generated HTML page. If the tag is left blank doxygen will generate a standard
1217
# footer. See HTML_HEADER for more information on how to generate a default
1218
# footer and what special commands can be used inside the footer. See also
1219
# section "Doxygen usage" for information on how to generate the default footer
1220
# that doxygen normally uses.
1221
# This tag requires that the tag GENERATE_HTML is set to YES.
1225
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1226
# sheet that is used by each HTML page. It can be used to fine-tune the look of
1227
# the HTML output. If left blank doxygen will generate a default style sheet.
1228
# See also section "Doxygen usage" for information on how to generate the style
1229
# sheet that doxygen normally uses.
1230
# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1231
# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1233
# This tag requires that the tag GENERATE_HTML is set to YES.
1237
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1238
# cascading style sheets that are included after the standard style sheets
1239
# created by doxygen. Using this option one can overrule certain style aspects.
1240
# This is preferred over using HTML_STYLESHEET since it does not replace the
1241
# standard style sheet and is therefore more robust against future updates.
1242
# Doxygen will copy the style sheet files to the output directory.
1243
# Note: The order of the extra style sheet files is of importance (e.g. the last
1244
# style sheet in the list overrules the setting of the previous ones in the
1245
# list). For an example see the documentation.
1246
# This tag requires that the tag GENERATE_HTML is set to YES.
1248
HTML_EXTRA_STYLESHEET =
1250
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1251
# other source files which should be copied to the HTML output directory. Note
1252
# that these files will be copied to the base HTML output directory. Use the
1253
# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1254
# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1255
# files will be copied as-is; there are no commands or markers available.
1256
# This tag requires that the tag GENERATE_HTML is set to YES.
1260
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1261
# will adjust the colors in the style sheet and background images according to
1262
# this color. Hue is specified as an angle on a colorwheel, see
1263
# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1264
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1265
# purple, and 360 is red again.
1266
# Minimum value: 0, maximum value: 359, default value: 220.
1267
# This tag requires that the tag GENERATE_HTML is set to YES.
1269
HTML_COLORSTYLE_HUE = 220
1271
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1272
# in the HTML output. For a value of 0 the output will use grayscales only. A
1273
# value of 255 will produce the most vivid colors.
1274
# Minimum value: 0, maximum value: 255, default value: 100.
1275
# This tag requires that the tag GENERATE_HTML is set to YES.
1277
HTML_COLORSTYLE_SAT = 100
1279
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1280
# luminance component of the colors in the HTML output. Values below 100
1281
# gradually make the output lighter, whereas values above 100 make the output
1282
# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1283
# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1285
# Minimum value: 40, maximum value: 240, default value: 80.
1286
# This tag requires that the tag GENERATE_HTML is set to YES.
1288
HTML_COLORSTYLE_GAMMA = 80
1290
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1291
# page will contain the date and time when the page was generated. Setting this
1292
# to YES can help to show when doxygen was last run and thus if the
1293
# documentation is up to date.
1294
# The default value is: NO.
1295
# This tag requires that the tag GENERATE_HTML is set to YES.
1299
# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1300
# documentation will contain a main index with vertical navigation menus that
1301
# are dynamically created via JavaScript. If disabled, the navigation index will
1302
# consists of multiple levels of tabs that are statically embedded in every HTML
1303
# page. Disable this option to support browsers that do not have JavaScript,
1304
# like the Qt help browser.
1305
# The default value is: YES.
1306
# This tag requires that the tag GENERATE_HTML is set to YES.
1308
HTML_DYNAMIC_MENUS = YES
1310
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1311
# documentation will contain sections that can be hidden and shown after the
1313
# The default value is: NO.
1314
# This tag requires that the tag GENERATE_HTML is set to YES.
1316
HTML_DYNAMIC_SECTIONS = NO
1318
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1319
# shown in the various tree structured indices initially; the user can expand
1320
# and collapse entries dynamically later on. Doxygen will expand the tree to
1321
# such a level that at most the specified number of entries are visible (unless
1322
# a fully collapsed tree already exceeds this amount). So setting the number of
1323
# entries 1 will produce a full collapsed tree by default. 0 is a special value
1324
# representing an infinite number of entries and will result in a full expanded
1326
# Minimum value: 0, maximum value: 9999, default value: 100.
1327
# This tag requires that the tag GENERATE_HTML is set to YES.
1329
HTML_INDEX_NUM_ENTRIES = 100
1331
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1332
# generated that can be used as input for Apple's Xcode 3 integrated development
1334
# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
1335
# create a documentation set, doxygen will generate a Makefile in the HTML
1336
# output directory. Running make will produce the docset in that directory and
1337
# running make install will install the docset in
1338
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1339
# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1340
# genXcode/_index.html for more information.
1341
# The default value is: NO.
1342
# This tag requires that the tag GENERATE_HTML is set to YES.
1346
# This tag determines the name of the docset feed. A documentation feed provides
1347
# an umbrella under which multiple documentation sets from a single provider
1348
# (such as a company or product suite) can be grouped.
1349
# The default value is: Doxygen generated docs.
1350
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1352
DOCSET_FEEDNAME = "Doxygen generated docs"
1354
# This tag specifies a string that should uniquely identify the documentation
1355
# set bundle. This should be a reverse domain-name style string, e.g.
1356
# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1357
# The default value is: org.doxygen.Project.
1358
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1360
DOCSET_BUNDLE_ID = org.doxygen.Project
1362
# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1363
# the documentation publisher. This should be a reverse domain-name style
1364
# string, e.g. com.mycompany.MyDocSet.documentation.
1365
# The default value is: org.doxygen.Publisher.
1366
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1368
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1370
# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1371
# The default value is: Publisher.
1372
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1374
DOCSET_PUBLISHER_NAME = Publisher
1376
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1377
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1378
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1380
# https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows.
1382
# The HTML Help Workshop contains a compiler that can convert all HTML output
1383
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1384
# files are now used as the Windows 98 help format, and will replace the old
1385
# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1386
# HTML files also contain an index, a table of contents, and you can search for
1387
# words in the documentation. The HTML workshop also contains a viewer for
1388
# compressed HTML files.
1389
# The default value is: NO.
1390
# This tag requires that the tag GENERATE_HTML is set to YES.
1392
GENERATE_HTMLHELP = NO
1394
# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1395
# file. You can add a path in front of the file if the result should not be
1396
# written to the html output directory.
1397
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1401
# The HHC_LOCATION tag can be used to specify the location (absolute path
1402
# including file name) of the HTML help compiler (hhc.exe). If non-empty,
1403
# doxygen will try to run the HTML help compiler on the generated index.hhp.
1404
# The file has to be specified with full path.
1405
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1409
# The GENERATE_CHI flag controls if a separate .chi index file is generated
1410
# (YES) or that it should be included in the main .chm file (NO).
1411
# The default value is: NO.
1412
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1416
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1417
# and project file content.
1418
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1422
# The BINARY_TOC flag controls whether a binary table of contents is generated
1423
# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1424
# enables the Previous and Next buttons.
1425
# The default value is: NO.
1426
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1430
# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1431
# the table of contents of the HTML help documentation and to the tree view.
1432
# The default value is: NO.
1433
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1437
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1438
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1439
# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1440
# (.qch) of the generated HTML documentation.
1441
# The default value is: NO.
1442
# This tag requires that the tag GENERATE_HTML is set to YES.
1446
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1447
# the file name of the resulting .qch file. The path specified is relative to
1448
# the HTML output folder.
1449
# This tag requires that the tag GENERATE_QHP is set to YES.
1453
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1454
# Project output. For more information please see Qt Help Project / Namespace
1456
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1457
# The default value is: org.doxygen.Project.
1458
# This tag requires that the tag GENERATE_QHP is set to YES.
1460
QHP_NAMESPACE = org.doxygen.Project
1462
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1463
# Help Project output. For more information please see Qt Help Project / Virtual
1465
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
1466
# The default value is: doc.
1467
# This tag requires that the tag GENERATE_QHP is set to YES.
1469
QHP_VIRTUAL_FOLDER = doc
1471
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1472
# filter to add. For more information please see Qt Help Project / Custom
1474
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1475
# This tag requires that the tag GENERATE_QHP is set to YES.
1477
QHP_CUST_FILTER_NAME =
1479
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1480
# custom filter to add. For more information please see Qt Help Project / Custom
1482
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1483
# This tag requires that the tag GENERATE_QHP is set to YES.
1485
QHP_CUST_FILTER_ATTRS =
1487
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1488
# project's filter section matches. Qt Help Project / Filter Attributes (see:
1489
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1490
# This tag requires that the tag GENERATE_QHP is set to YES.
1492
QHP_SECT_FILTER_ATTRS =
1494
# The QHG_LOCATION tag can be used to specify the location (absolute path
1495
# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1496
# run qhelpgenerator on the generated .qhp file.
1497
# This tag requires that the tag GENERATE_QHP is set to YES.
1501
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1502
# generated, together with the HTML files, they form an Eclipse help plugin. To
1503
# install this plugin and make it available under the help contents menu in
1504
# Eclipse, the contents of the directory containing the HTML and XML files needs
1505
# to be copied into the plugins directory of eclipse. The name of the directory
1506
# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1507
# After copying Eclipse needs to be restarted before the help appears.
1508
# The default value is: NO.
1509
# This tag requires that the tag GENERATE_HTML is set to YES.
1511
GENERATE_ECLIPSEHELP = NO
1513
# A unique identifier for the Eclipse help plugin. When installing the plugin
1514
# the directory name containing the HTML and XML files should also have this
1515
# name. Each documentation set should have its own identifier.
1516
# The default value is: org.doxygen.Project.
1517
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1519
ECLIPSE_DOC_ID = org.doxygen.Project
1521
# If you want full control over the layout of the generated HTML pages it might
1522
# be necessary to disable the index and replace it with your own. The
1523
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1524
# of each HTML page. A value of NO enables the index and the value YES disables
1525
# it. Since the tabs in the index contain the same information as the navigation
1526
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1527
# The default value is: NO.
1528
# This tag requires that the tag GENERATE_HTML is set to YES.
1532
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1533
# structure should be generated to display hierarchical information. If the tag
1534
# value is set to YES, a side panel will be generated containing a tree-like
1535
# index structure (just like the one that is generated for HTML Help). For this
1536
# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1537
# (i.e. any modern browser). Windows users are probably better off using the
1538
# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1539
# further fine-tune the look of the index. As an example, the default style
1540
# sheet generated by doxygen has an example that shows how to put an image at
1541
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1542
# the same information as the tab index, you could consider setting
1543
# DISABLE_INDEX to YES when enabling this option.
1544
# The default value is: NO.
1545
# This tag requires that the tag GENERATE_HTML is set to YES.
1547
GENERATE_TREEVIEW = NO
1549
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1550
# doxygen will group on one line in the generated HTML documentation.
1552
# Note that a value of 0 will completely suppress the enum values from appearing
1553
# in the overview section.
1554
# Minimum value: 0, maximum value: 20, default value: 4.
1555
# This tag requires that the tag GENERATE_HTML is set to YES.
1557
ENUM_VALUES_PER_LINE = 4
1559
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1560
# to set the initial width (in pixels) of the frame in which the tree is shown.
1561
# Minimum value: 0, maximum value: 1500, default value: 250.
1562
# This tag requires that the tag GENERATE_HTML is set to YES.
1566
# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1567
# external symbols imported via tag files in a separate window.
1568
# The default value is: NO.
1569
# This tag requires that the tag GENERATE_HTML is set to YES.
1571
EXT_LINKS_IN_WINDOW = NO
1573
# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1574
# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
1575
# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
1576
# the HTML output. These images will generally look nicer at scaled resolutions.
1577
# Possible values are: png (the default) and svg (looks nicer but requires the
1578
# pdf2svg or inkscape tool).
1579
# The default value is: png.
1580
# This tag requires that the tag GENERATE_HTML is set to YES.
1582
HTML_FORMULA_FORMAT = png
1584
# Use this tag to change the font size of LaTeX formulas included as images in
1585
# the HTML documentation. When you change the font size after a successful
1586
# doxygen run you need to manually remove any form_*.png images from the HTML
1587
# output directory to force them to be regenerated.
1588
# Minimum value: 8, maximum value: 50, default value: 10.
1589
# This tag requires that the tag GENERATE_HTML is set to YES.
1591
FORMULA_FONTSIZE = 10
1593
# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1594
# generated for formulas are transparent PNGs. Transparent PNGs are not
1595
# supported properly for IE 6.0, but are supported on all modern browsers.
1597
# Note that when changing this option you need to delete any form_*.png files in
1598
# the HTML output directory before the changes have effect.
1599
# The default value is: YES.
1600
# This tag requires that the tag GENERATE_HTML is set to YES.
1602
FORMULA_TRANSPARENT = YES
1604
# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
1605
# to create new LaTeX commands to be used in formulas as building blocks. See
1606
# the section "Including formulas" for details.
1610
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1611
# https://www.mathjax.org) which uses client side JavaScript for the rendering
1612
# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1613
# installed or if you want to formulas look prettier in the HTML output. When
1614
# enabled you may also need to install MathJax separately and configure the path
1615
# to it using the MATHJAX_RELPATH option.
1616
# The default value is: NO.
1617
# This tag requires that the tag GENERATE_HTML is set to YES.
1621
# When MathJax is enabled you can set the default output format to be used for
1622
# the MathJax output. See the MathJax site (see:
1623
# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details.
1624
# Possible values are: HTML-CSS (which is slower, but has the best
1625
# compatibility), NativeMML (i.e. MathML) and SVG.
1626
# The default value is: HTML-CSS.
1627
# This tag requires that the tag USE_MATHJAX is set to YES.
1629
MATHJAX_FORMAT = HTML-CSS
1631
# When MathJax is enabled you need to specify the location relative to the HTML
1632
# output directory using the MATHJAX_RELPATH option. The destination directory
1633
# should contain the MathJax.js script. For instance, if the mathjax directory
1634
# is located at the same level as the HTML output directory, then
1635
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1636
# Content Delivery Network so you can quickly see the result without installing
1637
# MathJax. However, it is strongly recommended to install a local copy of
1638
# MathJax from https://www.mathjax.org before deployment.
1639
# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2.
1640
# This tag requires that the tag USE_MATHJAX is set to YES.
1642
MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2
1644
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1645
# extension names that should be enabled during MathJax rendering. For example
1646
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1647
# This tag requires that the tag USE_MATHJAX is set to YES.
1651
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1652
# of code that will be used on startup of the MathJax code. See the MathJax site
1654
# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
1655
# example see the documentation.
1656
# This tag requires that the tag USE_MATHJAX is set to YES.
1660
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1661
# the HTML output. The underlying search engine uses javascript and DHTML and
1662
# should work on any modern browser. Note that when using HTML help
1663
# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1664
# there is already a search function so this one should typically be disabled.
1665
# For large projects the javascript based search engine can be slow, then
1666
# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1667
# search using the keyboard; to jump to the search box use <access key> + S
1668
# (what the <access key> is depends on the OS and browser, but it is typically
1669
# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1670
# key> to jump into the search results window, the results can be navigated
1671
# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1672
# the search. The filter options can be selected when the cursor is inside the
1673
# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1674
# to select a filter and <Enter> or <escape> to activate or cancel the filter
1676
# The default value is: YES.
1677
# This tag requires that the tag GENERATE_HTML is set to YES.
1681
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1682
# implemented using a web server instead of a web client using JavaScript. There
1683
# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1684
# setting. When disabled, doxygen will generate a PHP script for searching and
1685
# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1686
# and searching needs to be provided by external tools. See the section
1687
# "External Indexing and Searching" for details.
1688
# The default value is: NO.
1689
# This tag requires that the tag SEARCHENGINE is set to YES.
1691
SERVER_BASED_SEARCH = NO
1693
# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1694
# script for searching. Instead the search results are written to an XML file
1695
# which needs to be processed by an external indexer. Doxygen will invoke an
1696
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1699
# Doxygen ships with an example indexer (doxyindexer) and search engine
1700
# (doxysearch.cgi) which are based on the open source search engine library
1702
# https://xapian.org/).
1704
# See the section "External Indexing and Searching" for details.
1705
# The default value is: NO.
1706
# This tag requires that the tag SEARCHENGINE is set to YES.
1710
# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1711
# which will return the search results when EXTERNAL_SEARCH is enabled.
1713
# Doxygen ships with an example indexer (doxyindexer) and search engine
1714
# (doxysearch.cgi) which are based on the open source search engine library
1716
# https://xapian.org/). See the section "External Indexing and Searching" for
1718
# This tag requires that the tag SEARCHENGINE is set to YES.
1722
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1723
# search data is written to a file for indexing by an external tool. With the
1724
# SEARCHDATA_FILE tag the name of this file can be specified.
1725
# The default file is: searchdata.xml.
1726
# This tag requires that the tag SEARCHENGINE is set to YES.
1728
SEARCHDATA_FILE = searchdata.xml
1730
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1731
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1732
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1733
# projects and redirect the results back to the right project.
1734
# This tag requires that the tag SEARCHENGINE is set to YES.
1738
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1739
# projects other than the one defined by this configuration file, but that are
1740
# all added to the same external search index. Each project needs to have a
1741
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1742
# to a relative location where the documentation can be found. The format is:
1743
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1744
# This tag requires that the tag SEARCHENGINE is set to YES.
1746
EXTRA_SEARCH_MAPPINGS =
1748
#---------------------------------------------------------------------------
1749
# Configuration options related to the LaTeX output
1750
#---------------------------------------------------------------------------
1752
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1753
# The default value is: YES.
1757
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1758
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1760
# The default directory is: latex.
1761
# This tag requires that the tag GENERATE_LATEX is set to YES.
1765
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1768
# Note that when not enabling USE_PDFLATEX the default is latex when enabling
1769
# USE_PDFLATEX the default is pdflatex and when in the later case latex is
1770
# chosen this is overwritten by pdflatex. For specific output languages the
1771
# default can have been set differently, this depends on the implementation of
1772
# the output language.
1773
# This tag requires that the tag GENERATE_LATEX is set to YES.
1777
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1779
# Note: This tag is used in the Makefile / make.bat.
1780
# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
1782
# The default file is: makeindex.
1783
# This tag requires that the tag GENERATE_LATEX is set to YES.
1785
MAKEINDEX_CMD_NAME = makeindex
1787
# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
1788
# generate index for LaTeX. In case there is no backslash (\) as first character
1789
# it will be automatically added in the LaTeX code.
1790
# Note: This tag is used in the generated output file (.tex).
1791
# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
1792
# The default value is: makeindex.
1793
# This tag requires that the tag GENERATE_LATEX is set to YES.
1795
LATEX_MAKEINDEX_CMD = makeindex
1797
# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1798
# documents. This may be useful for small projects and may help to save some
1800
# The default value is: NO.
1801
# This tag requires that the tag GENERATE_LATEX is set to YES.
1805
# The PAPER_TYPE tag can be used to set the paper type that is used by the
1807
# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1808
# 14 inches) and executive (7.25 x 10.5 inches).
1809
# The default value is: a4.
1810
# This tag requires that the tag GENERATE_LATEX is set to YES.
1814
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1815
# that should be included in the LaTeX output. The package can be specified just
1816
# by its name or with the correct syntax as to be used with the LaTeX
1817
# \usepackage command. To get the times font for instance you can specify :
1818
# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}1819
# To use the option intlimits with the amsmath package you can specify:
1820
# EXTRA_PACKAGES=[intlimits]{amsmath}1821
# If left blank no extra packages will be included.
1822
# This tag requires that the tag GENERATE_LATEX is set to YES.
1826
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1827
# generated LaTeX document. The header should contain everything until the first
1828
# chapter. If it is left blank doxygen will generate a standard header. See
1829
# section "Doxygen usage" for information on how to let doxygen write the
1830
# default header to a separate file.
1832
# Note: Only use a user-defined header if you know what you are doing! The
1833
# following commands have a special meaning inside the header: $title,
1834
# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1835
# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1836
# string, for the replacement values of the other commands the user is referred
1838
# This tag requires that the tag GENERATE_LATEX is set to YES.
1842
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1843
# generated LaTeX document. The footer should contain everything after the last
1844
# chapter. If it is left blank doxygen will generate a standard footer. See
1845
# LATEX_HEADER for more information on how to generate a default footer and what
1846
# special commands can be used inside the footer.
1848
# Note: Only use a user-defined footer if you know what you are doing!
1849
# This tag requires that the tag GENERATE_LATEX is set to YES.
1853
# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1854
# LaTeX style sheets that are included after the standard style sheets created
1855
# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1856
# will copy the style sheet files to the output directory.
1857
# Note: The order of the extra style sheet files is of importance (e.g. the last
1858
# style sheet in the list overrules the setting of the previous ones in the
1860
# This tag requires that the tag GENERATE_LATEX is set to YES.
1862
LATEX_EXTRA_STYLESHEET =
1864
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1865
# other source files which should be copied to the LATEX_OUTPUT output
1866
# directory. Note that the files will be copied as-is; there are no commands or
1868
# This tag requires that the tag GENERATE_LATEX is set to YES.
1872
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1873
# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1874
# contain links (just like the HTML output) instead of page references. This
1875
# makes the output suitable for online browsing using a PDF viewer.
1876
# The default value is: YES.
1877
# This tag requires that the tag GENERATE_LATEX is set to YES.
1881
# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
1882
# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
1883
# files. Set this option to YES, to get a higher quality PDF documentation.
1885
# See also section LATEX_CMD_NAME for selecting the engine.
1886
# The default value is: YES.
1887
# This tag requires that the tag GENERATE_LATEX is set to YES.
1891
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1892
# command to the generated LaTeX files. This will instruct LaTeX to keep running
1893
# if errors occur, instead of asking the user for help. This option is also used
1894
# when generating formulas in HTML.
1895
# The default value is: NO.
1896
# This tag requires that the tag GENERATE_LATEX is set to YES.
1900
# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1901
# index chapters (such as File Index, Compound Index, etc.) in the output.
1902
# The default value is: NO.
1903
# This tag requires that the tag GENERATE_LATEX is set to YES.
1905
LATEX_HIDE_INDICES = NO
1907
# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1908
# code with syntax highlighting in the LaTeX output.
1910
# Note that which sources are shown also depends on other settings such as
1912
# The default value is: NO.
1913
# This tag requires that the tag GENERATE_LATEX is set to YES.
1915
LATEX_SOURCE_CODE = NO
1917
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1918
# bibliography, e.g. plainnat, or ieeetr. See
1919
# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1920
# The default value is: plain.
1921
# This tag requires that the tag GENERATE_LATEX is set to YES.
1923
LATEX_BIB_STYLE = plain
1925
# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1926
# page will contain the date and time when the page was generated. Setting this
1927
# to NO can help when comparing the output of multiple runs.
1928
# The default value is: NO.
1929
# This tag requires that the tag GENERATE_LATEX is set to YES.
1933
# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
1934
# path from which the emoji images will be read. If a relative path is entered,
1935
# it will be relative to the LATEX_OUTPUT directory. If left blank the
1936
# LATEX_OUTPUT directory will be used.
1937
# This tag requires that the tag GENERATE_LATEX is set to YES.
1939
LATEX_EMOJI_DIRECTORY =
1941
#---------------------------------------------------------------------------
1942
# Configuration options related to the RTF output
1943
#---------------------------------------------------------------------------
1945
# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1946
# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1948
# The default value is: NO.
1952
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1953
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1955
# The default directory is: rtf.
1956
# This tag requires that the tag GENERATE_RTF is set to YES.
1960
# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1961
# documents. This may be useful for small projects and may help to save some
1963
# The default value is: NO.
1964
# This tag requires that the tag GENERATE_RTF is set to YES.
1968
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1969
# contain hyperlink fields. The RTF file will contain links (just like the HTML
1970
# output) instead of page references. This makes the output suitable for online
1971
# browsing using Word or some other Word compatible readers that support those
1974
# Note: WordPad (write) and others do not support links.
1975
# The default value is: NO.
1976
# This tag requires that the tag GENERATE_RTF is set to YES.
1980
# Load stylesheet definitions from file. Syntax is similar to doxygen's
1981
# configuration file, i.e. a series of assignments. You only have to provide
1982
# replacements, missing definitions are set to their default value.
1984
# See also section "Doxygen usage" for information on how to generate the
1985
# default style sheet that doxygen normally uses.
1986
# This tag requires that the tag GENERATE_RTF is set to YES.
1988
RTF_STYLESHEET_FILE =
1990
# Set optional variables used in the generation of an RTF document. Syntax is
1991
# similar to doxygen's configuration file. A template extensions file can be
1992
# generated using doxygen -e rtf extensionFile.
1993
# This tag requires that the tag GENERATE_RTF is set to YES.
1995
RTF_EXTENSIONS_FILE =
1997
# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1998
# with syntax highlighting in the RTF output.
2000
# Note that which sources are shown also depends on other settings such as
2002
# The default value is: NO.
2003
# This tag requires that the tag GENERATE_RTF is set to YES.
2007
#---------------------------------------------------------------------------
2008
# Configuration options related to the man page output
2009
#---------------------------------------------------------------------------
2011
# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2013
# The default value is: NO.
2017
# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2018
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2019
# it. A directory man3 will be created inside the directory specified by
2021
# The default directory is: man.
2022
# This tag requires that the tag GENERATE_MAN is set to YES.
2026
# The MAN_EXTENSION tag determines the extension that is added to the generated
2027
# man pages. In case the manual section does not start with a number, the number
2028
# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2030
# The default value is: .3.
2031
# This tag requires that the tag GENERATE_MAN is set to YES.
2035
# The MAN_SUBDIR tag determines the name of the directory created within
2036
# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2037
# MAN_EXTENSION with the initial . removed.
2038
# This tag requires that the tag GENERATE_MAN is set to YES.
2042
# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2043
# will generate one additional man file for each entity documented in the real
2044
# man page(s). These additional files only source the real man page, but without
2045
# them the man command would be unable to find the correct page.
2046
# The default value is: NO.
2047
# This tag requires that the tag GENERATE_MAN is set to YES.
2051
#---------------------------------------------------------------------------
2052
# Configuration options related to the XML output
2053
#---------------------------------------------------------------------------
2055
# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2056
# captures the structure of the code including all documentation.
2057
# The default value is: NO.
2061
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2062
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2064
# The default directory is: xml.
2065
# This tag requires that the tag GENERATE_XML is set to YES.
2069
# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2070
# listings (including syntax highlighting and cross-referencing information) to
2071
# the XML output. Note that enabling this will significantly increase the size
2073
# The default value is: YES.
2074
# This tag requires that the tag GENERATE_XML is set to YES.
2076
XML_PROGRAMLISTING = YES
2078
# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2079
# namespace members in file scope as well, matching the HTML output.
2080
# The default value is: NO.
2081
# This tag requires that the tag GENERATE_XML is set to YES.
2083
XML_NS_MEMB_FILE_SCOPE = NO
2085
#---------------------------------------------------------------------------
2086
# Configuration options related to the DOCBOOK output
2087
#---------------------------------------------------------------------------
2089
# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2090
# that can be used to generate PDF.
2091
# The default value is: NO.
2093
GENERATE_DOCBOOK = NO
2095
# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2096
# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2098
# The default directory is: docbook.
2099
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2101
DOCBOOK_OUTPUT = docbook
2103
# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
2104
# program listings (including syntax highlighting and cross-referencing
2105
# information) to the DOCBOOK output. Note that enabling this will significantly
2106
# increase the size of the DOCBOOK output.
2107
# The default value is: NO.
2108
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2110
DOCBOOK_PROGRAMLISTING = NO
2112
#---------------------------------------------------------------------------
2113
# Configuration options for the AutoGen Definitions output
2114
#---------------------------------------------------------------------------
2116
# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2117
# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
2118
# the structure of the code including all documentation. Note that this feature
2119
# is still experimental and incomplete at the moment.
2120
# The default value is: NO.
2122
GENERATE_AUTOGEN_DEF = NO
2124
#---------------------------------------------------------------------------
2125
# Configuration options related to the Perl module output
2126
#---------------------------------------------------------------------------
2128
# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2129
# file that captures the structure of the code including all documentation.
2131
# Note that this feature is still experimental and incomplete at the moment.
2132
# The default value is: NO.
2134
GENERATE_PERLMOD = NO
2136
# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2137
# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2138
# output from the Perl module output.
2139
# The default value is: NO.
2140
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2144
# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2145
# formatted so it can be parsed by a human reader. This is useful if you want to
2146
# understand what is going on. On the other hand, if this tag is set to NO, the
2147
# size of the Perl module output will be much smaller and Perl will parse it
2149
# The default value is: YES.
2150
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2154
# The names of the make variables in the generated doxyrules.make file are
2155
# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2156
# so different doxyrules.make files included by the same Makefile don't
2157
# overwrite each other's variables.
2158
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2160
PERLMOD_MAKEVAR_PREFIX =
2162
#---------------------------------------------------------------------------
2163
# Configuration options related to the preprocessor
2164
#---------------------------------------------------------------------------
2166
# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2167
# C-preprocessor directives found in the sources and include files.
2168
# The default value is: YES.
2170
ENABLE_PREPROCESSING = YES
2172
# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2173
# in the source code. If set to NO, only conditional compilation will be
2174
# performed. Macro expansion can be done in a controlled way by setting
2175
# EXPAND_ONLY_PREDEF to YES.
2176
# The default value is: NO.
2177
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2181
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2182
# the macro expansion is limited to the macros specified with the PREDEFINED and
2183
# EXPAND_AS_DEFINED tags.
2184
# The default value is: NO.
2185
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2187
EXPAND_ONLY_PREDEF = NO
2189
# If the SEARCH_INCLUDES tag is set to YES, the include files in the
2190
# INCLUDE_PATH will be searched if a #include is found.
2191
# The default value is: YES.
2192
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2194
SEARCH_INCLUDES = YES
2196
# The INCLUDE_PATH tag can be used to specify one or more directories that
2197
# contain include files that are not input files but should be processed by the
2199
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2203
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2204
# patterns (like *.h and *.hpp) to filter out the header-files in the
2205
# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2207
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2209
INCLUDE_FILE_PATTERNS =
2211
# The PREDEFINED tag can be used to specify one or more macro names that are
2212
# defined before the preprocessor is started (similar to the -D option of e.g.
2213
# gcc). The argument of the tag is a list of macros of the form: name or
2214
# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2215
# is assumed. To prevent a macro definition from being undefined via #undef or
2216
# recursively expanded use the := operator instead of the = operator.
2217
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2221
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2222
# tag can be used to specify a list of macro names that should be expanded. The
2223
# macro definition that is found in the sources will be used. Use the PREDEFINED
2224
# tag if you want to use a different macro definition that overrules the
2225
# definition found in the source code.
2226
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2230
# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2231
# remove all references to function-like macros that are alone on a line, have
2232
# an all uppercase name, and do not end with a semicolon. Such function macros
2233
# are typically used for boiler-plate code, and will confuse the parser if not
2235
# The default value is: YES.
2236
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2238
SKIP_FUNCTION_MACROS = YES
2240
#---------------------------------------------------------------------------
2241
# Configuration options related to external references
2242
#---------------------------------------------------------------------------
2244
# The TAGFILES tag can be used to specify one or more tag files. For each tag
2245
# file the location of the external documentation should be added. The format of
2246
# a tag file without this location is as follows:
2247
# TAGFILES = file1 file2 ...
2248
# Adding location for the tag files is done as follows:
2249
# TAGFILES = file1=loc1 "file2 = loc2" ...
2250
# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2251
# section "Linking to external documentation" for more information about the use
2253
# Note: Each tag file must have a unique name (where the name does NOT include
2254
# the path). If a tag file is not located in the directory in which doxygen is
2255
# run, you must also specify the path to the tagfile here.
2259
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2260
# tag file that is based on the input files it reads. See section "Linking to
2261
# external documentation" for more information about the usage of tag files.
2265
# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2266
# the class index. If set to NO, only the inherited external classes will be
2268
# The default value is: NO.
2272
# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2273
# in the modules index. If set to NO, only the current project's groups will be
2275
# The default value is: YES.
2277
EXTERNAL_GROUPS = YES
2279
# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2280
# the related pages index. If set to NO, only the current project's pages will
2282
# The default value is: YES.
2286
#---------------------------------------------------------------------------
2287
# Configuration options related to the dot tool
2288
#---------------------------------------------------------------------------
2290
# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2291
# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2292
# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2293
# disabled, but it is recommended to install and use dot, since it yields more
2295
# The default value is: YES.
2299
# You can include diagrams made with dia in doxygen documentation. Doxygen will
2300
# then run dia to produce the diagram and insert it in the documentation. The
2301
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2302
# If left empty dia is assumed to be found in the default search path.
2306
# If set to YES the inheritance and collaboration graphs will hide inheritance
2307
# and usage relations if the target is undocumented or is not a class.
2308
# The default value is: YES.
2310
HIDE_UNDOC_RELATIONS = YES
2312
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2313
# available from the path. This tool is part of Graphviz (see:
2314
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2315
# Bell Labs. The other options in this section have no effect if this option is
2317
# The default value is: YES.
2321
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2322
# to run in parallel. When set to 0 doxygen will base this on the number of
2323
# processors available in the system. You can set it explicitly to a value
2324
# larger than 0 to get control over the balance between CPU load and processing
2326
# Minimum value: 0, maximum value: 32, default value: 0.
2327
# This tag requires that the tag HAVE_DOT is set to YES.
2331
# When you want a differently looking font in the dot files that doxygen
2332
# generates you can specify the font name using DOT_FONTNAME. You need to make
2333
# sure dot is able to find the font, which can be done by putting it in a
2334
# standard location or by setting the DOTFONTPATH environment variable or by
2335
# setting DOT_FONTPATH to the directory containing the font.
2336
# The default value is: Helvetica.
2337
# This tag requires that the tag HAVE_DOT is set to YES.
2339
DOT_FONTNAME = Helvetica
2341
# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2343
# Minimum value: 4, maximum value: 24, default value: 10.
2344
# This tag requires that the tag HAVE_DOT is set to YES.
2348
# By default doxygen will tell dot to use the default font as specified with
2349
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2350
# the path where dot can find it using this tag.
2351
# This tag requires that the tag HAVE_DOT is set to YES.
2355
# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2356
# each documented class showing the direct and indirect inheritance relations.
2357
# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2358
# The default value is: YES.
2359
# This tag requires that the tag HAVE_DOT is set to YES.
2363
# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2364
# graph for each documented class showing the direct and indirect implementation
2365
# dependencies (inheritance, containment, and class references variables) of the
2366
# class with other documented classes.
2367
# The default value is: YES.
2368
# This tag requires that the tag HAVE_DOT is set to YES.
2370
COLLABORATION_GRAPH = YES
2372
# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2373
# groups, showing the direct groups dependencies.
2374
# The default value is: YES.
2375
# This tag requires that the tag HAVE_DOT is set to YES.
2379
# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2380
# collaboration diagrams in a style similar to the OMG's Unified Modeling
2382
# The default value is: NO.
2383
# This tag requires that the tag HAVE_DOT is set to YES.
2387
# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2388
# class node. If there are many fields or methods and many nodes the graph may
2389
# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2390
# number of items for each type to make the size more manageable. Set this to 0
2391
# for no limit. Note that the threshold may be exceeded by 50% before the limit
2392
# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2393
# but if the number exceeds 15, the total amount of fields shown is limited to
2395
# Minimum value: 0, maximum value: 100, default value: 10.
2396
# This tag requires that the tag UML_LOOK is set to YES.
2398
UML_LIMIT_NUM_FIELDS = 10
2400
# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2401
# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
2402
# tag is set to YES, doxygen will add type and arguments for attributes and
2403
# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
2404
# will not generate fields with class member information in the UML graphs. The
2405
# class diagrams will look similar to the default class diagrams but using UML
2406
# notation for the relationships.
2407
# Possible values are: NO, YES and NONE.
2408
# The default value is: NO.
2409
# This tag requires that the tag UML_LOOK is set to YES.
2413
# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
2414
# to display on a single line. If the actual line length exceeds this threshold
2415
# significantly it will wrapped across multiple lines. Some heuristics are apply
2416
# to avoid ugly line breaks.
2417
# Minimum value: 0, maximum value: 1000, default value: 17.
2418
# This tag requires that the tag HAVE_DOT is set to YES.
2420
DOT_WRAP_THRESHOLD = 17
2422
# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2423
# collaboration graphs will show the relations between templates and their
2425
# The default value is: NO.
2426
# This tag requires that the tag HAVE_DOT is set to YES.
2428
TEMPLATE_RELATIONS = NO
2430
# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2431
# YES then doxygen will generate a graph for each documented file showing the
2432
# direct and indirect include dependencies of the file with other documented
2434
# The default value is: YES.
2435
# This tag requires that the tag HAVE_DOT is set to YES.
2439
# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2440
# set to YES then doxygen will generate a graph for each documented file showing
2441
# the direct and indirect include dependencies of the file with other documented
2443
# The default value is: YES.
2444
# This tag requires that the tag HAVE_DOT is set to YES.
2446
INCLUDED_BY_GRAPH = YES
2448
# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2449
# dependency graph for every global function or class method.
2451
# Note that enabling this option will significantly increase the time of a run.
2452
# So in most cases it will be better to enable call graphs for selected
2453
# functions only using the \callgraph command. Disabling a call graph can be
2454
# accomplished by means of the command \hidecallgraph.
2455
# The default value is: NO.
2456
# This tag requires that the tag HAVE_DOT is set to YES.
2460
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2461
# dependency graph for every global function or class method.
2463
# Note that enabling this option will significantly increase the time of a run.
2464
# So in most cases it will be better to enable caller graphs for selected
2465
# functions only using the \callergraph command. Disabling a caller graph can be
2466
# accomplished by means of the command \hidecallergraph.
2467
# The default value is: NO.
2468
# This tag requires that the tag HAVE_DOT is set to YES.
2472
# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2473
# hierarchy of all classes instead of a textual one.
2474
# The default value is: YES.
2475
# This tag requires that the tag HAVE_DOT is set to YES.
2477
GRAPHICAL_HIERARCHY = YES
2479
# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2480
# dependencies a directory has on other directories in a graphical way. The
2481
# dependency relations are determined by the #include relations between the
2482
# files in the directories.
2483
# The default value is: YES.
2484
# This tag requires that the tag HAVE_DOT is set to YES.
2486
DIRECTORY_GRAPH = YES
2488
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2489
# generated by dot. For an explanation of the image formats see the section
2490
# output formats in the documentation of the dot tool (Graphviz (see:
2491
# http://www.graphviz.org/)).
2492
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2493
# to make the SVG files visible in IE 9+ (other browsers do not have this
2495
# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2496
# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2497
# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
2498
# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2499
# png:gdiplus:gdiplus.
2500
# The default value is: png.
2501
# This tag requires that the tag HAVE_DOT is set to YES.
2503
DOT_IMAGE_FORMAT = png
2505
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2506
# enable generation of interactive SVG images that allow zooming and panning.
2508
# Note that this requires a modern browser other than Internet Explorer. Tested
2509
# and working are Firefox, Chrome, Safari, and Opera.
2510
# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2511
# the SVG files visible. Older versions of IE do not have SVG support.
2512
# The default value is: NO.
2513
# This tag requires that the tag HAVE_DOT is set to YES.
2517
# The DOT_PATH tag can be used to specify the path where the dot tool can be
2518
# found. If left blank, it is assumed the dot tool can be found in the path.
2519
# This tag requires that the tag HAVE_DOT is set to YES.
2523
# The DOTFILE_DIRS tag can be used to specify one or more directories that
2524
# contain dot files that are included in the documentation (see the \dotfile
2526
# This tag requires that the tag HAVE_DOT is set to YES.
2530
# The MSCFILE_DIRS tag can be used to specify one or more directories that
2531
# contain msc files that are included in the documentation (see the \mscfile
2536
# The DIAFILE_DIRS tag can be used to specify one or more directories that
2537
# contain dia files that are included in the documentation (see the \diafile
2542
# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2543
# path where java can find the plantuml.jar file. If left blank, it is assumed
2544
# PlantUML is not used or called during a preprocessing step. Doxygen will
2545
# generate a warning when it encounters a \startuml command in this case and
2546
# will not generate output for the diagram.
2550
# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2551
# configuration file for plantuml.
2555
# When using plantuml, the specified paths are searched for files specified by
2556
# the !include statement in a plantuml block.
2558
PLANTUML_INCLUDE_PATH =
2560
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2561
# that will be shown in the graph. If the number of nodes in a graph becomes
2562
# larger than this value, doxygen will truncate the graph, which is visualized
2563
# by representing a node as a red box. Note that doxygen if the number of direct
2564
# children of the root node in a graph is already larger than
2565
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2566
# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2567
# Minimum value: 0, maximum value: 10000, default value: 50.
2568
# This tag requires that the tag HAVE_DOT is set to YES.
2570
DOT_GRAPH_MAX_NODES = 50
2572
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2573
# generated by dot. A depth value of 3 means that only nodes reachable from the
2574
# root by following a path via at most 3 edges will be shown. Nodes that lay
2575
# further from the root node will be omitted. Note that setting this option to 1
2576
# or 2 may greatly reduce the computation time needed for large code bases. Also
2577
# note that the size of a graph can be further restricted by
2578
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2579
# Minimum value: 0, maximum value: 1000, default value: 0.
2580
# This tag requires that the tag HAVE_DOT is set to YES.
2582
MAX_DOT_GRAPH_DEPTH = 0
2584
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2585
# background. This is disabled by default, because dot on Windows does not seem
2586
# to support this out of the box.
2588
# Warning: Depending on the platform used, enabling this option may lead to
2589
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2591
# The default value is: NO.
2592
# This tag requires that the tag HAVE_DOT is set to YES.
2596
# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2597
# files in one run (i.e. multiple -o and -T options on the command line). This
2598
# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2599
# this, this feature is disabled by default.
2600
# The default value is: NO.
2601
# This tag requires that the tag HAVE_DOT is set to YES.
2603
DOT_MULTI_TARGETS = NO
2605
# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2606
# explaining the meaning of the various boxes and arrows in the dot generated
2608
# The default value is: YES.
2609
# This tag requires that the tag HAVE_DOT is set to YES.
2611
GENERATE_LEGEND = YES
2613
# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
2614
# files that are used to generate the various graphs.
2616
# Note: This setting is not only used for dot files but also for msc and
2617
# plantuml temporary files.
2618
# The default value is: YES.