RoomClimatic

Doxyfile
2895 строк · 126.7 Кб
Перенос по словам
1
# Doxyfile 1.10.0
2

3
# This file describes the settings to be used by the documentation system
4
# doxygen (www.doxygen.org) for a project.
5
#
6
# All text after a double hash (##) is considered a comment and is placed in
7
# front of the TAG it is preceding.
8
#
9
# All text after a single hash (#) is considered a comment and will be ignored.
10
# The format is:
11
# TAG = value [value, ...]
12
# For lists, items can also be appended using:
13
# TAG += value [value, ...]
14
# Values that contain spaces should be placed between quotes (\" \").
15
#
16
# Note:
17
#
18
# Use doxygen to compare the used configuration file with the template
19
# configuration file:
20
# doxygen -x [configFile]
21
# Use doxygen to compare the used configuration file with the template
22
# configuration file without replacing the environment variables or CMake type
23
# replacement variables:
24
# doxygen -x_noenv [configFile]
25

26
#---------------------------------------------------------------------------
27
# Project related configuration options
28
#---------------------------------------------------------------------------
29

30
# This tag specifies the encoding used for all characters in the configuration
31
# file that follow. The default is UTF-8 which is also the encoding used for all
32
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
33
# iconv built into libc) for the transcoding. See
34
# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
35
# The default value is: UTF-8.
36

37
DOXYFILE_ENCODING      = UTF-8
38

39
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
40
# double-quotes, unless you are using Doxywizard) that should identify the
41
# project for which the documentation is generated. This name is used in the
42
# title of most generated pages and in a few other places.
43
# The default value is: My Project.
44

45
PROJECT_NAME           = RoomClimatic
46

47
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
48
# could be handy for archiving the generated documentation or if some version
49
# control system is used.
50

51
PROJECT_NUMBER         =
52

53
# Using the PROJECT_BRIEF tag one can provide an optional one line description
54
# for a project that appears at the top of each page and should give viewer a
55
# quick idea about the purpose of the project. Keep the description short.
56

57
PROJECT_BRIEF          =
58

59
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
60
# in the documentation. The maximum height of the logo should not exceed 55
61
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
62
# the logo to the output directory.
63

64
PROJECT_LOGO           =
65

66
# With the PROJECT_ICON tag one can specify an icon that is included in the tabs
67
# when the HTML document is shown. Doxygen will copy the logo to the output
68
# directory.
69

70
PROJECT_ICON           =
71

72
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
73
# into which the generated documentation will be written. If a relative path is
74
# entered, it will be relative to the location where doxygen was started. If
75
# left blank the current directory will be used.
76

77
OUTPUT_DIRECTORY       = ../Documents
78

79
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
80
# sub-directories (in 2 levels) under the output directory of each output format
81
# and will distribute the generated files over these directories. Enabling this
82
# option can be useful when feeding doxygen a huge amount of source files, where
83
# putting all generated files in the same directory would otherwise causes
84
# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to
85
# control the number of sub-directories.
86
# The default value is: NO.
87

88
CREATE_SUBDIRS         = NO
89

90
# Controls the number of sub-directories that will be created when
91
# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every
92
# level increment doubles the number of directories, resulting in 4096
93
# directories at level 8 which is the default and also the maximum value. The
94
# sub-directories are organized in 2 levels, the first level always has a fixed
95
# number of 16 directories.
96
# Minimum value: 0, maximum value: 8, default value: 8.
97
# This tag requires that the tag CREATE_SUBDIRS is set to YES.
98

99
CREATE_SUBDIRS_LEVEL   = 8
100

101
# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
102
# characters to appear in the names of generated files. If set to NO, non-ASCII
103
# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
104
# U+3044.
105
# The default value is: NO.
106

107
ALLOW_UNICODE_NAMES    = NO
108

109
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
110
# documentation generated by doxygen is written. Doxygen will use this
111
# information to generate all constant output in the proper language.
112
# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian,
113
# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English
114
# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek,
115
# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with
116
# English messages), Korean, Korean-en (Korean with English messages), Latvian,
117
# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese,
118
# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish,
119
# Swedish, Turkish, Ukrainian and Vietnamese.
120
# The default value is: English.
121

122
OUTPUT_LANGUAGE        = Russian
123

124
# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
125
# descriptions after the members that are listed in the file and class
126
# documentation (similar to Javadoc). Set to NO to disable this.
127
# The default value is: YES.
128

129
BRIEF_MEMBER_DESC      = YES
130

131
# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
132
# description of a member or function before the detailed description
133
#
134
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
135
# brief descriptions will be completely suppressed.
136
# The default value is: YES.
137

138
REPEAT_BRIEF           = YES
139

140
# This tag implements a quasi-intelligent brief description abbreviator that is
141
# used to form the text in various listings. Each string in this list, if found
142
# as the leading text of the brief description, will be stripped from the text
143
# and the result, after processing the whole list, is used as the annotated
144
# text. Otherwise, the brief description is used as-is. If left blank, the
145
# following values are used ($name is automatically replaced with the name of
146
# the entity):The $name class, The $name widget, The $name file, is, provides,
147
# specifies, contains, represents, a, an and the.
148

149
ABBREVIATE_BRIEF       = "The $name class" \
150
                         "The $name widget" \
151
                         "The $name file" \
152
                         is \
153
                         provides \
154
                         specifies \
155
                         contains \
156
                         represents \
157
                         a \
158
                         an \
159
                         the
160

161
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
162
# doxygen will generate a detailed section even if there is only a brief
163
# description.
164
# The default value is: NO.
165

166
ALWAYS_DETAILED_SEC    = NO
167

168
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
169
# inherited members of a class in the documentation of that class as if those
170
# members were ordinary class members. Constructors, destructors and assignment
171
# operators of the base classes will not be shown.
172
# The default value is: NO.
173

174
INLINE_INHERITED_MEMB  = NO
175

176
# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
177
# before files name in the file list and in the header files. If set to NO the
178
# shortest path that makes the file name unique will be used
179
# The default value is: YES.
180

181
FULL_PATH_NAMES        = YES
182

183
# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
184
# Stripping is only done if one of the specified strings matches the left-hand
185
# part of the path. The tag can be used to show relative paths in the file list.
186
# If left blank the directory from which doxygen is run is used as the path to
187
# strip.
188
#
189
# Note that you can specify absolute paths here, but also relative paths, which
190
# will be relative from the directory where doxygen is started.
191
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
192

193
STRIP_FROM_PATH        =
194

195
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
196
# path mentioned in the documentation of a class, which tells the reader which
197
# header file to include in order to use a class. If left blank only the name of
198
# the header file containing the class definition is used. Otherwise one should
199
# specify the list of include paths that are normally passed to the compiler
200
# using the -I flag.
201

202
STRIP_FROM_INC_PATH    =
203

204
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
205
# less readable) file names. This can be useful is your file systems doesn't
206
# support long names like on DOS, Mac, or CD-ROM.
207
# The default value is: NO.
208

209
SHORT_NAMES            = NO
210

211
# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
212
# first line (until the first dot) of a Javadoc-style comment as the brief
213
# description. If set to NO, the Javadoc-style will behave just like regular Qt-
214
# style comments (thus requiring an explicit @brief command for a brief
215
# description.)
216
# The default value is: NO.
217

218
JAVADOC_AUTOBRIEF      = NO
219

220
# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
221
# such as
222
# /***************
223
# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
224
# Javadoc-style will behave just like regular comments and it will not be
225
# interpreted by doxygen.
226
# The default value is: NO.
227

228
JAVADOC_BANNER         = NO
229

230
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
231
# line (until the first dot) of a Qt-style comment as the brief description. If
232
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
233
# requiring an explicit \brief command for a brief description.)
234
# The default value is: NO.
235

236
QT_AUTOBRIEF           = NO
237

238
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
239
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
240
# a brief description. This used to be the default behavior. The new default is
241
# to treat a multi-line C++ comment block as a detailed description. Set this
242
# tag to YES if you prefer the old behavior instead.
243
#
244
# Note that setting this tag to YES also means that rational rose comments are
245
# not recognized any more.
246
# The default value is: NO.
247

248
MULTILINE_CPP_IS_BRIEF = NO
249

250
# By default Python docstrings are displayed as preformatted text and doxygen's
251
# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
252
# doxygen's special commands can be used and the contents of the docstring
253
# documentation blocks is shown as doxygen documentation.
254
# The default value is: YES.
255

256
PYTHON_DOCSTRING       = YES
257

258
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
259
# documentation from any documented member that it re-implements.
260
# The default value is: YES.
261

262
INHERIT_DOCS           = YES
263

264
# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
265
# page for each member. If set to NO, the documentation of a member will be part
266
# of the file/class/namespace that contains it.
267
# The default value is: NO.
268

269
SEPARATE_MEMBER_PAGES  = NO
270

271
# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
272
# uses this value to replace tabs by spaces in code fragments.
273
# Minimum value: 1, maximum value: 16, default value: 4.
274

275
TAB_SIZE               = 4
276

277
# This tag can be used to specify a number of aliases that act as commands in
278
# the documentation. An alias has the form:
279
# name=value
280
# For example adding
281
# "sideeffect=@par Side Effects:^^"
282
# will allow you to put the command \sideeffect (or @sideeffect) in the
283
# documentation, which will result in a user-defined paragraph with heading
284
# "Side Effects:". Note that you cannot put \n's in the value part of an alias
285
# to insert newlines (in the resulting output). You can put ^^ in the value part
286
# of an alias to insert a newline as if a physical newline was in the original
287
# file. When you need a literal { or } or , in the value part of an alias you
288
# have to escape them by means of a backslash (\), this can lead to conflicts
289
# with the commands \{ and \} for these it is advised to use the version @{ and
290
# @} or use a double escape (\\{ and \\})
291

292
ALIASES                =
293

294
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
295
# only. Doxygen will then generate output that is more tailored for C. For
296
# instance, some of the names that are used will be different. The list of all
297
# members will be omitted, etc.
298
# The default value is: NO.
299

300
OPTIMIZE_OUTPUT_FOR_C  = NO
301

302
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
303
# Python sources only. Doxygen will then generate output that is more tailored
304
# for that language. For instance, namespaces will be presented as packages,
305
# qualified scopes will look different, etc.
306
# The default value is: NO.
307

308
OPTIMIZE_OUTPUT_JAVA   = NO
309

310
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
311
# sources. Doxygen will then generate output that is tailored for Fortran.
312
# The default value is: NO.
313

314
OPTIMIZE_FOR_FORTRAN   = NO
315

316
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
317
# sources. Doxygen will then generate output that is tailored for VHDL.
318
# The default value is: NO.
319

320
OPTIMIZE_OUTPUT_VHDL   = NO
321

322
# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
323
# sources only. Doxygen will then generate output that is more tailored for that
324
# language. For instance, namespaces will be presented as modules, types will be
325
# separated into more groups, etc.
326
# The default value is: NO.
327

328
OPTIMIZE_OUTPUT_SLICE  = NO
329

330
# Doxygen selects the parser to use depending on the extension of the files it
331
# parses. With this tag you can assign which parser to use for a given
332
# extension. Doxygen has a built-in mapping, but you can override or extend it
333
# using this tag. The format is ext=language, where ext is a file extension, and
334
# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
335
# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
336
# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
337
# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
338
# tries to guess whether the code is fixed or free formatted code, this is the
339
# default for Fortran type files). For instance to make doxygen treat .inc files
340
# as Fortran files (default is PHP), and .f files as C (default is Fortran),
341
# use: inc=Fortran f=C.
342
#
343
# Note: For files without extension you can use no_extension as a placeholder.
344
#
345
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
346
# the files are not read by doxygen. When specifying no_extension you should add
347
# * to the FILE_PATTERNS.
348
#
349
# Note see also the list of default file extension mappings.
350

351
EXTENSION_MAPPING      = ino=C++
352

353
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
354
# according to the Markdown format, which allows for more readable
355
# documentation. See https://daringfireball.net/projects/markdown/ for details.
356
# The output of markdown processing is further processed by doxygen, so you can
357
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
358
# case of backward compatibilities issues.
359
# The default value is: YES.
360

361
MARKDOWN_SUPPORT       = NO
362

363
# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
364
# to that level are automatically included in the table of contents, even if
365
# they do not have an id attribute.
366
# Note: This feature currently applies only to Markdown headings.
367
# Minimum value: 0, maximum value: 99, default value: 5.
368
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
369

370
TOC_INCLUDE_HEADINGS   = 5
371

372
# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to
373
# generate identifiers for the Markdown headings. Note: Every identifier is
374
# unique.
375
# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a
376
# sequence number starting at 0 and GITHUB use the lower case version of title
377
# with any whitespace replaced by '-' and punctuation characters removed.
378
# The default value is: DOXYGEN.
379
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
380

381
MARKDOWN_ID_STYLE      = DOXYGEN
382

383
# When enabled doxygen tries to link words that correspond to documented
384
# classes, or namespaces to their corresponding documentation. Such a link can
385
# be prevented in individual cases by putting a % sign in front of the word or
386
# globally by setting AUTOLINK_SUPPORT to NO.
387
# The default value is: YES.
388

389
AUTOLINK_SUPPORT       = NO
390

391
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
392
# to include (a tag file for) the STL sources as input, then you should set this
393
# tag to YES in order to let doxygen match functions declarations and
394
# definitions whose arguments contain STL classes (e.g. func(std::string);
395
# versus func(std::string) {}). This also make the inheritance and collaboration
396
# diagrams that involve STL classes more complete and accurate.
397
# The default value is: NO.
398

399
BUILTIN_STL_SUPPORT    = NO
400

401
# If you use Microsoft's C++/CLI language, you should set this option to YES to
402
# enable parsing support.
403
# The default value is: NO.
404

405
CPP_CLI_SUPPORT        = NO
406

407
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
408
# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
409
# will parse them like normal C++ but will assume all classes use public instead
410
# of private inheritance when no explicit protection keyword is present.
411
# The default value is: NO.
412

413
SIP_SUPPORT            = NO
414

415
# For Microsoft's IDL there are propget and propput attributes to indicate
416
# getter and setter methods for a property. Setting this option to YES will make
417
# doxygen to replace the get and set methods by a property in the documentation.
418
# This will only work if the methods are indeed getting or setting a simple
419
# type. If this is not the case, or you want to show the methods anyway, you
420
# should set this option to NO.
421
# The default value is: YES.
422

423
IDL_PROPERTY_SUPPORT   = YES
424

425
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
426
# tag is set to YES then doxygen will reuse the documentation of the first
427
# member in the group (if any) for the other members of the group. By default
428
# all members of a group must be documented explicitly.
429
# The default value is: NO.
430

431
DISTRIBUTE_GROUP_DOC   = NO
432

433
# If one adds a struct or class to a group and this option is enabled, then also
434
# any nested class or struct is added to the same group. By default this option
435
# is disabled and one has to add nested compounds explicitly via \ingroup.
436
# The default value is: NO.
437

438
GROUP_NESTED_COMPOUNDS = NO
439

440
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
441
# (for instance a group of public functions) to be put as a subgroup of that
442
# type (e.g. under the Public Functions section). Set it to NO to prevent
443
# subgrouping. Alternatively, this can be done per class using the
444
# \nosubgrouping command.
445
# The default value is: YES.
446

447
SUBGROUPING            = YES
448

449
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
450
# are shown inside the group in which they are included (e.g. using \ingroup)
451
# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
452
# and RTF).
453
#
454
# Note that this feature does not work in combination with
455
# SEPARATE_MEMBER_PAGES.
456
# The default value is: NO.
457

458
INLINE_GROUPED_CLASSES = NO
459

460
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
461
# with only public data fields or simple typedef fields will be shown inline in
462
# the documentation of the scope in which they are defined (i.e. file,
463
# namespace, or group documentation), provided this scope is documented. If set
464
# to NO, structs, classes, and unions are shown on a separate page (for HTML and
465
# Man pages) or section (for LaTeX and RTF).
466
# The default value is: NO.
467

468
INLINE_SIMPLE_STRUCTS  = NO
469

470
# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
471
# enum is documented as struct, union, or enum with the name of the typedef. So
472
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
473
# with name TypeT. When disabled the typedef will appear as a member of a file,
474
# namespace, or class. And the struct will be named TypeS. This can typically be
475
# useful for C code in case the coding convention dictates that all compound
476
# types are typedef'ed and only the typedef is referenced, never the tag name.
477
# The default value is: NO.
478

479
TYPEDEF_HIDES_STRUCT   = NO
480

481
# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
482
# cache is used to resolve symbols given their name and scope. Since this can be
483
# an expensive process and often the same symbol appears multiple times in the
484
# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
485
# doxygen will become slower. If the cache is too large, memory is wasted. The
486
# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
487
# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
488
# symbols. At the end of a run doxygen will report the cache usage and suggest
489
# the optimal cache size from a speed point of view.
490
# Minimum value: 0, maximum value: 9, default value: 0.
491

492
LOOKUP_CACHE_SIZE      = 0
493

494
# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use
495
# during processing. When set to 0 doxygen will based this on the number of
496
# cores available in the system. You can set it explicitly to a value larger
497
# than 0 to get more control over the balance between CPU load and processing
498
# speed. At this moment only the input processing can be done using multiple
499
# threads. Since this is still an experimental feature the default is set to 1,
500
# which effectively disables parallel processing. Please report any issues you
501
# encounter. Generating dot graphs in parallel is controlled by the
502
# DOT_NUM_THREADS setting.
503
# Minimum value: 0, maximum value: 32, default value: 1.
504

505
NUM_PROC_THREADS       = 1
506

507
# If the TIMESTAMP tag is set different from NO then each generated page will
508
# contain the date or date and time when the page was generated. Setting this to
509
# NO can help when comparing the output of multiple runs.
510
# Possible values are: YES, NO, DATETIME and DATE.
511
# The default value is: NO.
512

513
TIMESTAMP              = NO
514

515
#---------------------------------------------------------------------------
516
# Build related configuration options
517
#---------------------------------------------------------------------------
518

519
# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
520
# documentation are documented, even if no documentation was available. Private
521
# class members and static file members will be hidden unless the
522
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
523
# Note: This will also disable the warnings about undocumented members that are
524
# normally produced when WARNINGS is set to YES.
525
# The default value is: NO.
526

527
EXTRACT_ALL            = YES
528

529
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
530
# be included in the documentation.
531
# The default value is: NO.
532

533
EXTRACT_PRIVATE        = YES
534

535
# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
536
# methods of a class will be included in the documentation.
537
# The default value is: NO.
538

539
EXTRACT_PRIV_VIRTUAL   = NO
540

541
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
542
# scope will be included in the documentation.
543
# The default value is: NO.
544

545
EXTRACT_PACKAGE        = NO
546

547
# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
548
# included in the documentation.
549
# The default value is: NO.
550

551
EXTRACT_STATIC         = YES
552

553
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
554
# locally in source files will be included in the documentation. If set to NO,
555
# only classes defined in header files are included. Does not have any effect
556
# for Java sources.
557
# The default value is: YES.
558

559
EXTRACT_LOCAL_CLASSES  = YES
560

561
# This flag is only useful for Objective-C code. If set to YES, local methods,
562
# which are defined in the implementation section but not in the interface are
563
# included in the documentation. If set to NO, only methods in the interface are
564
# included.
565
# The default value is: NO.
566

567
EXTRACT_LOCAL_METHODS  = NO
568

569
# If this flag is set to YES, the members of anonymous namespaces will be
570
# extracted and appear in the documentation as a namespace called
571
# 'anonymous_namespace{file}', where file will be replaced with the base name of
572
# the file that contains the anonymous namespace. By default anonymous namespace
573
# are hidden.
574
# The default value is: NO.
575

576
EXTRACT_ANON_NSPACES   = NO
577

578
# If this flag is set to YES, the name of an unnamed parameter in a declaration
579
# will be determined by the corresponding definition. By default unnamed
580
# parameters remain unnamed in the output.
581
# The default value is: YES.
582

583
RESOLVE_UNNAMED_PARAMS = YES
584

585
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
586
# undocumented members inside documented classes or files. If set to NO these
587
# members will be included in the various overviews, but no documentation
588
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
589
# The default value is: NO.
590

591
HIDE_UNDOC_MEMBERS     = NO
592

593
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
594
# undocumented classes that are normally visible in the class hierarchy. If set
595
# to NO, these classes will be included in the various overviews. This option
596
# will also hide undocumented C++ concepts if enabled. This option has no effect
597
# if EXTRACT_ALL is enabled.
598
# The default value is: NO.
599

600
HIDE_UNDOC_CLASSES     = NO
601

602
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
603
# declarations. If set to NO, these declarations will be included in the
604
# documentation.
605
# The default value is: NO.
606

607
HIDE_FRIEND_COMPOUNDS  = NO
608

609
# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
610
# documentation blocks found inside the body of a function. If set to NO, these
611
# blocks will be appended to the function's detailed documentation block.
612
# The default value is: NO.
613

614
HIDE_IN_BODY_DOCS      = NO
615

616
# The INTERNAL_DOCS tag determines if documentation that is typed after a
617
# \internal command is included. If the tag is set to NO then the documentation
618
# will be excluded. Set it to YES to include the internal documentation.
619
# The default value is: NO.
620

621
INTERNAL_DOCS          = NO
622

623
# With the correct setting of option CASE_SENSE_NAMES doxygen will better be
624
# able to match the capabilities of the underlying filesystem. In case the
625
# filesystem is case sensitive (i.e. it supports files in the same directory
626
# whose names only differ in casing), the option must be set to YES to properly
627
# deal with such files in case they appear in the input. For filesystems that
628
# are not case sensitive the option should be set to NO to properly deal with
629
# output files written for symbols that only differ in casing, such as for two
630
# classes, one named CLASS and the other named Class, and to also support
631
# references to files without having to specify the exact matching casing. On
632
# Windows (including Cygwin) and MacOS, users should typically set this option
633
# to NO, whereas on Linux or other Unix flavors it should typically be set to
634
# YES.
635
# Possible values are: SYSTEM, NO and YES.
636
# The default value is: SYSTEM.
637

638
CASE_SENSE_NAMES       = SYSTEM
639

640
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
641
# their full class and namespace scopes in the documentation. If set to YES, the
642
# scope will be hidden.
643
# The default value is: NO.
644

645
HIDE_SCOPE_NAMES       = NO
646

647
# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
648
# append additional text to a page's title, such as Class Reference. If set to
649
# YES the compound reference will be hidden.
650
# The default value is: NO.
651

652
HIDE_COMPOUND_REFERENCE= NO
653

654
# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
655
# will show which file needs to be included to use the class.
656
# The default value is: YES.
657

658
SHOW_HEADERFILE        = YES
659

660
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
661
# the files that are included by a file in the documentation of that file.
662
# The default value is: YES.
663

664
SHOW_INCLUDE_FILES     = YES
665

666
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
667
# grouped member an include statement to the documentation, telling the reader
668
# which file to include in order to use the member.
669
# The default value is: NO.
670

671
SHOW_GROUPED_MEMB_INC  = NO
672

673
# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
674
# files with double quotes in the documentation rather than with sharp brackets.
675
# The default value is: NO.
676

677
FORCE_LOCAL_INCLUDES   = NO
678

679
# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
680
# documentation for inline members.
681
# The default value is: YES.
682

683
INLINE_INFO            = YES
684

685
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
686
# (detailed) documentation of file and class members alphabetically by member
687
# name. If set to NO, the members will appear in declaration order.
688
# The default value is: YES.
689

690
SORT_MEMBER_DOCS       = YES
691

692
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
693
# descriptions of file, namespace and class members alphabetically by member
694
# name. If set to NO, the members will appear in declaration order. Note that
695
# this will also influence the order of the classes in the class list.
696
# The default value is: NO.
697

698
SORT_BRIEF_DOCS        = NO
699

700
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
701
# (brief and detailed) documentation of class members so that constructors and
702
# destructors are listed first. If set to NO the constructors will appear in the
703
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
704
# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
705
# member documentation.
706
# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
707
# detailed member documentation.
708
# The default value is: NO.
709

710
SORT_MEMBERS_CTORS_1ST = NO
711

712
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
713
# of group names into alphabetical order. If set to NO the group names will
714
# appear in their defined order.
715
# The default value is: NO.
716

717
SORT_GROUP_NAMES       = NO
718

719
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
720
# fully-qualified names, including namespaces. If set to NO, the class list will
721
# be sorted only by class name, not including the namespace part.
722
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
723
# Note: This option applies only to the class list, not to the alphabetical
724
# list.
725
# The default value is: NO.
726

727
SORT_BY_SCOPE_NAME     = NO
728

729
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
730
# type resolution of all parameters of a function it will reject a match between
731
# the prototype and the implementation of a member function even if there is
732
# only one candidate or it is obvious which candidate to choose by doing a
733
# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
734
# accept a match between prototype and implementation in such cases.
735
# The default value is: NO.
736

737
STRICT_PROTO_MATCHING  = NO
738

739
# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
740
# list. This list is created by putting \todo commands in the documentation.
741
# The default value is: YES.
742

743
GENERATE_TODOLIST      = YES
744

745
# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
746
# list. This list is created by putting \test commands in the documentation.
747
# The default value is: YES.
748

749
GENERATE_TESTLIST      = YES
750

751
# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
752
# list. This list is created by putting \bug commands in the documentation.
753
# The default value is: YES.
754

755
GENERATE_BUGLIST       = YES
756

757
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
758
# the deprecated list. This list is created by putting \deprecated commands in
759
# the documentation.
760
# The default value is: YES.
761

762
GENERATE_DEPRECATEDLIST= YES
763

764
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
765
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
766
# ... \endcond blocks.
767

768
ENABLED_SECTIONS       =
769

770
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
771
# initial value of a variable or macro / define can have for it to appear in the
772
# documentation. If the initializer consists of more lines than specified here
773
# it will be hidden. Use a value of 0 to hide initializers completely. The
774
# appearance of the value of individual variables and macros / defines can be
775
# controlled using \showinitializer or \hideinitializer command in the
776
# documentation regardless of this setting.
777
# Minimum value: 0, maximum value: 10000, default value: 30.
778

779
MAX_INITIALIZER_LINES  = 30
780

781
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
782
# the bottom of the documentation of classes and structs. If set to YES, the
783
# list will mention the files that were used to generate the documentation.
784
# The default value is: YES.
785

786
SHOW_USED_FILES        = YES
787

788
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
789
# will remove the Files entry from the Quick Index and from the Folder Tree View
790
# (if specified).
791
# The default value is: YES.
792

793
SHOW_FILES             = YES
794

795
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
796
# page. This will remove the Namespaces entry from the Quick Index and from the
797
# Folder Tree View (if specified).
798
# The default value is: YES.
799

800
SHOW_NAMESPACES        = YES
801

802
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
803
# doxygen should invoke to get the current version for each file (typically from
804
# the version control system). Doxygen will invoke the program by executing (via
805
# popen()) the command command input-file, where command is the value of the
806
# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
807
# by doxygen. Whatever the program writes to standard output is used as the file
808
# version. For an example see the documentation.
809

810
FILE_VERSION_FILTER    =
811

812
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
813
# by doxygen. The layout file controls the global structure of the generated
814
# output files in an output format independent way. To create the layout file
815
# that represents doxygen's defaults, run doxygen with the -l option. You can
816
# optionally specify a file name after the option, if omitted DoxygenLayout.xml
817
# will be used as the name of the layout file. See also section "Changing the
818
# layout of pages" for information.
819
#
820
# Note that if you run doxygen from a directory containing a file called
821
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
822
# tag is left empty.
823

824
LAYOUT_FILE            =
825

826
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
827
# the reference definitions. This must be a list of .bib files. The .bib
828
# extension is automatically appended if omitted. This requires the bibtex tool
829
# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
830
# For LaTeX the style of the bibliography can be controlled using
831
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
832
# search path. See also \cite for info how to create references.
833

834
CITE_BIB_FILES         =
835

836
#---------------------------------------------------------------------------
837
# Configuration options related to warning and progress messages
838
#---------------------------------------------------------------------------
839

840
# The QUIET tag can be used to turn on/off the messages that are generated to
841
# standard output by doxygen. If QUIET is set to YES this implies that the
842
# messages are off.
843
# The default value is: NO.
844

845
QUIET                  = NO
846

847
# The WARNINGS tag can be used to turn on/off the warning messages that are
848
# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
849
# this implies that the warnings are on.
850
#
851
# Tip: Turn warnings on while writing the documentation.
852
# The default value is: YES.
853

854
WARNINGS               = YES
855

856
# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
857
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
858
# will automatically be disabled.
859
# The default value is: YES.
860

861
WARN_IF_UNDOCUMENTED   = YES
862

863
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
864
# potential errors in the documentation, such as documenting some parameters in
865
# a documented function twice, or documenting parameters that don't exist or
866
# using markup commands wrongly.
867
# The default value is: YES.
868

869
WARN_IF_DOC_ERROR      = YES
870

871
# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
872
# function parameter documentation. If set to NO, doxygen will accept that some
873
# parameters have no documentation without warning.
874
# The default value is: YES.
875

876
WARN_IF_INCOMPLETE_DOC = YES
877

878
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
879
# are documented, but have no documentation for their parameters or return
880
# value. If set to NO, doxygen will only warn about wrong parameter
881
# documentation, but not about the absence of documentation. If EXTRACT_ALL is
882
# set to YES then this flag will automatically be disabled. See also
883
# WARN_IF_INCOMPLETE_DOC
884
# The default value is: NO.
885

886
WARN_NO_PARAMDOC       = NO
887

888
# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about
889
# undocumented enumeration values. If set to NO, doxygen will accept
890
# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag
891
# will automatically be disabled.
892
# The default value is: NO.
893

894
WARN_IF_UNDOC_ENUM_VAL = NO
895

896
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
897
# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
898
# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
899
# at the end of the doxygen process doxygen will return with a non-zero status.
900
# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves
901
# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not
902
# write the warning messages in between other messages but write them at the end
903
# of a run, in case a WARN_LOGFILE is defined the warning messages will be
904
# besides being in the defined file also be shown at the end of a run, unless
905
# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case
906
# the behavior will remain as with the setting FAIL_ON_WARNINGS.
907
# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT.
908
# The default value is: NO.
909

910
WARN_AS_ERROR          = NO
911

912
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
913
# can produce. The string should contain the $file, $line, and $text tags, which
914
# will be replaced by the file and line number from which the warning originated
915
# and the warning text. Optionally the format may contain $version, which will
916
# be replaced by the version of the file (if it could be obtained via
917
# FILE_VERSION_FILTER)
918
# See also: WARN_LINE_FORMAT
919
# The default value is: $file:$line: $text.
920

921
WARN_FORMAT            = "$file:$line: $text"
922

923
# In the $text part of the WARN_FORMAT command it is possible that a reference
924
# to a more specific place is given. To make it easier to jump to this place
925
# (outside of doxygen) the user can define a custom "cut" / "paste" string.
926
# Example:
927
# WARN_LINE_FORMAT = "'vi $file +$line'"
928
# See also: WARN_FORMAT
929
# The default value is: at line $line of file $file.
930

931
WARN_LINE_FORMAT       = "at line $line of file $file"
932

933
# The WARN_LOGFILE tag can be used to specify a file to which warning and error
934
# messages should be written. If left blank the output is written to standard
935
# error (stderr). In case the file specified cannot be opened for writing the
936
# warning and error messages are written to standard error. When as file - is
937
# specified the warning and error messages are written to standard output
938
# (stdout).
939

940
WARN_LOGFILE           =
941

942
#---------------------------------------------------------------------------
943
# Configuration options related to the input files
944
#---------------------------------------------------------------------------
945

946
# The INPUT tag is used to specify the files and/or directories that contain
947
# documented source files. You may enter file names like myfile.cpp or
948
# directories like /usr/src/myproject. Separate the files or directories with
949
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
950
# Note: If this tag is empty the current directory is searched.
951

952
INPUT                  = ../RoomClimatic
953

954
# This tag can be used to specify the character encoding of the source files
955
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
956
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
957
# documentation (see:
958
# https://www.gnu.org/software/libiconv/) for the list of possible encodings.
959
# See also: INPUT_FILE_ENCODING
960
# The default value is: UTF-8.
961

962
INPUT_ENCODING         = UTF-8
963

964
# This tag can be used to specify the character encoding of the source files
965
# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify
966
# character encoding on a per file pattern basis. Doxygen will compare the file
967
# name with each pattern and apply the encoding instead of the default
968
# INPUT_ENCODING) if there is a match. The character encodings are a list of the
969
# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding
970
# "INPUT_ENCODING" for further information on supported encodings.
971

972
INPUT_FILE_ENCODING    =
973

974
# If the value of the INPUT tag contains directories, you can use the
975
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
976
# *.h) to filter out the source-files in the directories.
977
#
978
# Note that for custom extensions or not directly supported extensions you also
979
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
980
# read by doxygen.
981
#
982
# Note the list of default checked file patterns might differ from the list of
983
# default file extension mappings.
984
#
985
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm,
986
# *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl,
987
# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d,
988
# *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to
989
# be provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
990
# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
991

992
FILE_PATTERNS          = *.c \
993
                         *.cc \
994
                         *.cxx \
995
                         *.cxxm \
996
                         *.cpp \
997
                         *.cppm \
998
                         *.ccm \
999
                         *.c++ \
1000
                         *.c++m \
1001
                         *.java \
1002
                         *.ii \
1003
                         *.ixx \
1004
                         *.ipp \
1005
                         *.i++ \
1006
                         *.inl \
1007
                         *.idl \
1008
                         *.ddl \
1009
                         *.odl \
1010
                         *.h \
1011
                         *.hh \
1012
                         *.hxx \
1013
                         *.hpp \
1014
                         *.h++ \
1015
                         *.ixx \
1016
                         *.l \
1017
                         *.cs \
1018
                         *.d \
1019
                         *.php \
1020
                         *.php4 \
1021
                         *.php5 \
1022
                         *.phtml \
1023
                         *.inc \
1024
                         *.m \
1025
                         *.markdown \
1026
                         *.md \
1027
                         *.mm \
1028
                         *.dox \
1029
                         *.py \
1030
                         *.pyw \
1031
                         *.f90 \
1032
                         *.f95 \
1033
                         *.f03 \
1034
                         *.f08 \
1035
                         *.f18 \
1036
                         *.f \
1037
                         *.for \
1038
                         *.vhd \
1039
                         *.vhdl \
1040
                         *.ucf \
1041
                         *.qsf \
1042
                         *.ice \
1043
                         *.ino
1044

1045
# The RECURSIVE tag can be used to specify whether or not subdirectories should
1046
# be searched for input files as well.
1047
# The default value is: NO.
1048

1049
RECURSIVE              = YES
1050

1051
# The EXCLUDE tag can be used to specify files and/or directories that should be
1052
# excluded from the INPUT source files. This way you can easily exclude a
1053
# subdirectory from a directory tree whose root is specified with the INPUT tag.
1054
#
1055
# Note that relative paths are relative to the directory from which doxygen is
1056
# run.
1057

1058
EXCLUDE                =
1059

1060
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
1061
# directories that are symbolic links (a Unix file system feature) are excluded
1062
# from the input.
1063
# The default value is: NO.
1064

1065
EXCLUDE_SYMLINKS       = NO
1066

1067
# If the value of the INPUT tag contains directories, you can use the
1068
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
1069
# certain files from those directories.
1070
#
1071
# Note that the wildcards are matched against the file with absolute path, so to
1072
# exclude all test directories for example use the pattern */test/*
1073

1074
EXCLUDE_PATTERNS       =
1075

1076
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
1077
# (namespaces, classes, functions, etc.) that should be excluded from the
1078
# output. The symbol name can be a fully qualified name, a word, or if the
1079
# wildcard * is used, a substring. Examples: ANamespace, AClass,
1080
# ANamespace::AClass, ANamespace::*Test
1081

1082
EXCLUDE_SYMBOLS        =
1083

1084
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
1085
# that contain example code fragments that are included (see the \include
1086
# command).
1087

1088
EXAMPLE_PATH           =
1089

1090
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
1091
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
1092
# *.h) to filter out the source-files in the directories. If left blank all
1093
# files are included.
1094

1095
EXAMPLE_PATTERNS       = *
1096

1097
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1098
# searched for input files to be used with the \include or \dontinclude commands
1099
# irrespective of the value of the RECURSIVE tag.
1100
# The default value is: NO.
1101

1102
EXAMPLE_RECURSIVE      = NO
1103

1104
# The IMAGE_PATH tag can be used to specify one or more files or directories
1105
# that contain images that are to be included in the documentation (see the
1106
# \image command).
1107

1108
IMAGE_PATH             =
1109

1110
# The INPUT_FILTER tag can be used to specify a program that doxygen should
1111
# invoke to filter for each input file. Doxygen will invoke the filter program
1112
# by executing (via popen()) the command:
1113
#
1114
# <filter> <input-file>
1115
#
1116
# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1117
# name of an input file. Doxygen will then use the output that the filter
1118
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
1119
# will be ignored.
1120
#
1121
# Note that the filter must not add or remove lines; it is applied before the
1122
# code is scanned, but not when the output code is generated. If lines are added
1123
# or removed, the anchors will not be placed correctly.
1124
#
1125
# Note that doxygen will use the data processed and written to standard output
1126
# for further processing, therefore nothing else, like debug statements or used
1127
# commands (so in case of a Windows batch file always use @echo OFF), should be
1128
# written to standard output.
1129
#
1130
# Note that for custom extensions or not directly supported extensions you also
1131
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1132
# properly processed by doxygen.
1133

1134
INPUT_FILTER           =
1135

1136
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1137
# basis. Doxygen will compare the file name with each pattern and apply the
1138
# filter if there is a match. The filters are a list of the form: pattern=filter
1139
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
1140
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1141
# patterns match the file name, INPUT_FILTER is applied.
1142
#
1143
# Note that for custom extensions or not directly supported extensions you also
1144
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1145
# properly processed by doxygen.
1146

1147
FILTER_PATTERNS        =
1148

1149
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1150
# INPUT_FILTER) will also be used to filter the input files that are used for
1151
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1152
# The default value is: NO.
1153

1154
FILTER_SOURCE_FILES    = NO
1155

1156
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1157
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1158
# it is also possible to disable source filtering for a specific pattern using
1159
# *.ext= (so without naming a filter).
1160
# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1161

1162
FILTER_SOURCE_PATTERNS =
1163

1164
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1165
# is part of the input, its contents will be placed on the main page
1166
# (index.html). This can be useful if you have a project on for instance GitHub
1167
# and want to reuse the introduction page also for the doxygen output.
1168

1169
USE_MDFILE_AS_MAINPAGE =
1170

1171
# The Fortran standard specifies that for fixed formatted Fortran code all
1172
# characters from position 72 are to be considered as comment. A common
1173
# extension is to allow longer lines before the automatic comment starts. The
1174
# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can
1175
# be processed before the automatic comment starts.
1176
# Minimum value: 7, maximum value: 10000, default value: 72.
1177

1178
FORTRAN_COMMENT_AFTER  = 72
1179

1180
#---------------------------------------------------------------------------
1181
# Configuration options related to source browsing
1182
#---------------------------------------------------------------------------
1183

1184
# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1185
# generated. Documented entities will be cross-referenced with these sources.
1186
#
1187
# Note: To get rid of all source code in the generated output, make sure that
1188
# also VERBATIM_HEADERS is set to NO.
1189
# The default value is: NO.
1190

1191
SOURCE_BROWSER         = YES
1192

1193
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
1194
# multi-line macros, enums or list initialized variables directly into the
1195
# documentation.
1196
# The default value is: NO.
1197

1198
INLINE_SOURCES         = NO
1199

1200
# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1201
# special comment blocks from generated source code fragments. Normal C, C++ and
1202
# Fortran comments will always remain visible.
1203
# The default value is: YES.
1204

1205
STRIP_CODE_COMMENTS    = YES
1206

1207
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1208
# entity all documented functions referencing it will be listed.
1209
# The default value is: NO.
1210

1211
REFERENCED_BY_RELATION = NO
1212

1213
# If the REFERENCES_RELATION tag is set to YES then for each documented function
1214
# all documented entities called/used by that function will be listed.
1215
# The default value is: NO.
1216

1217
REFERENCES_RELATION    = NO
1218

1219
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1220
# to YES then the hyperlinks from functions in REFERENCES_RELATION and
1221
# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1222
# link to the documentation.
1223
# The default value is: YES.
1224

1225
REFERENCES_LINK_SOURCE = YES
1226

1227
# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1228
# source code will show a tooltip with additional information such as prototype,
1229
# brief description and links to the definition and documentation. Since this
1230
# will make the HTML file larger and loading of large files a bit slower, you
1231
# can opt to disable this feature.
1232
# The default value is: YES.
1233
# This tag requires that the tag SOURCE_BROWSER is set to YES.
1234

1235
SOURCE_TOOLTIPS        = YES
1236

1237
# If the USE_HTAGS tag is set to YES then the references to source code will
1238
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
1239
# source browser. The htags tool is part of GNU's global source tagging system
1240
# (see https://www.gnu.org/software/global/global.html). You will need version
1241
# 4.8.6 or higher.
1242
#
1243
# To use it do the following:
1244
# - Install the latest version of global
1245
# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1246
# - Make sure the INPUT points to the root of the source tree
1247
# - Run doxygen as normal
1248
#
1249
# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1250
# tools must be available from the command line (i.e. in the search path).
1251
#
1252
# The result: instead of the source browser generated by doxygen, the links to
1253
# source code will now point to the output of htags.
1254
# The default value is: NO.
1255
# This tag requires that the tag SOURCE_BROWSER is set to YES.
1256

1257
USE_HTAGS              = NO
1258

1259
# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1260
# verbatim copy of the header file for each class for which an include is
1261
# specified. Set to NO to disable this.
1262
# See also: Section \class.
1263
# The default value is: YES.
1264

1265
VERBATIM_HEADERS       = YES
1266

1267
# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1268
# clang parser (see:
1269
# http://clang.llvm.org/) for more accurate parsing at the cost of reduced
1270
# performance. This can be particularly helpful with template rich C++ code for
1271
# which doxygen's built-in parser lacks the necessary type information.
1272
# Note: The availability of this option depends on whether or not doxygen was
1273
# generated with the -Duse_libclang=ON option for CMake.
1274
# The default value is: NO.
1275

1276
CLANG_ASSISTED_PARSING = NO
1277

1278
# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS
1279
# tag is set to YES then doxygen will add the directory of each input to the
1280
# include path.
1281
# The default value is: YES.
1282
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1283

1284
CLANG_ADD_INC_PATHS    = YES
1285

1286
# If clang assisted parsing is enabled you can provide the compiler with command
1287
# line options that you would normally use when invoking the compiler. Note that
1288
# the include paths will already be set by doxygen for the files and directories
1289
# specified with INPUT and INCLUDE_PATH.
1290
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1291

1292
CLANG_OPTIONS          =
1293

1294
# If clang assisted parsing is enabled you can provide the clang parser with the
1295
# path to the directory containing a file called compile_commands.json. This
1296
# file is the compilation database (see:
1297
# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the
1298
# options used when the source files were built. This is equivalent to
1299
# specifying the -p option to a clang tool, such as clang-check. These options
1300
# will then be passed to the parser. Any options specified with CLANG_OPTIONS
1301
# will be added as well.
1302
# Note: The availability of this option depends on whether or not doxygen was
1303
# generated with the -Duse_libclang=ON option for CMake.
1304

1305
CLANG_DATABASE_PATH    =
1306

1307
#---------------------------------------------------------------------------
1308
# Configuration options related to the alphabetical class index
1309
#---------------------------------------------------------------------------
1310

1311
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1312
# compounds will be generated. Enable this if the project contains a lot of
1313
# classes, structs, unions or interfaces.
1314
# The default value is: YES.
1315

1316
ALPHABETICAL_INDEX     = YES
1317

1318
# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes)
1319
# that should be ignored while generating the index headers. The IGNORE_PREFIX
1320
# tag works for classes, function and member names. The entity will be placed in
1321
# the alphabetical list under the first letter of the entity name that remains
1322
# after removing the prefix.
1323
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1324

1325
IGNORE_PREFIX          =
1326

1327
#---------------------------------------------------------------------------
1328
# Configuration options related to the HTML output
1329
#---------------------------------------------------------------------------
1330

1331
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1332
# The default value is: YES.
1333

1334
GENERATE_HTML          = YES
1335

1336
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1337
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1338
# it.
1339
# The default directory is: html.
1340
# This tag requires that the tag GENERATE_HTML is set to YES.
1341

1342
HTML_OUTPUT            = html
1343

1344
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1345
# generated HTML page (for example: .htm, .php, .asp).
1346
# The default value is: .html.
1347
# This tag requires that the tag GENERATE_HTML is set to YES.
1348

1349
HTML_FILE_EXTENSION    = .html
1350

1351
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1352
# each generated HTML page. If the tag is left blank doxygen will generate a
1353
# standard header.
1354
#
1355
# To get valid HTML the header file that includes any scripts and style sheets
1356
# that doxygen needs, which is dependent on the configuration options used (e.g.
1357
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1358
# default header using
1359
# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1360
# YourConfigFile
1361
# and then modify the file new_header.html. See also section "Doxygen usage"
1362
# for information on how to generate the default header that doxygen normally
1363
# uses.
1364
# Note: The header is subject to change so you typically have to regenerate the
1365
# default header when upgrading to a newer version of doxygen. For a description
1366
# of the possible markers and block names see the documentation.
1367
# This tag requires that the tag GENERATE_HTML is set to YES.
1368

1369
HTML_HEADER            =
1370

1371
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1372
# generated HTML page. If the tag is left blank doxygen will generate a standard
1373
# footer. See HTML_HEADER for more information on how to generate a default
1374
# footer and what special commands can be used inside the footer. See also
1375
# section "Doxygen usage" for information on how to generate the default footer
1376
# that doxygen normally uses.
1377
# This tag requires that the tag GENERATE_HTML is set to YES.
1378

1379
HTML_FOOTER            =
1380

1381
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1382
# sheet that is used by each HTML page. It can be used to fine-tune the look of
1383
# the HTML output. If left blank doxygen will generate a default style sheet.
1384
# See also section "Doxygen usage" for information on how to generate the style
1385
# sheet that doxygen normally uses.
1386
# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1387
# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1388
# obsolete.
1389
# This tag requires that the tag GENERATE_HTML is set to YES.
1390

1391
HTML_STYLESHEET        =
1392

1393
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1394
# cascading style sheets that are included after the standard style sheets
1395
# created by doxygen. Using this option one can overrule certain style aspects.
1396
# This is preferred over using HTML_STYLESHEET since it does not replace the
1397
# standard style sheet and is therefore more robust against future updates.
1398
# Doxygen will copy the style sheet files to the output directory.
1399
# Note: The order of the extra style sheet files is of importance (e.g. the last
1400
# style sheet in the list overrules the setting of the previous ones in the
1401
# list).
1402
# Note: Since the styling of scrollbars can currently not be overruled in
1403
# Webkit/Chromium, the styling will be left out of the default doxygen.css if
1404
# one or more extra stylesheets have been specified. So if scrollbar
1405
# customization is desired it has to be added explicitly. For an example see the
1406
# documentation.
1407
# This tag requires that the tag GENERATE_HTML is set to YES.
1408

1409
HTML_EXTRA_STYLESHEET  =
1410

1411
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1412
# other source files which should be copied to the HTML output directory. Note
1413
# that these files will be copied to the base HTML output directory. Use the
1414
# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1415
# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1416
# files will be copied as-is; there are no commands or markers available.
1417
# This tag requires that the tag GENERATE_HTML is set to YES.
1418

1419
HTML_EXTRA_FILES       =
1420

1421
# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
1422
# should be rendered with a dark or light theme.
1423
# Possible values are: LIGHT always generate light mode output, DARK always
1424
# generate dark mode output, AUTO_LIGHT automatically set the mode according to
1425
# the user preference, use light mode if no preference is set (the default),
1426
# AUTO_DARK automatically set the mode according to the user preference, use
1427
# dark mode if no preference is set and TOGGLE allow to user to switch between
1428
# light and dark mode via a button.
1429
# The default value is: AUTO_LIGHT.
1430
# This tag requires that the tag GENERATE_HTML is set to YES.
1431

1432
HTML_COLORSTYLE        = AUTO_LIGHT
1433

1434
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1435
# will adjust the colors in the style sheet and background images according to
1436
# this color. Hue is specified as an angle on a color-wheel, see
1437
# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1438
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1439
# purple, and 360 is red again.
1440
# Minimum value: 0, maximum value: 359, default value: 220.
1441
# This tag requires that the tag GENERATE_HTML is set to YES.
1442

1443
HTML_COLORSTYLE_HUE    = 220
1444

1445
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1446
# in the HTML output. For a value of 0 the output will use gray-scales only. A
1447
# value of 255 will produce the most vivid colors.
1448
# Minimum value: 0, maximum value: 255, default value: 100.
1449
# This tag requires that the tag GENERATE_HTML is set to YES.
1450

1451
HTML_COLORSTYLE_SAT    = 100
1452

1453
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1454
# luminance component of the colors in the HTML output. Values below 100
1455
# gradually make the output lighter, whereas values above 100 make the output
1456
# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1457
# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1458
# change the gamma.
1459
# Minimum value: 40, maximum value: 240, default value: 80.
1460
# This tag requires that the tag GENERATE_HTML is set to YES.
1461

1462
HTML_COLORSTYLE_GAMMA  = 80
1463

1464
# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1465
# documentation will contain a main index with vertical navigation menus that
1466
# are dynamically created via JavaScript. If disabled, the navigation index will
1467
# consists of multiple levels of tabs that are statically embedded in every HTML
1468
# page. Disable this option to support browsers that do not have JavaScript,
1469
# like the Qt help browser.
1470
# The default value is: YES.
1471
# This tag requires that the tag GENERATE_HTML is set to YES.
1472

1473
HTML_DYNAMIC_MENUS     = YES
1474

1475
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1476
# documentation will contain sections that can be hidden and shown after the
1477
# page has loaded.
1478
# The default value is: NO.
1479
# This tag requires that the tag GENERATE_HTML is set to YES.
1480

1481
HTML_DYNAMIC_SECTIONS  = NO
1482

1483
# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be
1484
# dynamically folded and expanded in the generated HTML source code.
1485
# The default value is: YES.
1486
# This tag requires that the tag GENERATE_HTML is set to YES.
1487

1488
HTML_CODE_FOLDING      = YES
1489

1490
# If the HTML_COPY_CLIPBOARD tag is set to YES then doxygen will show an icon in
1491
# the top right corner of code and text fragments that allows the user to copy
1492
# its content to the clipboard. Note this only works if supported by the browser
1493
# and the web page is served via a secure context (see:
1494
# https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file:
1495
# protocol.
1496
# The default value is: YES.
1497
# This tag requires that the tag GENERATE_HTML is set to YES.
1498

1499
HTML_COPY_CLIPBOARD    = YES
1500

1501
# Doxygen stores a couple of settings persistently in the browser (via e.g.
1502
# cookies). By default these settings apply to all HTML pages generated by
1503
# doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store
1504
# the settings under a project specific key, such that the user preferences will
1505
# be stored separately.
1506
# This tag requires that the tag GENERATE_HTML is set to YES.
1507

1508
HTML_PROJECT_COOKIE    =
1509

1510
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1511
# shown in the various tree structured indices initially; the user can expand
1512
# and collapse entries dynamically later on. Doxygen will expand the tree to
1513
# such a level that at most the specified number of entries are visible (unless
1514
# a fully collapsed tree already exceeds this amount). So setting the number of
1515
# entries 1 will produce a full collapsed tree by default. 0 is a special value
1516
# representing an infinite number of entries and will result in a full expanded
1517
# tree by default.
1518
# Minimum value: 0, maximum value: 9999, default value: 100.
1519
# This tag requires that the tag GENERATE_HTML is set to YES.
1520

1521
HTML_INDEX_NUM_ENTRIES = 100
1522

1523
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1524
# generated that can be used as input for Apple's Xcode 3 integrated development
1525
# environment (see:
1526
# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
1527
# create a documentation set, doxygen will generate a Makefile in the HTML
1528
# output directory. Running make will produce the docset in that directory and
1529
# running make install will install the docset in
1530
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1531
# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1532
# genXcode/_index.html for more information.
1533
# The default value is: NO.
1534
# This tag requires that the tag GENERATE_HTML is set to YES.
1535

1536
GENERATE_DOCSET        = NO
1537

1538
# This tag determines the name of the docset feed. A documentation feed provides
1539
# an umbrella under which multiple documentation sets from a single provider
1540
# (such as a company or product suite) can be grouped.
1541
# The default value is: Doxygen generated docs.
1542
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1543

1544
DOCSET_FEEDNAME        = "Doxygen generated docs"
1545

1546
# This tag determines the URL of the docset feed. A documentation feed provides
1547
# an umbrella under which multiple documentation sets from a single provider
1548
# (such as a company or product suite) can be grouped.
1549
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1550

1551
DOCSET_FEEDURL         =
1552

1553
# This tag specifies a string that should uniquely identify the documentation
1554
# set bundle. This should be a reverse domain-name style string, e.g.
1555
# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1556
# The default value is: org.doxygen.Project.
1557
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1558

1559
DOCSET_BUNDLE_ID       = org.doxygen.Project
1560

1561
# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1562
# the documentation publisher. This should be a reverse domain-name style
1563
# string, e.g. com.mycompany.MyDocSet.documentation.
1564
# The default value is: org.doxygen.Publisher.
1565
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1566

1567
DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1568

1569
# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1570
# The default value is: Publisher.
1571
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1572

1573
DOCSET_PUBLISHER_NAME  = Publisher
1574

1575
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1576
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1577
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1578
# on Windows. In the beginning of 2021 Microsoft took the original page, with
1579
# a.o. the download links, offline the HTML help workshop was already many years
1580
# in maintenance mode). You can download the HTML help workshop from the web
1581
# archives at Installation executable (see:
1582
# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo
1583
# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
1584
#
1585
# The HTML Help Workshop contains a compiler that can convert all HTML output
1586
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1587
# files are now used as the Windows 98 help format, and will replace the old
1588
# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1589
# HTML files also contain an index, a table of contents, and you can search for
1590
# words in the documentation. The HTML workshop also contains a viewer for
1591
# compressed HTML files.
1592
# The default value is: NO.
1593
# This tag requires that the tag GENERATE_HTML is set to YES.
1594

1595
GENERATE_HTMLHELP      = NO
1596

1597
# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1598
# file. You can add a path in front of the file if the result should not be
1599
# written to the html output directory.
1600
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1601

1602
CHM_FILE               =
1603

1604
# The HHC_LOCATION tag can be used to specify the location (absolute path
1605
# including file name) of the HTML help compiler (hhc.exe). If non-empty,
1606
# doxygen will try to run the HTML help compiler on the generated index.hhp.
1607
# The file has to be specified with full path.
1608
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1609

1610
HHC_LOCATION           =
1611

1612
# The GENERATE_CHI flag controls if a separate .chi index file is generated
1613
# (YES) or that it should be included in the main .chm file (NO).
1614
# The default value is: NO.
1615
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1616

1617
GENERATE_CHI           = NO
1618

1619
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1620
# and project file content.
1621
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1622

1623
CHM_INDEX_ENCODING     =
1624

1625
# The BINARY_TOC flag controls whether a binary table of contents is generated
1626
# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1627
# enables the Previous and Next buttons.
1628
# The default value is: NO.
1629
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1630

1631
BINARY_TOC             = NO
1632

1633
# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1634
# the table of contents of the HTML help documentation and to the tree view.
1635
# The default value is: NO.
1636
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1637

1638
TOC_EXPAND             = NO
1639

1640
# The SITEMAP_URL tag is used to specify the full URL of the place where the
1641
# generated documentation will be placed on the server by the user during the
1642
# deployment of the documentation. The generated sitemap is called sitemap.xml
1643
# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL
1644
# is specified no sitemap is generated. For information about the sitemap
1645
# protocol see https://www.sitemaps.org
1646
# This tag requires that the tag GENERATE_HTML is set to YES.
1647

1648
SITEMAP_URL            =
1649

1650
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1651
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1652
# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1653
# (.qch) of the generated HTML documentation.
1654
# The default value is: NO.
1655
# This tag requires that the tag GENERATE_HTML is set to YES.
1656

1657
GENERATE_QHP           = NO
1658

1659
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1660
# the file name of the resulting .qch file. The path specified is relative to
1661
# the HTML output folder.
1662
# This tag requires that the tag GENERATE_QHP is set to YES.
1663

1664
QCH_FILE               =
1665

1666
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1667
# Project output. For more information please see Qt Help Project / Namespace
1668
# (see:
1669
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1670
# The default value is: org.doxygen.Project.
1671
# This tag requires that the tag GENERATE_QHP is set to YES.
1672

1673
QHP_NAMESPACE          = org.doxygen.Project
1674

1675
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1676
# Help Project output. For more information please see Qt Help Project / Virtual
1677
# Folders (see:
1678
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
1679
# The default value is: doc.
1680
# This tag requires that the tag GENERATE_QHP is set to YES.
1681

1682
QHP_VIRTUAL_FOLDER     = doc
1683

1684
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1685
# filter to add. For more information please see Qt Help Project / Custom
1686
# Filters (see:
1687
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1688
# This tag requires that the tag GENERATE_QHP is set to YES.
1689

1690
QHP_CUST_FILTER_NAME   =
1691

1692
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1693
# custom filter to add. For more information please see Qt Help Project / Custom
1694
# Filters (see:
1695
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1696
# This tag requires that the tag GENERATE_QHP is set to YES.
1697

1698
QHP_CUST_FILTER_ATTRS  =
1699

1700
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1701
# project's filter section matches. Qt Help Project / Filter Attributes (see:
1702
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1703
# This tag requires that the tag GENERATE_QHP is set to YES.
1704

1705
QHP_SECT_FILTER_ATTRS  =
1706

1707
# The QHG_LOCATION tag can be used to specify the location (absolute path
1708
# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1709
# run qhelpgenerator on the generated .qhp file.
1710
# This tag requires that the tag GENERATE_QHP is set to YES.
1711

1712
QHG_LOCATION           =
1713

1714
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1715
# generated, together with the HTML files, they form an Eclipse help plugin. To
1716
# install this plugin and make it available under the help contents menu in
1717
# Eclipse, the contents of the directory containing the HTML and XML files needs
1718
# to be copied into the plugins directory of eclipse. The name of the directory
1719
# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1720
# After copying Eclipse needs to be restarted before the help appears.
1721
# The default value is: NO.
1722
# This tag requires that the tag GENERATE_HTML is set to YES.
1723

1724
GENERATE_ECLIPSEHELP   = NO
1725

1726
# A unique identifier for the Eclipse help plugin. When installing the plugin
1727
# the directory name containing the HTML and XML files should also have this
1728
# name. Each documentation set should have its own identifier.
1729
# The default value is: org.doxygen.Project.
1730
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1731

1732
ECLIPSE_DOC_ID         = org.doxygen.Project
1733

1734
# If you want full control over the layout of the generated HTML pages it might
1735
# be necessary to disable the index and replace it with your own. The
1736
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1737
# of each HTML page. A value of NO enables the index and the value YES disables
1738
# it. Since the tabs in the index contain the same information as the navigation
1739
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1740
# The default value is: NO.
1741
# This tag requires that the tag GENERATE_HTML is set to YES.
1742

1743
DISABLE_INDEX          = NO
1744

1745
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1746
# structure should be generated to display hierarchical information. If the tag
1747
# value is set to YES, a side panel will be generated containing a tree-like
1748
# index structure (just like the one that is generated for HTML Help). For this
1749
# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1750
# (i.e. any modern browser). Windows users are probably better off using the
1751
# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1752
# further fine tune the look of the index (see "Fine-tuning the output"). As an
1753
# example, the default style sheet generated by doxygen has an example that
1754
# shows how to put an image at the root of the tree instead of the PROJECT_NAME.
1755
# Since the tree basically has the same information as the tab index, you could
1756
# consider setting DISABLE_INDEX to YES when enabling this option.
1757
# The default value is: NO.
1758
# This tag requires that the tag GENERATE_HTML is set to YES.
1759

1760
GENERATE_TREEVIEW      = YES
1761

1762
# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
1763
# FULL_SIDEBAR option determines if the side bar is limited to only the treeview
1764
# area (value NO) or if it should extend to the full height of the window (value
1765
# YES). Setting this to YES gives a layout similar to
1766
# https://docs.readthedocs.io with more room for contents, but less room for the
1767
# project logo, title, and description. If either GENERATE_TREEVIEW or
1768
# DISABLE_INDEX is set to NO, this option has no effect.
1769
# The default value is: NO.
1770
# This tag requires that the tag GENERATE_HTML is set to YES.
1771

1772
FULL_SIDEBAR           = NO
1773

1774
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1775
# doxygen will group on one line in the generated HTML documentation.
1776
#
1777
# Note that a value of 0 will completely suppress the enum values from appearing
1778
# in the overview section.
1779
# Minimum value: 0, maximum value: 20, default value: 4.
1780
# This tag requires that the tag GENERATE_HTML is set to YES.
1781

1782
ENUM_VALUES_PER_LINE   = 4
1783

1784
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1785
# to set the initial width (in pixels) of the frame in which the tree is shown.
1786
# Minimum value: 0, maximum value: 1500, default value: 250.
1787
# This tag requires that the tag GENERATE_HTML is set to YES.
1788

1789
TREEVIEW_WIDTH         = 250
1790

1791
# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1792
# external symbols imported via tag files in a separate window.
1793
# The default value is: NO.
1794
# This tag requires that the tag GENERATE_HTML is set to YES.
1795

1796
EXT_LINKS_IN_WINDOW    = NO
1797

1798
# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
1799
# addresses.
1800
# The default value is: YES.
1801
# This tag requires that the tag GENERATE_HTML is set to YES.
1802

1803
OBFUSCATE_EMAILS       = YES
1804

1805
# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1806
# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
1807
# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
1808
# the HTML output. These images will generally look nicer at scaled resolutions.
1809
# Possible values are: png (the default) and svg (looks nicer but requires the
1810
# pdf2svg or inkscape tool).
1811
# The default value is: png.
1812
# This tag requires that the tag GENERATE_HTML is set to YES.
1813

1814
HTML_FORMULA_FORMAT    = png
1815

1816
# Use this tag to change the font size of LaTeX formulas included as images in
1817
# the HTML documentation. When you change the font size after a successful
1818
# doxygen run you need to manually remove any form_*.png images from the HTML
1819
# output directory to force them to be regenerated.
1820
# Minimum value: 8, maximum value: 50, default value: 10.
1821
# This tag requires that the tag GENERATE_HTML is set to YES.
1822

1823
FORMULA_FONTSIZE       = 10
1824

1825
# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
1826
# to create new LaTeX commands to be used in formulas as building blocks. See
1827
# the section "Including formulas" for details.
1828

1829
FORMULA_MACROFILE      =
1830

1831
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1832
# https://www.mathjax.org) which uses client side JavaScript for the rendering
1833
# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1834
# installed or if you want to formulas look prettier in the HTML output. When
1835
# enabled you may also need to install MathJax separately and configure the path
1836
# to it using the MATHJAX_RELPATH option.
1837
# The default value is: NO.
1838
# This tag requires that the tag GENERATE_HTML is set to YES.
1839

1840
USE_MATHJAX            = NO
1841

1842
# With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
1843
# Note that the different versions of MathJax have different requirements with
1844
# regards to the different settings, so it is possible that also other MathJax
1845
# settings have to be changed when switching between the different MathJax
1846
# versions.
1847
# Possible values are: MathJax_2 and MathJax_3.
1848
# The default value is: MathJax_2.
1849
# This tag requires that the tag USE_MATHJAX is set to YES.
1850

1851
MATHJAX_VERSION        = MathJax_2
1852

1853
# When MathJax is enabled you can set the default output format to be used for
1854
# the MathJax output. For more details about the output format see MathJax
1855
# version 2 (see:
1856
# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
1857
# (see:
1858
# http://docs.mathjax.org/en/latest/web/components/output.html).
1859
# Possible values are: HTML-CSS (which is slower, but has the best
1860
# compatibility. This is the name for Mathjax version 2, for MathJax version 3
1861
# this will be translated into chtml), NativeMML (i.e. MathML. Only supported
1862
# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
1863
# is the name for Mathjax version 3, for MathJax version 2 this will be
1864
# translated into HTML-CSS) and SVG.
1865
# The default value is: HTML-CSS.
1866
# This tag requires that the tag USE_MATHJAX is set to YES.
1867

1868
MATHJAX_FORMAT         = HTML-CSS
1869

1870
# When MathJax is enabled you need to specify the location relative to the HTML
1871
# output directory using the MATHJAX_RELPATH option. The destination directory
1872
# should contain the MathJax.js script. For instance, if the mathjax directory
1873
# is located at the same level as the HTML output directory, then
1874
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1875
# Content Delivery Network so you can quickly see the result without installing
1876
# MathJax. However, it is strongly recommended to install a local copy of
1877
# MathJax from https://www.mathjax.org before deployment. The default value is:
1878
# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
1879
# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
1880
# This tag requires that the tag USE_MATHJAX is set to YES.
1881

1882
MATHJAX_RELPATH        =
1883

1884
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1885
# extension names that should be enabled during MathJax rendering. For example
1886
# for MathJax version 2 (see
1887
# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
1888
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1889
# For example for MathJax version 3 (see
1890
# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):
1891
# MATHJAX_EXTENSIONS = ams
1892
# This tag requires that the tag USE_MATHJAX is set to YES.
1893

1894
MATHJAX_EXTENSIONS     =
1895

1896
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1897
# of code that will be used on startup of the MathJax code. See the MathJax site
1898
# (see:
1899
# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
1900
# example see the documentation.
1901
# This tag requires that the tag USE_MATHJAX is set to YES.
1902

1903
MATHJAX_CODEFILE       =
1904

1905
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1906
# the HTML output. The underlying search engine uses javascript and DHTML and
1907
# should work on any modern browser. Note that when using HTML help
1908
# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1909
# there is already a search function so this one should typically be disabled.
1910
# For large projects the javascript based search engine can be slow, then
1911
# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1912
# search using the keyboard; to jump to the search box use <access key> + S
1913
# (what the <access key> is depends on the OS and browser, but it is typically
1914
# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1915
# key> to jump into the search results window, the results can be navigated
1916
# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1917
# the search. The filter options can be selected when the cursor is inside the
1918
# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1919
# to select a filter and <Enter> or <escape> to activate or cancel the filter
1920
# option.
1921
# The default value is: YES.
1922
# This tag requires that the tag GENERATE_HTML is set to YES.
1923

1924
SEARCHENGINE           = YES
1925

1926
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1927
# implemented using a web server instead of a web client using JavaScript. There
1928
# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1929
# setting. When disabled, doxygen will generate a PHP script for searching and
1930
# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1931
# and searching needs to be provided by external tools. See the section
1932
# "External Indexing and Searching" for details.
1933
# The default value is: NO.
1934
# This tag requires that the tag SEARCHENGINE is set to YES.
1935

1936
SERVER_BASED_SEARCH    = NO
1937

1938
# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1939
# script for searching. Instead the search results are written to an XML file
1940
# which needs to be processed by an external indexer. Doxygen will invoke an
1941
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1942
# search results.
1943
#
1944
# Doxygen ships with an example indexer (doxyindexer) and search engine
1945
# (doxysearch.cgi) which are based on the open source search engine library
1946
# Xapian (see:
1947
# https://xapian.org/).
1948
#
1949
# See the section "External Indexing and Searching" for details.
1950
# The default value is: NO.
1951
# This tag requires that the tag SEARCHENGINE is set to YES.
1952

1953
EXTERNAL_SEARCH        = NO
1954

1955
# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1956
# which will return the search results when EXTERNAL_SEARCH is enabled.
1957
#
1958
# Doxygen ships with an example indexer (doxyindexer) and search engine
1959
# (doxysearch.cgi) which are based on the open source search engine library
1960
# Xapian (see:
1961
# https://xapian.org/). See the section "External Indexing and Searching" for
1962
# details.
1963
# This tag requires that the tag SEARCHENGINE is set to YES.
1964

1965
SEARCHENGINE_URL       =
1966

1967
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1968
# search data is written to a file for indexing by an external tool. With the
1969
# SEARCHDATA_FILE tag the name of this file can be specified.
1970
# The default file is: searchdata.xml.
1971
# This tag requires that the tag SEARCHENGINE is set to YES.
1972

1973
SEARCHDATA_FILE        = searchdata.xml
1974

1975
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1976
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1977
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1978
# projects and redirect the results back to the right project.
1979
# This tag requires that the tag SEARCHENGINE is set to YES.
1980

1981
EXTERNAL_SEARCH_ID     =
1982

1983
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1984
# projects other than the one defined by this configuration file, but that are
1985
# all added to the same external search index. Each project needs to have a
1986
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1987
# to a relative location where the documentation can be found. The format is:
1988
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1989
# This tag requires that the tag SEARCHENGINE is set to YES.
1990

1991
EXTRA_SEARCH_MAPPINGS  =
1992

1993
#---------------------------------------------------------------------------
1994
# Configuration options related to the LaTeX output
1995
#---------------------------------------------------------------------------
1996

1997
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1998
# The default value is: YES.
1999

2000
GENERATE_LATEX         = NO
2001

2002
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
2003
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2004
# it.
2005
# The default directory is: latex.
2006
# This tag requires that the tag GENERATE_LATEX is set to YES.
2007

2008
LATEX_OUTPUT           = latex
2009

2010
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
2011
# invoked.
2012
#
2013
# Note that when not enabling USE_PDFLATEX the default is latex when enabling
2014
# USE_PDFLATEX the default is pdflatex and when in the later case latex is
2015
# chosen this is overwritten by pdflatex. For specific output languages the
2016
# default can have been set differently, this depends on the implementation of
2017
# the output language.
2018
# This tag requires that the tag GENERATE_LATEX is set to YES.
2019

2020
LATEX_CMD_NAME         =
2021

2022
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
2023
# index for LaTeX.
2024
# Note: This tag is used in the Makefile / make.bat.
2025
# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
2026
# (.tex).
2027
# The default file is: makeindex.
2028
# This tag requires that the tag GENERATE_LATEX is set to YES.
2029

2030
MAKEINDEX_CMD_NAME     = makeindex
2031

2032
# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
2033
# generate index for LaTeX. In case there is no backslash (\) as first character
2034
# it will be automatically added in the LaTeX code.
2035
# Note: This tag is used in the generated output file (.tex).
2036
# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
2037
# The default value is: makeindex.
2038
# This tag requires that the tag GENERATE_LATEX is set to YES.
2039

2040
LATEX_MAKEINDEX_CMD    = makeindex
2041

2042
# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
2043
# documents. This may be useful for small projects and may help to save some
2044
# trees in general.
2045
# The default value is: NO.
2046
# This tag requires that the tag GENERATE_LATEX is set to YES.
2047

2048
COMPACT_LATEX          = NO
2049

2050
# The PAPER_TYPE tag can be used to set the paper type that is used by the
2051
# printer.
2052
# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
2053
# 14 inches) and executive (7.25 x 10.5 inches).
2054
# The default value is: a4.
2055
# This tag requires that the tag GENERATE_LATEX is set to YES.
2056

2057
PAPER_TYPE             = a4
2058

2059
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
2060
# that should be included in the LaTeX output. The package can be specified just
2061
# by its name or with the correct syntax as to be used with the LaTeX
2062
# \usepackage command. To get the times font for instance you can specify :
2063
# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
2064
# To use the option intlimits with the amsmath package you can specify:
2065
# EXTRA_PACKAGES=[intlimits]{amsmath}
2066
# If left blank no extra packages will be included.
2067
# This tag requires that the tag GENERATE_LATEX is set to YES.
2068

2069
EXTRA_PACKAGES         =
2070

2071
# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
2072
# the generated LaTeX document. The header should contain everything until the
2073
# first chapter. If it is left blank doxygen will generate a standard header. It
2074
# is highly recommended to start with a default header using
2075
# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
2076
# and then modify the file new_header.tex. See also section "Doxygen usage" for
2077
# information on how to generate the default header that doxygen normally uses.
2078
#
2079
# Note: Only use a user-defined header if you know what you are doing!
2080
# Note: The header is subject to change so you typically have to regenerate the
2081
# default header when upgrading to a newer version of doxygen. The following
2082
# commands have a special meaning inside the header (and footer): For a
2083
# description of the possible markers and block names see the documentation.
2084
# This tag requires that the tag GENERATE_LATEX is set to YES.
2085

2086
LATEX_HEADER           =
2087

2088
# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
2089
# the generated LaTeX document. The footer should contain everything after the
2090
# last chapter. If it is left blank doxygen will generate a standard footer. See
2091
# LATEX_HEADER for more information on how to generate a default footer and what
2092
# special commands can be used inside the footer. See also section "Doxygen
2093
# usage" for information on how to generate the default footer that doxygen
2094
# normally uses. Note: Only use a user-defined footer if you know what you are
2095
# doing!
2096
# This tag requires that the tag GENERATE_LATEX is set to YES.
2097

2098
LATEX_FOOTER           =
2099

2100
# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
2101
# LaTeX style sheets that are included after the standard style sheets created
2102
# by doxygen. Using this option one can overrule certain style aspects. Doxygen
2103
# will copy the style sheet files to the output directory.
2104
# Note: The order of the extra style sheet files is of importance (e.g. the last
2105
# style sheet in the list overrules the setting of the previous ones in the
2106
# list).
2107
# This tag requires that the tag GENERATE_LATEX is set to YES.
2108

2109
LATEX_EXTRA_STYLESHEET =
2110

2111
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
2112
# other source files which should be copied to the LATEX_OUTPUT output
2113
# directory. Note that the files will be copied as-is; there are no commands or
2114
# markers available.
2115
# This tag requires that the tag GENERATE_LATEX is set to YES.
2116

2117
LATEX_EXTRA_FILES      =
2118

2119
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
2120
# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
2121
# contain links (just like the HTML output) instead of page references. This
2122
# makes the output suitable for online browsing using a PDF viewer.
2123
# The default value is: YES.
2124
# This tag requires that the tag GENERATE_LATEX is set to YES.
2125

2126
PDF_HYPERLINKS         = YES
2127

2128
# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
2129
# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
2130
# files. Set this option to YES, to get a higher quality PDF documentation.
2131
#
2132
# See also section LATEX_CMD_NAME for selecting the engine.
2133
# The default value is: YES.
2134
# This tag requires that the tag GENERATE_LATEX is set to YES.
2135

2136
USE_PDFLATEX           = YES
2137

2138
# The LATEX_BATCHMODE tag signals the behavior of LaTeX in case of an error.
2139
# Possible values are: NO same as ERROR_STOP, YES same as BATCH, BATCH In batch
2140
# mode nothing is printed on the terminal, errors are scrolled as if <return> is
2141
# hit at every error; missing files that TeX tries to input or request from
2142
# keyboard input (\read on a not open input stream) cause the job to abort,
2143
# NON_STOP In nonstop mode the diagnostic message will appear on the terminal,
2144
# but there is no possibility of user interaction just like in batch mode,
2145
# SCROLL In scroll mode, TeX will stop only for missing files to input or if
2146
# keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at
2147
# each error, asking for user intervention.
2148
# The default value is: NO.
2149
# This tag requires that the tag GENERATE_LATEX is set to YES.
2150

2151
LATEX_BATCHMODE        = NO
2152

2153
# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
2154
# index chapters (such as File Index, Compound Index, etc.) in the output.
2155
# The default value is: NO.
2156
# This tag requires that the tag GENERATE_LATEX is set to YES.
2157

2158
LATEX_HIDE_INDICES     = NO
2159

2160
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
2161
# bibliography, e.g. plainnat, or ieeetr. See
2162
# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
2163
# The default value is: plain.
2164
# This tag requires that the tag GENERATE_LATEX is set to YES.
2165

2166
LATEX_BIB_STYLE        = plain
2167

2168
# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
2169
# path from which the emoji images will be read. If a relative path is entered,
2170
# it will be relative to the LATEX_OUTPUT directory. If left blank the
2171
# LATEX_OUTPUT directory will be used.
2172
# This tag requires that the tag GENERATE_LATEX is set to YES.
2173

2174
LATEX_EMOJI_DIRECTORY  =
2175

2176
#---------------------------------------------------------------------------
2177
# Configuration options related to the RTF output
2178
#---------------------------------------------------------------------------
2179

2180
# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
2181
# RTF output is optimized for Word 97 and may not look too pretty with other RTF
2182
# readers/editors.
2183
# The default value is: NO.
2184

2185
GENERATE_RTF           = NO
2186

2187
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2188
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2189
# it.
2190
# The default directory is: rtf.
2191
# This tag requires that the tag GENERATE_RTF is set to YES.
2192

2193
RTF_OUTPUT             = rtf
2194

2195
# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
2196
# documents. This may be useful for small projects and may help to save some
2197
# trees in general.
2198
# The default value is: NO.
2199
# This tag requires that the tag GENERATE_RTF is set to YES.
2200

2201
COMPACT_RTF            = NO
2202

2203
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
2204
# contain hyperlink fields. The RTF file will contain links (just like the HTML
2205
# output) instead of page references. This makes the output suitable for online
2206
# browsing using Word or some other Word compatible readers that support those
2207
# fields.
2208
#
2209
# Note: WordPad (write) and others do not support links.
2210
# The default value is: NO.
2211
# This tag requires that the tag GENERATE_RTF is set to YES.
2212

2213
RTF_HYPERLINKS         = NO
2214

2215
# Load stylesheet definitions from file. Syntax is similar to doxygen's
2216
# configuration file, i.e. a series of assignments. You only have to provide
2217
# replacements, missing definitions are set to their default value.
2218
#
2219
# See also section "Doxygen usage" for information on how to generate the
2220
# default style sheet that doxygen normally uses.
2221
# This tag requires that the tag GENERATE_RTF is set to YES.
2222

2223
RTF_STYLESHEET_FILE    =
2224

2225
# Set optional variables used in the generation of an RTF document. Syntax is
2226
# similar to doxygen's configuration file. A template extensions file can be
2227
# generated using doxygen -e rtf extensionFile.
2228
# This tag requires that the tag GENERATE_RTF is set to YES.
2229

2230
RTF_EXTENSIONS_FILE    =
2231

2232
#---------------------------------------------------------------------------
2233
# Configuration options related to the man page output
2234
#---------------------------------------------------------------------------
2235

2236
# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2237
# classes and files.
2238
# The default value is: NO.
2239

2240
GENERATE_MAN           = NO
2241

2242
# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2243
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2244
# it. A directory man3 will be created inside the directory specified by
2245
# MAN_OUTPUT.
2246
# The default directory is: man.
2247
# This tag requires that the tag GENERATE_MAN is set to YES.
2248

2249
MAN_OUTPUT             = man
2250

2251
# The MAN_EXTENSION tag determines the extension that is added to the generated
2252
# man pages. In case the manual section does not start with a number, the number
2253
# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2254
# optional.
2255
# The default value is: .3.
2256
# This tag requires that the tag GENERATE_MAN is set to YES.
2257

2258
MAN_EXTENSION          = .3
2259

2260
# The MAN_SUBDIR tag determines the name of the directory created within
2261
# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2262
# MAN_EXTENSION with the initial . removed.
2263
# This tag requires that the tag GENERATE_MAN is set to YES.
2264

2265
MAN_SUBDIR             =
2266

2267
# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2268
# will generate one additional man file for each entity documented in the real
2269
# man page(s). These additional files only source the real man page, but without
2270
# them the man command would be unable to find the correct page.
2271
# The default value is: NO.
2272
# This tag requires that the tag GENERATE_MAN is set to YES.
2273

2274
MAN_LINKS              = NO
2275

2276
#---------------------------------------------------------------------------
2277
# Configuration options related to the XML output
2278
#---------------------------------------------------------------------------
2279

2280
# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2281
# captures the structure of the code including all documentation.
2282
# The default value is: NO.
2283

2284
GENERATE_XML           = NO
2285

2286
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2287
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2288
# it.
2289
# The default directory is: xml.
2290
# This tag requires that the tag GENERATE_XML is set to YES.
2291

2292
XML_OUTPUT             = xml
2293

2294
# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2295
# listings (including syntax highlighting and cross-referencing information) to
2296
# the XML output. Note that enabling this will significantly increase the size
2297
# of the XML output.
2298
# The default value is: YES.
2299
# This tag requires that the tag GENERATE_XML is set to YES.
2300

2301
XML_PROGRAMLISTING     = YES
2302

2303
# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2304
# namespace members in file scope as well, matching the HTML output.
2305
# The default value is: NO.
2306
# This tag requires that the tag GENERATE_XML is set to YES.
2307

2308
XML_NS_MEMB_FILE_SCOPE = NO
2309

2310
#---------------------------------------------------------------------------
2311
# Configuration options related to the DOCBOOK output
2312
#---------------------------------------------------------------------------
2313

2314
# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2315
# that can be used to generate PDF.
2316
# The default value is: NO.
2317

2318
GENERATE_DOCBOOK       = NO
2319

2320
# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2321
# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2322
# front of it.
2323
# The default directory is: docbook.
2324
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2325

2326
DOCBOOK_OUTPUT         = docbook
2327

2328
#---------------------------------------------------------------------------
2329
# Configuration options for the AutoGen Definitions output
2330
#---------------------------------------------------------------------------
2331

2332
# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2333
# AutoGen Definitions (see https://autogen.sourceforge.net/) file that captures
2334
# the structure of the code including all documentation. Note that this feature
2335
# is still experimental and incomplete at the moment.
2336
# The default value is: NO.
2337

2338
GENERATE_AUTOGEN_DEF   = NO
2339

2340
#---------------------------------------------------------------------------
2341
# Configuration options related to Sqlite3 output
2342
#---------------------------------------------------------------------------
2343

2344
# If the GENERATE_SQLITE3 tag is set to YES doxygen will generate a Sqlite3
2345
# database with symbols found by doxygen stored in tables.
2346
# The default value is: NO.
2347

2348
GENERATE_SQLITE3       = NO
2349

2350
# The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database will be
2351
# put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put
2352
# in front of it.
2353
# The default directory is: sqlite3.
2354
# This tag requires that the tag GENERATE_SQLITE3 is set to YES.
2355

2356
SQLITE3_OUTPUT         = sqlite3
2357

2358
# The SQLITE3_RECREATE_DB tag is set to YES, the existing doxygen_sqlite3.db
2359
# database file will be recreated with each doxygen run. If set to NO, doxygen
2360
# will warn if a database file is already found and not modify it.
2361
# The default value is: YES.
2362
# This tag requires that the tag GENERATE_SQLITE3 is set to YES.
2363

2364
SQLITE3_RECREATE_DB    = YES
2365

2366
#---------------------------------------------------------------------------
2367
# Configuration options related to the Perl module output
2368
#---------------------------------------------------------------------------
2369

2370
# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2371
# file that captures the structure of the code including all documentation.
2372
#
2373
# Note that this feature is still experimental and incomplete at the moment.
2374
# The default value is: NO.
2375

2376
GENERATE_PERLMOD       = NO
2377

2378
# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2379
# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2380
# output from the Perl module output.
2381
# The default value is: NO.
2382
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2383

2384
PERLMOD_LATEX          = NO
2385

2386
# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2387
# formatted so it can be parsed by a human reader. This is useful if you want to
2388
# understand what is going on. On the other hand, if this tag is set to NO, the
2389
# size of the Perl module output will be much smaller and Perl will parse it
2390
# just the same.
2391
# The default value is: YES.
2392
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2393

2394
PERLMOD_PRETTY         = YES
2395

2396
# The names of the make variables in the generated doxyrules.make file are
2397
# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2398
# so different doxyrules.make files included by the same Makefile don't
2399
# overwrite each other's variables.
2400
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2401

2402
PERLMOD_MAKEVAR_PREFIX =
2403

2404
#---------------------------------------------------------------------------
2405
# Configuration options related to the preprocessor
2406
#---------------------------------------------------------------------------
2407

2408
# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2409
# C-preprocessor directives found in the sources and include files.
2410
# The default value is: YES.
2411

2412
ENABLE_PREPROCESSING   = YES
2413

2414
# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2415
# in the source code. If set to NO, only conditional compilation will be
2416
# performed. Macro expansion can be done in a controlled way by setting
2417
# EXPAND_ONLY_PREDEF to YES.
2418
# The default value is: NO.
2419
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2420

2421
MACRO_EXPANSION        = NO
2422

2423
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2424
# the macro expansion is limited to the macros specified with the PREDEFINED and
2425
# EXPAND_AS_DEFINED tags.
2426
# The default value is: NO.
2427
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2428

2429
EXPAND_ONLY_PREDEF     = NO
2430

2431
# If the SEARCH_INCLUDES tag is set to YES, the include files in the
2432
# INCLUDE_PATH will be searched if a #include is found.
2433
# The default value is: YES.
2434
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2435

2436
SEARCH_INCLUDES        = YES
2437

2438
# The INCLUDE_PATH tag can be used to specify one or more directories that
2439
# contain include files that are not input files but should be processed by the
2440
# preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of
2441
# RECURSIVE has no effect here.
2442
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2443

2444
INCLUDE_PATH           =
2445

2446
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2447
# patterns (like *.h and *.hpp) to filter out the header-files in the
2448
# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2449
# used.
2450
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2451

2452
INCLUDE_FILE_PATTERNS  =
2453

2454
# The PREDEFINED tag can be used to specify one or more macro names that are
2455
# defined before the preprocessor is started (similar to the -D option of e.g.
2456
# gcc). The argument of the tag is a list of macros of the form: name or
2457
# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2458
# is assumed. To prevent a macro definition from being undefined via #undef or
2459
# recursively expanded use the := operator instead of the = operator.
2460
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2461

2462
PREDEFINED             =
2463

2464
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2465
# tag can be used to specify a list of macro names that should be expanded. The
2466
# macro definition that is found in the sources will be used. Use the PREDEFINED
2467
# tag if you want to use a different macro definition that overrules the
2468
# definition found in the source code.
2469
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2470

2471
EXPAND_AS_DEFINED      =
2472

2473
# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2474
# remove all references to function-like macros that are alone on a line, have
2475
# an all uppercase name, and do not end with a semicolon. Such function macros
2476
# are typically used for boiler-plate code, and will confuse the parser if not
2477
# removed.
2478
# The default value is: YES.
2479
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2480

2481
SKIP_FUNCTION_MACROS   = YES
2482

2483
#---------------------------------------------------------------------------
2484
# Configuration options related to external references
2485
#---------------------------------------------------------------------------
2486

2487
# The TAGFILES tag can be used to specify one or more tag files. For each tag
2488
# file the location of the external documentation should be added. The format of
2489
# a tag file without this location is as follows:
2490
# TAGFILES = file1 file2 ...
2491
# Adding location for the tag files is done as follows:
2492
# TAGFILES = file1=loc1 "file2 = loc2" ...
2493
# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2494
# section "Linking to external documentation" for more information about the use
2495
# of tag files.
2496
# Note: Each tag file must have a unique name (where the name does NOT include
2497
# the path). If a tag file is not located in the directory in which doxygen is
2498
# run, you must also specify the path to the tagfile here.
2499

2500
TAGFILES               =
2501

2502
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2503
# tag file that is based on the input files it reads. See section "Linking to
2504
# external documentation" for more information about the usage of tag files.
2505

2506
GENERATE_TAGFILE       =
2507

2508
# If the ALLEXTERNALS tag is set to YES, all external classes and namespaces
2509
# will be listed in the class and namespace index. If set to NO, only the
2510
# inherited external classes will be listed.
2511
# The default value is: NO.
2512

2513
ALLEXTERNALS           = NO
2514

2515
# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2516
# in the topic index. If set to NO, only the current project's groups will be
2517
# listed.
2518
# The default value is: YES.
2519

2520
EXTERNAL_GROUPS        = YES
2521

2522
# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2523
# the related pages index. If set to NO, only the current project's pages will
2524
# be listed.
2525
# The default value is: YES.
2526

2527
EXTERNAL_PAGES         = YES
2528

2529
#---------------------------------------------------------------------------
2530
# Configuration options related to diagram generator tools
2531
#---------------------------------------------------------------------------
2532

2533
# If set to YES the inheritance and collaboration graphs will hide inheritance
2534
# and usage relations if the target is undocumented or is not a class.
2535
# The default value is: YES.
2536

2537
HIDE_UNDOC_RELATIONS   = YES
2538

2539
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2540
# available from the path. This tool is part of Graphviz (see:
2541
# https://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2542
# Bell Labs. The other options in this section have no effect if this option is
2543
# set to NO
2544
# The default value is: NO.
2545

2546
HAVE_DOT               = NO
2547

2548
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2549
# to run in parallel. When set to 0 doxygen will base this on the number of
2550
# processors available in the system. You can set it explicitly to a value
2551
# larger than 0 to get control over the balance between CPU load and processing
2552
# speed.
2553
# Minimum value: 0, maximum value: 32, default value: 0.
2554
# This tag requires that the tag HAVE_DOT is set to YES.
2555

2556
DOT_NUM_THREADS        = 0
2557

2558
# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of
2559
# subgraphs. When you want a differently looking font in the dot files that
2560
# doxygen generates you can specify fontname, fontcolor and fontsize attributes.
2561
# For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node,
2562
# Edge and Graph Attributes specification</a> You need to make sure dot is able
2563
# to find the font, which can be done by putting it in a standard location or by
2564
# setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
2565
# directory containing the font. Default graphviz fontsize is 14.
2566
# The default value is: fontname=Helvetica,fontsize=10.
2567
# This tag requires that the tag HAVE_DOT is set to YES.
2568

2569
DOT_COMMON_ATTR        = "fontname=Helvetica,fontsize=10"
2570

2571
# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can
2572
# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a
2573
# href=https://graphviz.org/doc/info/arrows.html>Complete documentation about
2574
# arrows shapes.</a>
2575
# The default value is: labelfontname=Helvetica,labelfontsize=10.
2576
# This tag requires that the tag HAVE_DOT is set to YES.
2577

2578
DOT_EDGE_ATTR          = "labelfontname=Helvetica,labelfontsize=10"
2579

2580
# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes
2581
# around nodes set 'shape=plain' or 'shape=plaintext' <a
2582
# href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a>
2583
# The default value is: shape=box,height=0.2,width=0.4.
2584
# This tag requires that the tag HAVE_DOT is set to YES.
2585

2586
DOT_NODE_ATTR          = "shape=box,height=0.2,width=0.4"
2587

2588
# You can set the path where dot can find font specified with fontname in
2589
# DOT_COMMON_ATTR and others dot attributes.
2590
# This tag requires that the tag HAVE_DOT is set to YES.
2591

2592
DOT_FONTPATH           =
2593

2594
# If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then doxygen will
2595
# generate a graph for each documented class showing the direct and indirect
2596
# inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and
2597
# HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case
2598
# the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the
2599
# CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used.
2600
# If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance
2601
# relations will be shown as texts / links. Explicit enabling an inheritance
2602
# graph or choosing a different representation for an inheritance graph of a
2603
# specific class, can be accomplished by means of the command \inheritancegraph.
2604
# Disabling an inheritance graph can be accomplished by means of the command
2605
# \hideinheritancegraph.
2606
# Possible values are: NO, YES, TEXT, GRAPH and BUILTIN.
2607
# The default value is: YES.
2608

2609
CLASS_GRAPH            = YES
2610

2611
# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2612
# graph for each documented class showing the direct and indirect implementation
2613
# dependencies (inheritance, containment, and class references variables) of the
2614
# class with other documented classes. Explicit enabling a collaboration graph,
2615
# when COLLABORATION_GRAPH is set to NO, can be accomplished by means of the
2616
# command \collaborationgraph. Disabling a collaboration graph can be
2617
# accomplished by means of the command \hidecollaborationgraph.
2618
# The default value is: YES.
2619
# This tag requires that the tag HAVE_DOT is set to YES.
2620

2621
COLLABORATION_GRAPH    = YES
2622

2623
# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2624
# groups, showing the direct groups dependencies. Explicit enabling a group
2625
# dependency graph, when GROUP_GRAPHS is set to NO, can be accomplished by means
2626
# of the command \groupgraph. Disabling a directory graph can be accomplished by
2627
# means of the command \hidegroupgraph. See also the chapter Grouping in the
2628
# manual.
2629
# The default value is: YES.
2630
# This tag requires that the tag HAVE_DOT is set to YES.
2631

2632
GROUP_GRAPHS           = YES
2633

2634
# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2635
# collaboration diagrams in a style similar to the OMG's Unified Modeling
2636
# Language.
2637
# The default value is: NO.
2638
# This tag requires that the tag HAVE_DOT is set to YES.
2639

2640
UML_LOOK               = NO
2641

2642
# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2643
# class node. If there are many fields or methods and many nodes the graph may
2644
# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2645
# number of items for each type to make the size more manageable. Set this to 0
2646
# for no limit. Note that the threshold may be exceeded by 50% before the limit
2647
# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2648
# but if the number exceeds 15, the total amount of fields shown is limited to
2649
# 10.
2650
# Minimum value: 0, maximum value: 100, default value: 10.
2651
# This tag requires that the tag UML_LOOK is set to YES.
2652

2653
UML_LIMIT_NUM_FIELDS   = 10
2654

2655
# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2656
# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
2657
# tag is set to YES, doxygen will add type and arguments for attributes and
2658
# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
2659
# will not generate fields with class member information in the UML graphs. The
2660
# class diagrams will look similar to the default class diagrams but using UML
2661
# notation for the relationships.
2662
# Possible values are: NO, YES and NONE.
2663
# The default value is: NO.
2664
# This tag requires that the tag UML_LOOK is set to YES.
2665

2666
DOT_UML_DETAILS        = NO
2667

2668
# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
2669
# to display on a single line. If the actual line length exceeds this threshold
2670
# significantly it will be wrapped across multiple lines. Some heuristics are
2671
# applied to avoid ugly line breaks.
2672
# Minimum value: 0, maximum value: 1000, default value: 17.
2673
# This tag requires that the tag HAVE_DOT is set to YES.
2674

2675
DOT_WRAP_THRESHOLD     = 17
2676

2677
# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2678
# collaboration graphs will show the relations between templates and their
2679
# instances.
2680
# The default value is: NO.
2681
# This tag requires that the tag HAVE_DOT is set to YES.
2682

2683
TEMPLATE_RELATIONS     = NO
2684

2685
# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2686
# YES then doxygen will generate a graph for each documented file showing the
2687
# direct and indirect include dependencies of the file with other documented
2688
# files. Explicit enabling an include graph, when INCLUDE_GRAPH is is set to NO,
2689
# can be accomplished by means of the command \includegraph. Disabling an
2690
# include graph can be accomplished by means of the command \hideincludegraph.
2691
# The default value is: YES.
2692
# This tag requires that the tag HAVE_DOT is set to YES.
2693

2694
INCLUDE_GRAPH          = YES
2695

2696
# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2697
# set to YES then doxygen will generate a graph for each documented file showing
2698
# the direct and indirect include dependencies of the file with other documented
2699
# files. Explicit enabling an included by graph, when INCLUDED_BY_GRAPH is set
2700
# to NO, can be accomplished by means of the command \includedbygraph. Disabling
2701
# an included by graph can be accomplished by means of the command
2702
# \hideincludedbygraph.
2703
# The default value is: YES.
2704
# This tag requires that the tag HAVE_DOT is set to YES.
2705

2706
INCLUDED_BY_GRAPH      = YES
2707

2708
# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2709
# dependency graph for every global function or class method.
2710
#
2711
# Note that enabling this option will significantly increase the time of a run.
2712
# So in most cases it will be better to enable call graphs for selected
2713
# functions only using the \callgraph command. Disabling a call graph can be
2714
# accomplished by means of the command \hidecallgraph.
2715
# The default value is: NO.
2716
# This tag requires that the tag HAVE_DOT is set to YES.
2717

2718
CALL_GRAPH             = NO
2719

2720
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2721
# dependency graph for every global function or class method.
2722
#
2723
# Note that enabling this option will significantly increase the time of a run.
2724
# So in most cases it will be better to enable caller graphs for selected
2725
# functions only using the \callergraph command. Disabling a caller graph can be
2726
# accomplished by means of the command \hidecallergraph.
2727
# The default value is: NO.
2728
# This tag requires that the tag HAVE_DOT is set to YES.
2729

2730
CALLER_GRAPH           = NO
2731

2732
# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2733
# hierarchy of all classes instead of a textual one.
2734
# The default value is: YES.
2735
# This tag requires that the tag HAVE_DOT is set to YES.
2736

2737
GRAPHICAL_HIERARCHY    = YES
2738

2739
# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2740
# dependencies a directory has on other directories in a graphical way. The
2741
# dependency relations are determined by the #include relations between the
2742
# files in the directories. Explicit enabling a directory graph, when
2743
# DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command
2744
# \directorygraph. Disabling a directory graph can be accomplished by means of
2745
# the command \hidedirectorygraph.
2746
# The default value is: YES.
2747
# This tag requires that the tag HAVE_DOT is set to YES.
2748

2749
DIRECTORY_GRAPH        = YES
2750

2751
# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels
2752
# of child directories generated in directory dependency graphs by dot.
2753
# Minimum value: 1, maximum value: 25, default value: 1.
2754
# This tag requires that the tag DIRECTORY_GRAPH is set to YES.
2755

2756
DIR_GRAPH_MAX_DEPTH    = 1
2757

2758
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2759
# generated by dot. For an explanation of the image formats see the section
2760
# output formats in the documentation of the dot tool (Graphviz (see:
2761
# https://www.graphviz.org/)).
2762
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2763
# to make the SVG files visible in IE 9+ (other browsers do not have this
2764
# requirement).
2765
# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
2766
# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2767
# png:gdiplus:gdiplus.
2768
# The default value is: png.
2769
# This tag requires that the tag HAVE_DOT is set to YES.
2770

2771
DOT_IMAGE_FORMAT       = png
2772

2773
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2774
# enable generation of interactive SVG images that allow zooming and panning.
2775
#
2776
# Note that this requires a modern browser other than Internet Explorer. Tested
2777
# and working are Firefox, Chrome, Safari, and Opera.
2778
# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2779
# the SVG files visible. Older versions of IE do not have SVG support.
2780
# The default value is: NO.
2781
# This tag requires that the tag HAVE_DOT is set to YES.
2782

2783
INTERACTIVE_SVG        = NO
2784

2785
# The DOT_PATH tag can be used to specify the path where the dot tool can be
2786
# found. If left blank, it is assumed the dot tool can be found in the path.
2787
# This tag requires that the tag HAVE_DOT is set to YES.
2788

2789
DOT_PATH               =
2790

2791
# The DOTFILE_DIRS tag can be used to specify one or more directories that
2792
# contain dot files that are included in the documentation (see the \dotfile
2793
# command).
2794
# This tag requires that the tag HAVE_DOT is set to YES.
2795

2796
DOTFILE_DIRS           =
2797

2798
# You can include diagrams made with dia in doxygen documentation. Doxygen will
2799
# then run dia to produce the diagram and insert it in the documentation. The
2800
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2801
# If left empty dia is assumed to be found in the default search path.
2802

2803
DIA_PATH               =
2804

2805
# The DIAFILE_DIRS tag can be used to specify one or more directories that
2806
# contain dia files that are included in the documentation (see the \diafile
2807
# command).
2808

2809
DIAFILE_DIRS           =
2810

2811
# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2812
# path where java can find the plantuml.jar file or to the filename of jar file
2813
# to be used. If left blank, it is assumed PlantUML is not used or called during
2814
# a preprocessing step. Doxygen will generate a warning when it encounters a
2815
# \startuml command in this case and will not generate output for the diagram.
2816

2817
PLANTUML_JAR_PATH      =
2818

2819
# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2820
# configuration file for plantuml.
2821

2822
PLANTUML_CFG_FILE      =
2823

2824
# When using plantuml, the specified paths are searched for files specified by
2825
# the !include statement in a plantuml block.
2826

2827
PLANTUML_INCLUDE_PATH  =
2828

2829
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2830
# that will be shown in the graph. If the number of nodes in a graph becomes
2831
# larger than this value, doxygen will truncate the graph, which is visualized
2832
# by representing a node as a red box. Note that doxygen if the number of direct
2833
# children of the root node in a graph is already larger than
2834
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2835
# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2836
# Minimum value: 0, maximum value: 10000, default value: 50.
2837
# This tag requires that the tag HAVE_DOT is set to YES.
2838

2839
DOT_GRAPH_MAX_NODES    = 50
2840

2841
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2842
# generated by dot. A depth value of 3 means that only nodes reachable from the
2843
# root by following a path via at most 3 edges will be shown. Nodes that lay
2844
# further from the root node will be omitted. Note that setting this option to 1
2845
# or 2 may greatly reduce the computation time needed for large code bases. Also
2846
# note that the size of a graph can be further restricted by
2847
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2848
# Minimum value: 0, maximum value: 1000, default value: 0.
2849
# This tag requires that the tag HAVE_DOT is set to YES.
2850

2851
MAX_DOT_GRAPH_DEPTH    = 0
2852

2853
# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2854
# files in one run (i.e. multiple -o and -T options on the command line). This
2855
# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2856
# this, this feature is disabled by default.
2857
# The default value is: NO.
2858
# This tag requires that the tag HAVE_DOT is set to YES.
2859

2860
DOT_MULTI_TARGETS      = NO
2861

2862
# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2863
# explaining the meaning of the various boxes and arrows in the dot generated
2864
# graphs.
2865
# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal
2866
# graphical representation for inheritance and collaboration diagrams is used.
2867
# The default value is: YES.
2868
# This tag requires that the tag HAVE_DOT is set to YES.
2869

2870
GENERATE_LEGEND        = YES
2871

2872
# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
2873
# files that are used to generate the various graphs.
2874
#
2875
# Note: This setting is not only used for dot files but also for msc temporary
2876
# files.
2877
# The default value is: YES.
2878

2879
DOT_CLEANUP            = YES
2880

2881
# You can define message sequence charts within doxygen comments using the \msc
2882
# command. If the MSCGEN_TOOL tag is left empty (the default), then doxygen will
2883
# use a built-in version of mscgen tool to produce the charts. Alternatively,
2884
# the MSCGEN_TOOL tag can also specify the name an external tool. For instance,
2885
# specifying prog as the value, doxygen will call the tool as prog -T
2886
# <outfile_format> -o <outputfile> <inputfile>. The external tool should support
2887
# output file formats "png", "eps", "svg", and "ismap".
2888

2889
MSCGEN_TOOL            =
2890

2891
# The MSCFILE_DIRS tag can be used to specify one or more directories that
2892
# contain msc files that are included in the documentation (see the \mscfile
2893
# command).
2894

2895
MSCFILE_DIRS           =
2896
RoomClimatic

Использование cookies
